Get beneficiary by id | Manis Technology

Get Beneficiary Details

This endpoint retrieves the details of a specific beneficiary identified by the beneficiaryId.

Request Parameters

beneficiaryId (path parameter): The unique identifier for the beneficiary whose details are being requested.

Response body

Field	Type	Description
`id`	string	Identifier of the beneficiary
`merchantId`	string	merchantId
`customerId`	string	customer 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).
`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	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 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”]
`pspBeneficiaries`	object array	psp beneficiary info
└─ `pspId`	string	Identifier of the Payment Service Provider (e.g., `finmo`).
└─ `pspBeneficiaryId`	string	Identifier of the beneficiary in Payment Service
└─ `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`	`createdBy`
`updatedAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
`updatedBy`	string

### Get Beneficiary Details This endpoint retrieves the details of a specific beneficiary identified by the `beneficiaryId`. #### Request Parameters - `beneficiaryId` (path parameter): The unique identifier for the beneficiary whose details are being requested. Response body | Field | Type | Description | | --- | --- | --- | | `id` | string | Identifier of the beneficiary | | `merchantId` | string | merchantId | | `customerId` | string | customer 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). | | `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 | 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 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"\] | | `pspBeneficiaries` | object array | psp beneficiary info | | └─ `pspId` | string | Identifier of the Payment Service Provider (e.g., `finmo`). | | └─ `pspBeneficiaryId` | string | Identifier of the beneficiary in Payment Service | | └─ `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` | `createdBy` | | | `updatedAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | | `updatedBy` | string | |

Response

idstringformat: "uuid"

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

Get Beneficiary Details

This endpoint retrieves the details of a specific beneficiary identified by the beneficiaryId.

Request Parameters

beneficiaryId (path parameter): The unique identifier for the beneficiary whose details are being requested.

Response body

Field	Type	Description
`id`	string	Identifier of the beneficiary
`merchantId`	string	merchantId
`customerId`	string	customer 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).
`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	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 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”]
`pspBeneficiaries`	object array	psp beneficiary info
└─ `pspId`	string	Identifier of the Payment Service Provider (e.g., `finmo`).
└─ `pspBeneficiaryId`	string	Identifier of the beneficiary in Payment Service
└─ `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`	`createdBy`
`updatedAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
`updatedBy`	string

1	{
2	"id": "dfc5cf7d-05a9-43fd-a6b5-158b1681961d",
3	"type": "INDIVIDUAL",
4	"email": "chi.nguyenquynh@eastgate-software.com",
5	"lastName": "Nguyen",
6	"createdAt": "2025-06-19T09:51:49.759Z",
7	"createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
8	"firstName": "Chi 196",
9	"updatedAt": "2025-06-19T09:51:49.759Z",
10	"updatedBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
11	"customerId": "8ef3cb75-6be5-4851-819e-3ee0a517dcb3",
12	"merchantId": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
13	"accountInfo": {
14	"payId": "email@gmail.com",
15	"bankName": "DBS Bank Ltd",
16	"currency": "SGD",
17	"payIdType": "EMAIL",
18	"proxyType": "MOBILE",
19	"proxyValue": "+919021221212",
20	"accountType": "BANK",
21	"accountNumber": "123456789012",
22	"routingCodeType1": "BIC_SWIFT",
23	"routingCodeType2": "BANK_CODE",
24	"routingCodeValue1": "DBSSSGSG",
25	"routingCodeValue2": "7171",
26	"intermediaryBicSwift": "intermediaryBicSwift"
27	},
28	"addressCity": "Singapore",
29	"description": "Payroll beneficiary",
30	"phoneNumber": "81234567",
31	"addressState": "Sing",
32	"relationship": "Employee",
33	"addressStreet": "10 Anson Road",
34	"addressCountry": "SG",
35	"addressZipCode": "079903",
36	"addressLocation": "International Plaza, #05-15",
37	"beneficiaryName": "Chi beneficiary with SGD",
38	"phoneCountryCode": "+65",
39	"pspBeneficiaries": [
40	{
41	"pspId": "finmo",
42	"createdAt": "2025-06-19T09:51:50.739Z",
43	"createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56",
44	"pspBeneficiaryId": "po_ben_7b8f36b7007b41d9a275e8400b1848f1"
45	}
46	]
47	}