Add existing beneficiary to a PSP | Manis Technology

This API is used to register an existing beneficiary on another PSP

Request Body

Field	Type	Required	Description
`pspId`	string	Yes	Identifier of the payment provider (e.g., `nium`, `finmo`).

200 OK

Field	Type	Description
`id`	string	Identifier of the beneficiary in manis
`customerId`	string	The Customer Id
`merchantId`	string	merchant id
`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	Country where the company was incorporated.
└─ `email`	string	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 identity document: PASSPORT, NATIONAL_ID, OTHERS
`identificationCustomType`	string	Identity custom type
`identificationValue`	string	Identity Document Number
`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	Beneficiary bank country.
└─ `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 is 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`	array
└─ `pspId`	string	ID of the PSP
└─ `pspBeneficiaryId`	string	ID of beneficiary in PSP
└─ `createdAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
└─ `createdBy`	string
`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

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

This API is used to register an existing beneficiary on another PSP **Request Body** | Field | Type | Required | Description | | --- | --- | --- | --- | | `pspId` | string | Yes | Identifier of the payment provider (e.g., `nium`, `finmo`). | 200 OK | Field | Type | Description | | --- | --- | --- | | `id` | string | Identifier of the beneficiary in manis | | `customerId` | string | The Customer Id | | `merchantId` | string | merchant id | | `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 | Country where the company was incorporated. | | └─ `email` | string | 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 identity document: PASSPORT, NATIONAL_ID, OTHERS | | `identificationCustomType` | string | Identity custom type | | `identificationValue` | string | Identity Document Number | | `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 | Beneficiary bank country. | | └─ `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 is 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` | array | | | └─ `pspId` | string | ID of the PSP | | └─ `pspBeneficiaryId` | string | ID of beneficiary in PSP | | └─ `createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | | └─ `createdBy` | string | | | `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 | | 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.

pspIdstringRequired

Response

idstringformat: "uuid"

dobdate

pspobject

typestring

emailstringformat: "email"

lastNamestring

createdAtdatetime

createdBystringformat: "uuid"

firstNamestring

updatedAtdatetime

updatedBystringformat: "uuid"

customerIdstringformat: "uuid"

merchantIdstringformat: "uuid"

accountInfoobject

addressCitystring

descriptionstring

phoneNumberstring

addressStatestring

relationshipstring

addressStreetstring

addressCountrystring

addressZipCodestring

addressLocationstring

beneficiaryNamestring

phoneCountryCodestring

pspBeneficiarieslist of objects

pspBeneficiaryIdstring

This API is used to register an existing beneficiary on another PSP

Request Body

Field	Type	Required	Description
`pspId`	string	Yes	Identifier of the payment provider (e.g., `nium`, `finmo`).

200 OK

Field	Type	Description
`id`	string	Identifier of the beneficiary in manis
`customerId`	string	The Customer Id
`merchantId`	string	merchant id
`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	Country where the company was incorporated.
└─ `email`	string	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 identity document: PASSPORT, NATIONAL_ID, OTHERS
`identificationCustomType`	string	Identity custom type
`identificationValue`	string	Identity Document Number
`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	Beneficiary bank country.
└─ `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 is 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`	array
└─ `pspId`	string	ID of the PSP
└─ `pspBeneficiaryId`	string	ID of beneficiary in PSP
└─ `createdAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
└─ `createdBy`	string
`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

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

1	curl -X POST https://https//https/api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration \
2	-H "Content-Type: application/json" \
3	-d '{
4	"pspId": "{{pspId}}"
5	}'

1	{
2	"id": "976004ce-900c-4f2e-85d0-69f41e3aeec8",
3	"dob": "1999-03-01",
4	"psp": {
5	"id": "finmo",
6	"name": "Finmo"
7	},
8	"type": "INDIVIDUAL",
9	"email": "testNiumIndividual104@gmail.com",
10	"lastName": "Miracle",
11	"createdAt": "2025-06-19T16:22:08.695Z",
12	"createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
13	"firstName": "Nigma",
14	"updatedAt": "2025-06-19T16:22:08.695Z",
15	"updatedBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
16	"customerId": "7c50bcff-ea3b-48d5-af69-e012f1964b52",
17	"merchantId": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
18	"accountInfo": {
19	"payId": "email@gmail.com",
20	"bankName": "HSBC",
21	"currency": "SGD",
22	"payIdType": "EMAIL",
23	"proxyType": "MOBILE",
24	"proxyValue": "+919021221212",
25	"accountType": "BANK",
26	"accountNumber": "318351267899",
27	"routingCodeType1": "BIC_SWIFT",
28	"routingCodeType2": "ABA",
29	"routingCodeValue1": "BOFAUS3N",
30	"routingCodeValue2": "121000358",
31	"intermediaryBicSwift": "IRVTUS3NXXX"
32	},
33	"addressCity": "City",
34	"description": "description",
35	"phoneNumber": "0904547087",
36	"addressState": "State",
37	"relationship": "Employee",
38	"addressStreet": "Street",
39	"addressCountry": "SG",
40	"addressZipCode": "1000",
41	"addressLocation": "Location",
42	"beneficiaryName": "beneficiary indicidual with us",
43	"phoneCountryCode": "+84",
44	"pspBeneficiaries": [
45	{
46	"pspId": "finmo",
47	"createdAt": "2025-06-19T16:22:09.523Z",
48	"createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
49	"pspBeneficiaryId": "po_ben_223ae468e1984428be3ed7f4a70a4858"
50	}
51	],
52	"pspBeneficiaryId": "po_ben_223ae468e1984428be3ed7f4a70a4858"
53	}