Create new beneficiary | Manis Technology

This API is used to create a new beneficiary for a specific Payment Service Provider (PSP). The request body contains personal or company information depending on the type.

Request Body:

Field	Type	Required	Description
`pspId`	string	No	Identifier of the Payment Service Provider (e.g., `finmo`).
`customerId`	string	Yes	customer id
`type`	string	Yes	Beneficiary type: `INDIVIDUAL` or `COMPANY`.
`beneficiaryName`	string	Yes	A custom internal name for the beneficiary. Must be unique.
`companyInfo`	object	Required if type = COMPANY	Information about the company beneficiary.
└─ `name`	string	Yes	Company name.
└─ `registrationNumber`	string	Yes	Company registration number.
└─ `incorporationCountry`	string	No	Country where the company was incorporated.
└─ `email`	string	No	Email address of the beneficiary company.
└─ `phoneCountryCode`	string	No	Phone number country code (e.g., `+84`).
└─ `phoneNumber`	string	No	Phone number
└─ `addressCountry`	string	Conditional	Country of the beneficiary address.
└─ `addressZipCode`	string	No	ZIP/postal code.
└─ `addressCity`	string	Yes	City of the address.
└─ `addressStreet`	string	Yes	Street name and number.
└─ `addressState`	string	No	State/province of the address.
└─ `addressLocation`	string	No	Additional address info (e.g., suite, building).
`firstName`	string	Yes	First name of the contact person or individual beneficiary.
`lastName`	string	Yes	Last name of the contact person or individual beneficiary.
`dob`	string	No	Date of birth (format: `YYYY-MM-DD`). Applicable for individuals.
`email`	string	No	Email address of the beneficiary.
`phoneCountryCode`	string	No	Phone number country code (e.g., `+84`).
`phoneNumber`	string	No	Phone number.
`addressCountry`	string	Yes	Country of the beneficiary address.
`addressCity`	string	Yes	City of the address.
`addressState`	string	No	State/province of the address.
`addressZipCode`	string	No	ZIP/postal code.
`addressStreet`	string	Yes	Street name and number.
`addressLocation`	string	No	Additional address info (e.g., suite, building).
`identificationType`	string	No	Type of ID document (e.g., `PASSPORT`, `NATIONAL_ID`).
`identificationValue`	string	No	ID number or code.
`identificationCustomType`	string	No	Custom identification type (used when `identificationType` is null).
`description`	string	No	Free text description or note about the beneficiary.
`relationship`	string	No	relationship with the customer
`accountInfo`	object	Yes	account information
└─ accountType	string	yes	account type, one of value: BANK, CARD, WALLET, PROXY, CASH
└─ `accountNumber`	string	Conditional	Account number of the beneficiary (may be null or optional for some PSPs).
└─ `currency`	string	Yes	Transaction currency (e.g., `USD`, `SGD`).
└─ `bankName`	string	No	Beneficiary bank name.
└─ `bankCity`	string	No	Beneficiary bank city.
└─ `bankCountry`	string	No	Country of Bank
└─ `routingCodeType1`	string	No	Local payment routing system. If supplied, a value for routing_code_value_1 must also be supplied. Enum: ABA BSB BIC_SWIFT BANK_CODE BRANCH_CODE IFSC IBAN SORT_CODE
└─ `routingCodeValue1`	string	No	The value for any routing system specified in routing_code_type_1. If supplied, a value for routing_code_type_1 must also be supplied.
└─ `routingCodeType2`	string	No	Local payment routing system. If supplied, a value for routing_code_value_2 must also be supplied. Enum: ABA BSB BIC_SWIFT BANK_CODE BRANCH_CODE IFSC IBAN SORT_CODE
└─ `routingCodeValue2`	string	No	The value for any routing system specified in routing_code_type_2. If supplied, a value for routing_code_type_2 must also be supplied.
└─ `routingCodeType3`	string	No	Local payment routing system. If supplied, a value for routing_code_value_3 must also be supplied. Enum: ABA BSB BIC_SWIFT BANK_CODE BRANCH_CODE IFSC IBAN SORT_CODE
└─ `routingCodeValue3`	string	No	The value for any routing system specified in routing_code_type_3. If supplied, a value for routing_code_type_3 must also be supplied.
└─ `proxyType`	string	Conditional	Proxy type for this payout are MOBILE, UEN or NRIC
└─ `proxyValue`	string	Conditional	Proxy values are dependent on proxy type
└─ `intermediaryBicSwift`	string	no	SWIFT BIC associated to the Intermediary Agent
└─ `payId`	string	No (Finmo only)	NPP PayID (AU Specific)
└─ `payIdType`	string	No (Finmo only)	Mention the type of PayID,It takes values [“EMAIL, PHONE, ORG, ABN”]

Response Body

200 OK

Field	Type	Description
`id`	string	Identifier of the Payment Service Provider (e.g., `finmo`).
`psp`	object
└─ `id`	string	ID of the PSP
└─ `name`	string	Name of the PSP
`pspBeneficiaryId`	string	Beneficiary ID of the PSP
`merchantId`	string	merchant id
`customerId`	string	ID of the customer
`type`	string	Beneficiary type: `INDIVIDUAL` or `COMPANY`.
`beneficiaryName`	string	A custom internal name for the beneficiary. Must be unique.
`companyInfo`	object	Information about the company beneficiary.
└─ `name`	string	Company name.
└─ `registrationNumber`	string	Company registration number.
└─ `incorporationCountry`	string	The country where the company was incorporated.
└─ `email`	string	The email address of the beneficiary company.
└─ `phoneCountryCode`	string	Phone number country code (e.g., `+84`).
└─ `phoneNumber`	string	Phone number
└─ `addressCountry`	string	Country of the beneficiary address.
└─ `addressZipCode`	string	ZIP/postal code.
└─ `addressCity`	string	City of the address.
└─ `addressStreet`	string	Street name and number.
└─ `addressState`	string	State/province of the address.
└─ `addressLocation`	string	Additional address info (e.g., suite, building).
└─ `createdAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
└─ `createdBy`	string
└─ `updatedAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
└─ `updatedBy`	string
`firstName`	string	First name of the contact person or individual beneficiary.
`lastName`	string	Last name of the contact person or individual beneficiary.
`dob`	string	Date of birth (format: `YYYY-MM-DD`). Applicable for individuals.
`email`	string	Email address of the beneficiary.
`phoneCountryCode`	string	Phone number country code (e.g., `+84`).
`phoneNumber`	string	Phone number.
`addressCountry`	string	Country of the beneficiary address.
`addressCity`	string	City of the address.
`addressState`	string	State/province of the address.
`addressZipCode`	string	ZIP/postal code.
`addressStreet`	string	Street name and number.
`addressLocation`	string	Additional address info (e.g., suite, building).
`identificationType`	string	Type of ID document (e.g., `PASSPORT`, `NATIONAL_ID`).
`identificationValue`	string	ID number or code.
`identificationCustomType`	string	Custom identification type (used when `identificationType` is null).
`description`	string	Free text description or note about the beneficiary.
`relationship`	string	relationship with the customer
`accountInfo`	object	account information
└─ `accountType`	string	account type, one of value: BANK, CARD, WALLET, PROXY, CASH
└─ `accountNumber`	string	Account number of the beneficiary (may be null or optional for some PSPs).
└─ `currency`	string	Transaction currency (e.g., `USD`, `SGD`).
└─ `bankName`	string	Beneficiary bank name.
└─ `bankCity`	string	Beneficiary bank city.
└─ `bankCountry`	string	Country of Bank
└─ `routingCodeType1`	string	Local payment routing system. If supplied, a value for routing_code_value_1 must also be supplied. Enum: ABA BSB BIC_SWIFT BANK_CODE BRANCH_CODE IFSC IBAN SORT_CODE
└─ `routingCodeValue1`	string	The value for any routing system specified in routing_code_type_1. If supplied, a value for routing_code_type_1 must also be supplied.
└─ `routingCodeType2`	string	Local payment routing system. If supplied, a value for routing_code_value_2 must also be supplied. Enum: ABA BSB BIC_SWIFT BANK_CODE BRANCH_CODE IFSC IBAN SORT_CODE
└─ `routingCodeValue2`	string	The value for any routing system specified in routing_code_type_2. If supplied, a value for routing_code_type_2 must also be supplied.
└─ `routingCodeType3`	string	Local payment routing system. If supplied, a value for routing_code_value_3 must also be supplied. Enum: ABA BSB BIC_SWIFT BANK_CODE BRANCH_CODE IFSC IBAN SORT_CODE
└─ `routingCodeValue3`	string	The value for any routing system specified in routing_code_type_3. If supplied, a value for routing_code_type_3 must also be supplied.
└─ `proxyType`	string	Proxy type for this payout are MOBILE, UEN or NRIC
└─ `proxyValue`	string	Proxy values are dependent on proxy type
└─ `intermediaryBicSwift`	string	SWIFT BIC associated to the Intermediary Agent
└─ `payId`	string	NPP PayID (AU Specific)
└─ `payIdType`	string	Mention the type of PayID,It takes values [“EMAIL, PHONE, ORG, ABN”]
`createdAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
`createdBy`	string
`updatedAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
`updatedBy`	string
`pspBeneficiaries`	object
└─ `pspId`	string	identifier of the PSP
└─ `pspBeneficiaryId`	string	identifier of the Beneficiary in the PSP
└─`createdAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
└─`createdBy`	string

400 BAD REQUEST

Field	Type
`type`	string
`status`	number
`timestamp`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
`title`	string
`soaCode`	string
`fieldErrors`	array
└─ `object`	string
└─ `field`	string
└─ `rejectedValue`	string
└─ `message`	string

401 UNAUTHORIZED

Request

This endpoint expects an object.

dobdateRequired

typestringRequired

emailstringRequiredformat: "email"

pspIdstringRequired

lastNamestringRequired

firstNamestringRequired

customerIdstringRequired

accountInfoobjectRequired

addressCitystringRequired

descriptionstringRequired

phoneNumberstringRequired

addressStatestringRequired

relationshipstringRequired

addressStreetstringRequired

addressCountrystringRequired

addressZipCodestringRequired

addressLocationstringRequired

beneficiaryNamestringRequired

phoneCountryCodestringRequired

identificationTypestringRequired

identificationValuestringRequired

identificationCustomTypeanyOptional

Response headers

PragmastringOptional

ExpiresstringOptional

Request-IdstringOptional

Cache-ControlstringOptional

X-Frame-OptionsstringOptional

X-XSS-ProtectionstringOptional

X-Content-Type-OptionsstringOptional

Response

idstring

dobdate

typestring

emailstringformat: "email"

lastNamestring

createdAtdatetime

createdBystring

firstNamestring

updatedAtdatetime

updatedBystring

customerIdstring

merchantIdstring

accountInfoobject

addressCitystring

descriptionstring

phoneNumberstring

addressStatestring

relationshipstring

addressStreetstring

addressCountrystring

addressZipCodestring

addressLocationstring

beneficiaryNamestring

phoneCountryCodestring

pspBeneficiarieslist of any

identificationTypestring

identificationValuestring