> 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. # Add existing beneficiary to a PSP POST https://api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration Content-Type: application/json 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 Reference: https://apidoc-v1.maniscloud.com/manis-unified-api-v-1-0/payout-beneficiary/add-existing-beneficiary-to-a-psp ## Servers - `https:/` (https://{url}, default) - `https:/` (https://{devurl}) ## Request ### Body (application/json) - `pspId` (string, required) ## Response ### 200 OK - `id` (string, required) - `dob` (date, required) - `psp` (object, required) - `id` (string, required) - `name` (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) - `pspBeneficiaryId` (string, required) ## Examples **Request** ```json { "pspId": "{{pspId}}" } ``` **Response** ```json { "id": "976004ce-900c-4f2e-85d0-69f41e3aeec8", "dob": "1999-03-01", "psp": { "id": "finmo", "name": "Finmo" }, "type": "INDIVIDUAL", "email": "testNiumIndividual104@gmail.com", "lastName": "Miracle", "createdAt": "2025-06-19T16:22:08.695Z", "createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56", "firstName": "Nigma", "updatedAt": "2025-06-19T16:22:08.695Z", "updatedBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56", "customerId": "7c50bcff-ea3b-48d5-af69-e012f1964b52", "merchantId": "7eea1a78-6e23-49e4-a6c7-31d3181edb56", "accountInfo": { "payId": "email@gmail.com", "bankName": "HSBC", "currency": "SGD", "payIdType": "EMAIL", "proxyType": "MOBILE", "proxyValue": "+919021221212", "accountType": "BANK", "accountNumber": "318351267899", "routingCodeType1": "BIC_SWIFT", "routingCodeType2": "ABA", "routingCodeValue1": "BOFAUS3N", "routingCodeValue2": "121000358", "intermediaryBicSwift": "IRVTUS3NXXX" }, "addressCity": "City", "description": "description", "phoneNumber": "0904547087", "addressState": "State", "relationship": "Employee", "addressStreet": "Street", "addressCountry": "SG", "addressZipCode": "1000", "addressLocation": "Location", "beneficiaryName": "beneficiary indicidual with us", "phoneCountryCode": "+84", "pspBeneficiaries": [ { "pspId": "finmo", "createdAt": "2025-06-19T16:22:09.523Z", "createdBy": "7eea1a78-6e23-49e4-a6c7-31d3181edb56", "pspBeneficiaryId": "po_ben_223ae468e1984428be3ed7f4a70a4858" } ], "pspBeneficiaryId": "po_ben_223ae468e1984428be3ed7f4a70a4858" } ``` **SDK Code** ```python Payout Beneficiary_Add existing beneficiary to a PSP_example import requests url = "https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration" payload = { "pspId": "{{pspId}}" } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Payout Beneficiary_Add existing beneficiary to a PSP_example const url = 'https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"pspId":"{{pspId}}"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Payout Beneficiary_Add existing beneficiary to a PSP_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration" payload := strings.NewReader("{\n \"pspId\": \"{{pspId}}\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Payout Beneficiary_Add existing beneficiary to a PSP_example require 'uri' require 'net/http' url = URI("https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"pspId\": \"{{pspId}}\"\n}" response = http.request(request) puts response.read_body ``` ```java Payout Beneficiary_Add existing beneficiary to a PSP_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration") .header("Content-Type", "application/json") .body("{\n \"pspId\": \"{{pspId}}\"\n}") .asString(); ``` ```php Payout Beneficiary_Add existing beneficiary to a PSP_example request('POST', 'https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration', [ 'body' => '{ "pspId": "{{pspId}}" }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Payout Beneficiary_Add existing beneficiary to a PSP_example using RestSharp; var client = new RestClient("https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"pspId\": \"{{pspId}}\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Payout Beneficiary_Add existing beneficiary to a PSP_example import Foundation let headers = ["Content-Type": "application/json"] let parameters = ["pspId": "{{pspId}}"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://https/api/v1/beneficiaries/%7BbeneficiaryId%7D/psp-registration")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```