Get beneficiary | Manis Technology

Description:

Retrieves a list of beneficiaries based on optional filter criteria. This endpoint supports flexible search by pspId, text input, and specific fields like name, phone, email, and beneficiary identifiers.

Query Parameters

Parameter	Type	Description
`pspId`	string	Identifier of the Payment Service Provider (e.g., `finmo`, `nium`).
`text`	string	Free-text search across name, email, and phone fields.
`name`	string	Filter by beneficiary’s name.
`phone`	string	Filter by beneficiary’s phone number.
`email`	string	Filter by beneficiary’s email address.
customerId	string	Filter by customer’s ID.
`beneficiaryId`	string	Internal Manis’s beneficiary ID.
`pspBeneficiaryId`	string	Beneficiary ID assigned by the PSP.
`page`	number
`pageSize`	number

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.
└─ `bankCity`	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 is 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 is 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 is MOBILE, UEN, or NRIC
└─ `proxyValue`	string	Proxy values are dependent on proxy type
└─ `intermediaryBicSwift`	string	SWIFT BIC associated with 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 the 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`	string
`updatedAt`	date(yyyy-MM-dd’T’HH:mm:ss.SSS’Z’)
`updatedBy`	string

Query parameters

pspIdstringOptional

textstringOptional

namestringOptional

phonestringOptional

emailstringOptional

beneficiaryIdstringOptional

pspBeneficiaryIdstringOptional

customerIdstringOptional

pagestringOptional

pageSizestringOptional

Response

datalist of objects

totalIteminteger

totalPageinteger

currentPageinteger