> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidoc-v1.maniscloud.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidoc-v1.maniscloud.com/_mcp/server. # Get beneficiary GET https://api/v1/beneficiaries **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 | | Reference: https://apidoc-v1.maniscloud.com/manis-unified-api-v-1-0/payout-beneficiary/get-beneficiary ## Servers - `https:/` (https://{url}, default) - `https:/` (https://{devurl}) ## Request ### Query parameters - `pspId` (string, optional) - `text` (string, optional) - `name` (string, optional) - `phone` (string, optional) - `email` (string, optional) - `beneficiaryId` (string, optional) - `pspBeneficiaryId` (string, optional) - `customerId` (string, optional) - `page` (string, optional) - `pageSize` (string, optional) ## Response ### 200 OK - `data` (list of object, required) - `id` (string, required) - `type` (string, required) - `email` (string, required) - `lastName` (string, required) - `createdAt` (datetime, required) - `createdBy` (string, required) - `firstName` (string, required) - `updatedAt` (datetime, required) - `updatedBy` (string, required) - `customerId` (string, required) - `merchantId` (string, required) - `accountInfo` (object, required) - `payId` (string, required) - `bankName` (string, required) - `currency` (string, required) - `payIdType` (string, required) - `proxyType` (string, required) - `proxyValue` (string, required) - `accountType` (string, required) - `accountNumber` (string, required) - `routingCodeType1` (string, required) - `routingCodeType2` (string, required) - `routingCodeValue1` (string, required) - `routingCodeValue2` (string, required) - `intermediaryBicSwift` (string, required) - `addressCity` (string, required) - `description` (string, required) - `phoneNumber` (string, required) - `addressState` (string, required) - `relationship` (string, required) - `addressStreet` (string, required) - `addressCountry` (string, required) - `addressZipCode` (string, required) - `addressLocation` (string, required) - `beneficiaryName` (string, required) - `phoneCountryCode` (string, required) - `pspBeneficiaries` (list of object, required) - `pspId` (string, required) - `createdAt` (datetime, required) - `createdBy` (string, required) - `pspBeneficiaryId` (string, required) - `totalItem` (integer, required) - `totalPage` (integer, required) - `currentPage` (integer, required) ## Examples **Response** ```json { "data": [ { "id": "dfc5cf7d-05a9-43fd-a6b5-158b1681961d", "type": "INDIVIDUAL", "email": "chi.nguyenquynh@eastgate-software.com", "lastName": "Nguyen", "createdAt": "2025-06-19T09:51:49.759Z", "createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56", "firstName": "Chi 196", "updatedAt": "2025-06-19T09:51:49.759Z", "updatedBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56", "customerId": "8ef3cb75-6be5-4851-819e-3ee0a517dcb3", "merchantId": "7eea1a78-6e23-49e4-a6c7-31d3181edb56", "accountInfo": { "payId": "email@gmail.com", "bankName": "DBS Bank Ltd", "currency": "SGD", "payIdType": "EMAIL", "proxyType": "MOBILE", "proxyValue": "+919021221212", "accountType": "BANK", "accountNumber": "123456789012", "routingCodeType1": "BIC_SWIFT", "routingCodeType2": "BANK_CODE", "routingCodeValue1": "DBSSSGSG", "routingCodeValue2": "7171", "intermediaryBicSwift": "intermediaryBicSwift" }, "addressCity": "Singapore", "description": "Payroll beneficiary", "phoneNumber": "81234567", "addressState": "Sing", "relationship": "Employee", "addressStreet": "10 Anson Road", "addressCountry": "SG", "addressZipCode": "079903", "addressLocation": "International Plaza, #05-15", "beneficiaryName": "Chi beneficiary with SGD", "phoneCountryCode": "+65", "pspBeneficiaries": [ { "pspId": "finmo", "createdAt": "2025-06-19T09:51:50.739Z", "createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56", "pspBeneficiaryId": "po_ben_7b8f36b7007b41d9a275e8400b1848f1" } ] } ], "totalItem": 1, "totalPage": 1, "currentPage": 0 } ``` **SDK Code** ```python Payout Beneficiary_Get beneficiary_example import requests url = "https://https/api/v1/beneficiaries" querystring = {"pspId":"{{pspId}}","text":"{{text}}","name":"{{name}}","phone":"{{phone}}","email":"{{email}}","beneficiaryId":"{{beneficiaryId}}","pspBeneficiaryId":"{{pspBeneficiaryId}}","customerId":"{{customerId}}","page":"{{page}}","pageSize":"{{pageSize}}"} response = requests.get(url, params=querystring) print(response.json()) ``` ```javascript Payout Beneficiary_Get beneficiary_example const url = 'https://https/api/v1/beneficiaries?pspId=%7B%7BpspId%7D%7D&text=%7B%7Btext%7D%7D&name=%7B%7Bname%7D%7D&phone=%7B%7Bphone%7D%7D&email=%7B%7Bemail%7D%7D&beneficiaryId=%7B%7BbeneficiaryId%7D%7D&pspBeneficiaryId=%7B%7BpspBeneficiaryId%7D%7D&customerId=%7B%7BcustomerId%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D'; const options = {method: 'GET'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Payout Beneficiary_Get beneficiary_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://https/api/v1/beneficiaries?pspId=%7B%7BpspId%7D%7D&text=%7B%7Btext%7D%7D&name=%7B%7Bname%7D%7D&phone=%7B%7Bphone%7D%7D&email=%7B%7Bemail%7D%7D&beneficiaryId=%7B%7BbeneficiaryId%7D%7D&pspBeneficiaryId=%7B%7BpspBeneficiaryId%7D%7D&customerId=%7B%7BcustomerId%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Payout Beneficiary_Get beneficiary_example require 'uri' require 'net/http' url = URI("https://https/api/v1/beneficiaries?pspId=%7B%7BpspId%7D%7D&text=%7B%7Btext%7D%7D&name=%7B%7Bname%7D%7D&phone=%7B%7Bphone%7D%7D&email=%7B%7Bemail%7D%7D&beneficiaryId=%7B%7BbeneficiaryId%7D%7D&pspBeneficiaryId=%7B%7BpspBeneficiaryId%7D%7D&customerId=%7B%7BcustomerId%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```java Payout Beneficiary_Get beneficiary_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://https/api/v1/beneficiaries?pspId=%7B%7BpspId%7D%7D&text=%7B%7Btext%7D%7D&name=%7B%7Bname%7D%7D&phone=%7B%7Bphone%7D%7D&email=%7B%7Bemail%7D%7D&beneficiaryId=%7B%7BbeneficiaryId%7D%7D&pspBeneficiaryId=%7B%7BpspBeneficiaryId%7D%7D&customerId=%7B%7BcustomerId%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D") .asString(); ``` ```php Payout Beneficiary_Get beneficiary_example request('GET', 'https://https/api/v1/beneficiaries?pspId=%7B%7BpspId%7D%7D&text=%7B%7Btext%7D%7D&name=%7B%7Bname%7D%7D&phone=%7B%7Bphone%7D%7D&email=%7B%7Bemail%7D%7D&beneficiaryId=%7B%7BbeneficiaryId%7D%7D&pspBeneficiaryId=%7B%7BpspBeneficiaryId%7D%7D&customerId=%7B%7BcustomerId%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D'); echo $response->getBody(); ``` ```csharp Payout Beneficiary_Get beneficiary_example using RestSharp; var client = new RestClient("https://https/api/v1/beneficiaries?pspId=%7B%7BpspId%7D%7D&text=%7B%7Btext%7D%7D&name=%7B%7Bname%7D%7D&phone=%7B%7Bphone%7D%7D&email=%7B%7Bemail%7D%7D&beneficiaryId=%7B%7BbeneficiaryId%7D%7D&pspBeneficiaryId=%7B%7BpspBeneficiaryId%7D%7D&customerId=%7B%7BcustomerId%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift Payout Beneficiary_Get beneficiary_example import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://https/api/v1/beneficiaries?pspId=%7B%7BpspId%7D%7D&text=%7B%7Btext%7D%7D&name=%7B%7Bname%7D%7D&phone=%7B%7Bphone%7D%7D&email=%7B%7Bemail%7D%7D&beneficiaryId=%7B%7BbeneficiaryId%7D%7D&pspBeneficiaryId=%7B%7BpspBeneficiaryId%7D%7D&customerId=%7B%7BcustomerId%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```