> 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. # Create new beneficiary POST https://api/v1/beneficiaries Content-Type: application/json This API is used to create a new **beneficiary** for a specific Payment Service Provider (PSP). The request body contains personal or company information depending on the `type`. **Request Body:** | Field | Type | Required | Description | | -------------------------- | ------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `pspId` | string | No | Identifier of the Payment Service Provider (e.g., `finmo`). | | `customerId` | string | Yes | customer id | | `type` | string | Yes | Beneficiary type: `INDIVIDUAL` or `COMPANY`. | | `beneficiaryName` | string | Yes | A custom internal name for the beneficiary. Must be unique. | | `companyInfo` | object | Required if type = COMPANY | Information about the company beneficiary. | | └─ `name` | string | Yes | Company name. | | └─ `registrationNumber` | string | Yes | Company registration number. | | └─ `incorporationCountry` | string | No | Country where the company was incorporated. | | └─ `email` | string | No | Email address of the beneficiary company. | | └─ `phoneCountryCode` | string | No | Phone number country code (e.g., `+84`). | | └─ `phoneNumber` | string | No | Phone number | | └─ `addressCountry` | string | Conditional | Country of the beneficiary address. | | └─ `addressZipCode` | string | No | ZIP/postal code. | | └─ `addressCity` | string | Yes | City of the address. | | └─ `addressStreet` | string | Yes | Street name and number. | | └─ `addressState` | string | No | State/province of the address. | | └─ `addressLocation` | string | No | Additional address info (e.g., suite, building). | | `firstName` | string | Yes | First name of the contact person or individual beneficiary. | | `lastName` | string | Yes | Last name of the contact person or individual beneficiary. | | `dob` | string | No | Date of birth (format: `YYYY-MM-DD`). Applicable for individuals. | | `email` | string | No | Email address of the beneficiary. | | `phoneCountryCode` | string | No | Phone number country code (e.g., `+84`). | | `phoneNumber` | string | No | Phone number. | | `addressCountry` | string | Yes | Country of the beneficiary address. | | `addressCity` | string | Yes | City of the address. | | `addressState` | string | No | State/province of the address. | | `addressZipCode` | string | No | ZIP/postal code. | | `addressStreet` | string | Yes | Street name and number. | | `addressLocation` | string | No | Additional address info (e.g., suite, building). | | `identificationType` | string | No | Type of ID document (e.g., `PASSPORT`, `NATIONAL_ID`). | | `identificationValue` | string | No | ID number or code. | | `identificationCustomType` | string | No | Custom identification type (used when `identificationType` is null). | | `description` | string | No | Free text description or note about the beneficiary. | | `relationship` | string | No | relationship with the customer | | `accountInfo` | object | Yes | account information | | └─ accountType | string | yes | account type, one of value: BANK, CARD, WALLET, PROXY, CASH | | └─ `accountNumber` | string | Conditional | Account number of the beneficiary (may be null or optional for some PSPs). | | └─ `currency` | string | Yes | Transaction currency (e.g., `USD`, `SGD`). | | └─ `bankName` | string | No | Beneficiary bank name. | | └─ `bankCity` | string | No | Beneficiary bank city. | | └─ `bankCountry` | string | No | Country of Bank | | └─ `routingCodeType1` | string | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | Conditional | Proxy type for this payout are MOBILE, UEN or NRIC | | └─ `proxyValue` | string | Conditional | Proxy values are dependent on proxy type | | └─ `intermediaryBicSwift` | string | no | SWIFT BIC associated to the Intermediary Agent | | └─ `payId` | string | No (Finmo only) | NPP PayID (AU Specific) | | └─ `payIdType` | string | No (Finmo only) | Mention the type of PayID,It takes values \["EMAIL, PHONE, ORG, ABN"] | #### **Response Body** 200 OK | Field | Type | Description | | -------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | Identifier of the Payment Service Provider (e.g., `finmo`). | | `psp` | object | | | └─ `id` | string | ID of the PSP | | └─ `name` | string | Name of the PSP | | `pspBeneficiaryId` | string | Beneficiary ID of the PSP | | `merchantId` | string | merchant id | | `customerId` | string | ID of the customer | | `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 | The country where the company was incorporated. | | └─ `email` | string | The 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 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 | Country of Bank | | └─ `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"] | | `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` | object | | | └─ `pspId` | string | identifier of the PSP | | └─ `pspBeneficiaryId` | string | identifier of the Beneficiary in the PSP | | └─`createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | | └─`createdBy` | 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/create-new-beneficiary ## Servers - `https:/` (https://{url}, default) - `https:/` (https://{devurl}) ## Request ### Body (application/json) - `dob` (date, required) - `type` (string, required) - `email` (string, required) - `pspId` (string, required) - `lastName` (string, required) - `firstName` (string, required) - `customerId` (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) - `bankCountry` (string, required) - `accountNumber` (string, required) - `routingCodeType1` (string, required) - `routingCodeType2` (string, required) - `routingCodeValue1` (string, required) - `routingCodeValue2` (string, required) - `intermediaryBicSwift` (string, required) - `routingCodeType3` (any, optional) - `routingCodeValue3` (any, optional) - `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) - `identificationType` (string, required) - `identificationValue` (string, required) - `identificationCustomType` (any, optional) ## Response ### 200 OK - `id` (string, required) - `dob` (date, 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) - `createdAt` (datetime, required) - `createdBy` (string, required) - `payIdType` (string, required) - `proxyType` (string, required) - `updatedAt` (datetime, required) - `updatedBy` (string, required) - `cardNumber` (string, required) - `proxyValue` (string, required) - `accountType` (string, required) - `bankCountry` (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 any, required) - `identificationType` (string, required) - `identificationValue` (string, required) ## Examples ### 400: Bad request **Request** ```json undefined ``` **Response** ```json { "id": "string", "dob": "2023-01-15", "type": "https://api-docs.manis.com/problems/validation-error", "email": "string", "lastName": "string", "createdAt": "2024-01-15T09:30:00Z", "createdBy": "string", "firstName": "string", "updatedAt": "2024-01-15T09:30:00Z", "updatedBy": "string", "customerId": "string", "merchantId": "string", "accountInfo": { "payId": "string", "bankName": "string", "currency": "string", "createdAt": "2024-01-15T09:30:00Z", "createdBy": "string", "payIdType": "string", "proxyType": "string", "updatedAt": "2024-01-15T09:30:00Z", "updatedBy": "string", "cardNumber": "string", "proxyValue": "string", "accountType": "string", "bankCountry": "string", "accountNumber": "string", "routingCodeType1": "string", "routingCodeType2": "string", "routingCodeValue1": "string", "routingCodeValue2": "string", "intermediaryBicSwift": "string" }, "addressCity": "string", "description": "string", "phoneNumber": "string", "addressState": "string", "relationship": "string", "addressStreet": "string", "addressCountry": "string", "addressZipCode": "string", "addressLocation": "string", "beneficiaryName": "string", "phoneCountryCode": "string", "pspBeneficiaries": [ null ], "identificationType": "string", "identificationValue": "string", "title": "Input data is invalid", "detail": "Validation failed for argument [0] in org.springframework.http.ResponseEntity com.manis.psphub.controller.BeneficiaryController.create(com.manis.psphub.dto.request.NewBeneficiaryRequestDto) throws com.manis.psphub.i18n.I18nException with 2 errors: [Field error in object 'newBeneficiaryRequestDto' on field 'phoneCountryCode': rejected value [65]; codes [Pattern.newBeneficiaryRequestDto.phoneCountryCode,Pattern.phoneCountryCode,Pattern.java.lang.String,Pattern]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [newBeneficiaryRequestDto.phoneCountryCode,phoneCountryCode]; arguments []; default message [phoneCountryCode],[Ljakarta.validation.constraints.Pattern$Flag;@1989ca60,^\\+\\d{1,4}$]; default message [must match \"^\\+\\d{1,4}$\"]] [Field error in object 'newBeneficiaryRequestDto' on field 'addressCountry': rejected value [USD]; codes [ValidCountryCode.newBeneficiaryRequestDto.addressCountry,ValidCountryCode.addressCountry,ValidCountryCode.java.lang.String,ValidCountryCode]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [newBeneficiaryRequestDto.addressCountry,addressCountry]; arguments []; default message [addressCountry]]; default message [Invalid country code]] ", "status": 400, "soaCode": "4000", "timestamp": "2025-07-30T23:34:29.949Z", "fieldErrors": [ { "field": "phoneCountryCode", "object": "newBeneficiaryRequestDto", "message": "must match \"^\\+\\d{1,4}$\"", "rejectedValue": "65" }, { "field": "addressCountry", "object": "newBeneficiaryRequestDto", "message": "Invalid country code", "rejectedValue": "USD" } ] } ``` **SDK Code** ```python 400: Bad request import requests url = "https://https/api/v1/beneficiaries" response = requests.post(url) print(response.json()) ``` ```javascript 400: Bad request const url = 'https://https/api/v1/beneficiaries'; const options = {method: 'POST'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 400: Bad request package main import ( "fmt" "net/http" "io" ) func main() { url := "https://https/api/v1/beneficiaries" req, _ := http.NewRequest("POST", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 400: Bad request require 'uri' require 'net/http' url = URI("https://https/api/v1/beneficiaries") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) response = http.request(request) puts response.read_body ``` ```java 400: Bad request import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/api/v1/beneficiaries") .asString(); ``` ```php 400: Bad request request('POST', 'https://https/api/v1/beneficiaries'); echo $response->getBody(); ``` ```csharp 400: Bad request using RestSharp; var client = new RestClient("https://https/api/v1/beneficiaries"); var request = new RestRequest(Method.POST); IRestResponse response = client.Execute(request); ``` ```swift 400: Bad request import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://https/api/v1/beneficiaries")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" 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() ``` ### Create nium individual beneficiary **Request** ```json undefined ``` **Response** ```json { "id": "benef-01k6mnbcrf5ckqpx99am3q3yxt", "dob": "1999-03-01", "type": "INDIVIDUAL", "email": "testNiumIndividual104@gmail.com", "lastName": "Miracle", "createdAt": "2025-10-03T09:09:49.968Z", "createdBy": "merch-01k0rc69p8a5m6k5c9h1d3rf90", "firstName": "Nigma", "updatedAt": "2025-10-03T09:09:49.968Z", "updatedBy": "merch-01k0rc69p8a5m6k5c9h1d3rf90", "customerId": "cus-01k0s6n7ad06fcqpwb7qrgxn02", "merchantId": "merch-01k0rc69p8a5m6k5c9h1d3rf90", "accountInfo": { "payId": "emailTest@gmail.com", "bankName": "Bank of America", "currency": "USD", "createdAt": "2025-10-03T09:09:49.970Z", "createdBy": "merch-01k0rc69p8a5m6k5c9h1d3rf90", "payIdType": "EMAIL", "proxyType": "MOBILE", "updatedAt": "2025-10-03T09:09:49.970Z", "updatedBy": "merch-01k0rc69p8a5m6k5c9h1d3rf90", "cardNumber": "******", "proxyValue": "+919021221212", "accountType": "BANK", "bankCountry": "US", "accountNumber": "318351267899", "routingCodeType1": "BIC_SWIFT", "routingCodeType2": "ABA", "routingCodeValue1": "BOFAUS3N", "routingCodeValue2": "121000358", "intermediaryBicSwift": "intermediaryBicSwift" }, "addressCity": "City", "description": "description", "phoneNumber": "0904547087", "addressState": "State", "relationship": "Employee", "addressStreet": "Street", "addressCountry": "US", "addressZipCode": "1000", "addressLocation": "Location", "beneficiaryName": "beneficiary indicidual with US dev", "phoneCountryCode": "+84", "pspBeneficiaries": [], "identificationType": "NATIONAL_ID", "identificationValue": "1234345445" } ``` **SDK Code** ```python Create nium individual beneficiary import requests url = "https://https/api/v1/beneficiaries" response = requests.post(url) print(response.json()) ``` ```javascript Create nium individual beneficiary const url = 'https://https/api/v1/beneficiaries'; const options = {method: 'POST'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Create nium individual beneficiary package main import ( "fmt" "net/http" "io" ) func main() { url := "https://https/api/v1/beneficiaries" req, _ := http.NewRequest("POST", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Create nium individual beneficiary require 'uri' require 'net/http' url = URI("https://https/api/v1/beneficiaries") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) response = http.request(request) puts response.read_body ``` ```java Create nium individual beneficiary import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/api/v1/beneficiaries") .asString(); ``` ```php Create nium individual beneficiary request('POST', 'https://https/api/v1/beneficiaries'); echo $response->getBody(); ``` ```csharp Create nium individual beneficiary using RestSharp; var client = new RestClient("https://https/api/v1/beneficiaries"); var request = new RestRequest(Method.POST); IRestResponse response = client.Execute(request); ``` ```swift Create nium individual beneficiary import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://https/api/v1/beneficiaries")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" 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() ``` ### Payout Beneficiary_Create new beneficiary_example **Request** ```json { "dob": "1999-03-01", "type": "INDIVIDUAL", "email": "testNiumIndividual104@gmail.com", "pspId": "nium", "lastName": "Miracle", "firstName": "Nigma", "customerId": "cus-01k0s6n7ad06fcqpwb7qrgxn02", "accountInfo": { "payId": "emailTest@gmail.com", "bankName": "Bank of America", "currency": "USD", "payIdType": "EMAIL", "proxyType": "MOBILE", "proxyValue": "+919021221212", "accountType": "BANK", "bankCountry": "US", "accountNumber": "318351267899", "routingCodeType1": "bic_swift", "routingCodeType2": "aba", "routingCodeValue1": "BOFAUS3N", "routingCodeValue2": "121000358", "intermediaryBicSwift": "intermediaryBicSwift" }, "addressCity": "City", "description": "description", "phoneNumber": "0904547087", "addressState": "State", "relationship": "Employee", "addressStreet": "Street", "addressCountry": "US", "addressZipCode": "1000", "addressLocation": "Location", "beneficiaryName": "beneficiary indicidual with US dev", "phoneCountryCode": "+84", "identificationType": "NATIONAL_ID", "identificationValue": "1234345445" } ``` **Response** ```json { "id": "string", "dob": "2023-01-15", "type": "https://api-docs.manis.com/problems/validation-error", "email": "string", "lastName": "string", "createdAt": "2024-01-15T09:30:00Z", "createdBy": "string", "firstName": "string", "updatedAt": "2024-01-15T09:30:00Z", "updatedBy": "string", "customerId": "string", "merchantId": "string", "accountInfo": { "payId": "string", "bankName": "string", "currency": "string", "createdAt": "2024-01-15T09:30:00Z", "createdBy": "string", "payIdType": "string", "proxyType": "string", "updatedAt": "2024-01-15T09:30:00Z", "updatedBy": "string", "cardNumber": "string", "proxyValue": "string", "accountType": "string", "bankCountry": "string", "accountNumber": "string", "routingCodeType1": "string", "routingCodeType2": "string", "routingCodeValue1": "string", "routingCodeValue2": "string", "intermediaryBicSwift": "string" }, "addressCity": "string", "description": "string", "phoneNumber": "string", "addressState": "string", "relationship": "string", "addressStreet": "string", "addressCountry": "string", "addressZipCode": "string", "addressLocation": "string", "beneficiaryName": "string", "phoneCountryCode": "string", "pspBeneficiaries": [ null ], "identificationType": "string", "identificationValue": "string", "title": "Input data is invalid", "detail": "Validation failed for argument [0] in org.springframework.http.ResponseEntity com.manis.psphub.controller.BeneficiaryController.create(com.manis.psphub.dto.request.NewBeneficiaryRequestDto) throws com.manis.psphub.i18n.I18nException with 2 errors: [Field error in object 'newBeneficiaryRequestDto' on field 'phoneCountryCode': rejected value [65]; codes [Pattern.newBeneficiaryRequestDto.phoneCountryCode,Pattern.phoneCountryCode,Pattern.java.lang.String,Pattern]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [newBeneficiaryRequestDto.phoneCountryCode,phoneCountryCode]; arguments []; default message [phoneCountryCode],[Ljakarta.validation.constraints.Pattern$Flag;@1989ca60,^\\+\\d{1,4}$]; default message [must match \"^\\+\\d{1,4}$\"]] [Field error in object 'newBeneficiaryRequestDto' on field 'addressCountry': rejected value [USD]; codes [ValidCountryCode.newBeneficiaryRequestDto.addressCountry,ValidCountryCode.addressCountry,ValidCountryCode.java.lang.String,ValidCountryCode]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [newBeneficiaryRequestDto.addressCountry,addressCountry]; arguments []; default message [addressCountry]]; default message [Invalid country code]] ", "status": 400, "soaCode": "4000", "timestamp": "2025-07-30T23:34:29.949Z", "fieldErrors": [ { "field": "phoneCountryCode", "object": "newBeneficiaryRequestDto", "message": "must match \"^\\+\\d{1,4}$\"", "rejectedValue": "65" }, { "field": "addressCountry", "object": "newBeneficiaryRequestDto", "message": "Invalid country code", "rejectedValue": "USD" } ] } ``` **SDK Code** ```python Payout Beneficiary_Create new beneficiary_example import requests url = "https://https/api/v1/beneficiaries" payload = { "dob": "1999-03-01", "type": "INDIVIDUAL", "email": "testNiumIndividual104@gmail.com", "pspId": "nium", "lastName": "Miracle", "firstName": "Nigma", "customerId": "cus-01k0s6n7ad06fcqpwb7qrgxn02", "accountInfo": { "payId": "emailTest@gmail.com", "bankName": "Bank of America", "currency": "USD", "payIdType": "EMAIL", "proxyType": "MOBILE", "proxyValue": "+919021221212", "accountType": "BANK", "bankCountry": "US", "accountNumber": "318351267899", "routingCodeType1": "bic_swift", "routingCodeType2": "aba", "routingCodeValue1": "BOFAUS3N", "routingCodeValue2": "121000358", "intermediaryBicSwift": "intermediaryBicSwift" }, "addressCity": "City", "description": "description", "phoneNumber": "0904547087", "addressState": "State", "relationship": "Employee", "addressStreet": "Street", "addressCountry": "US", "addressZipCode": "1000", "addressLocation": "Location", "beneficiaryName": "beneficiary indicidual with US dev", "phoneCountryCode": "+84", "identificationType": "NATIONAL_ID", "identificationValue": "1234345445" } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Payout Beneficiary_Create new beneficiary_example const url = 'https://https/api/v1/beneficiaries'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"dob":"1999-03-01","type":"INDIVIDUAL","email":"testNiumIndividual104@gmail.com","pspId":"nium","lastName":"Miracle","firstName":"Nigma","customerId":"cus-01k0s6n7ad06fcqpwb7qrgxn02","accountInfo":{"payId":"emailTest@gmail.com","bankName":"Bank of America","currency":"USD","payIdType":"EMAIL","proxyType":"MOBILE","proxyValue":"+919021221212","accountType":"BANK","bankCountry":"US","accountNumber":"318351267899","routingCodeType1":"bic_swift","routingCodeType2":"aba","routingCodeValue1":"BOFAUS3N","routingCodeValue2":"121000358","intermediaryBicSwift":"intermediaryBicSwift"},"addressCity":"City","description":"description","phoneNumber":"0904547087","addressState":"State","relationship":"Employee","addressStreet":"Street","addressCountry":"US","addressZipCode":"1000","addressLocation":"Location","beneficiaryName":"beneficiary indicidual with US dev","phoneCountryCode":"+84","identificationType":"NATIONAL_ID","identificationValue":"1234345445"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Payout Beneficiary_Create new beneficiary_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/api/v1/beneficiaries" payload := strings.NewReader("{\n \"dob\": \"1999-03-01\",\n \"type\": \"INDIVIDUAL\",\n \"email\": \"testNiumIndividual104@gmail.com\",\n \"pspId\": \"nium\",\n \"lastName\": \"Miracle\",\n \"firstName\": \"Nigma\",\n \"customerId\": \"cus-01k0s6n7ad06fcqpwb7qrgxn02\",\n \"accountInfo\": {\n \"payId\": \"emailTest@gmail.com\",\n \"bankName\": \"Bank of America\",\n \"currency\": \"USD\",\n \"payIdType\": \"EMAIL\",\n \"proxyType\": \"MOBILE\",\n \"proxyValue\": \"+919021221212\",\n \"accountType\": \"BANK\",\n \"bankCountry\": \"US\",\n \"accountNumber\": \"318351267899\",\n \"routingCodeType1\": \"bic_swift\",\n \"routingCodeType2\": \"aba\",\n \"routingCodeValue1\": \"BOFAUS3N\",\n \"routingCodeValue2\": \"121000358\",\n \"intermediaryBicSwift\": \"intermediaryBicSwift\"\n },\n \"addressCity\": \"City\",\n \"description\": \"description\",\n \"phoneNumber\": \"0904547087\",\n \"addressState\": \"State\",\n \"relationship\": \"Employee\",\n \"addressStreet\": \"Street\",\n \"addressCountry\": \"US\",\n \"addressZipCode\": \"1000\",\n \"addressLocation\": \"Location\",\n \"beneficiaryName\": \"beneficiary indicidual with US dev\",\n \"phoneCountryCode\": \"+84\",\n \"identificationType\": \"NATIONAL_ID\",\n \"identificationValue\": \"1234345445\"\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_Create new beneficiary_example require 'uri' require 'net/http' url = URI("https://https/api/v1/beneficiaries") 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 \"dob\": \"1999-03-01\",\n \"type\": \"INDIVIDUAL\",\n \"email\": \"testNiumIndividual104@gmail.com\",\n \"pspId\": \"nium\",\n \"lastName\": \"Miracle\",\n \"firstName\": \"Nigma\",\n \"customerId\": \"cus-01k0s6n7ad06fcqpwb7qrgxn02\",\n \"accountInfo\": {\n \"payId\": \"emailTest@gmail.com\",\n \"bankName\": \"Bank of America\",\n \"currency\": \"USD\",\n \"payIdType\": \"EMAIL\",\n \"proxyType\": \"MOBILE\",\n \"proxyValue\": \"+919021221212\",\n \"accountType\": \"BANK\",\n \"bankCountry\": \"US\",\n \"accountNumber\": \"318351267899\",\n \"routingCodeType1\": \"bic_swift\",\n \"routingCodeType2\": \"aba\",\n \"routingCodeValue1\": \"BOFAUS3N\",\n \"routingCodeValue2\": \"121000358\",\n \"intermediaryBicSwift\": \"intermediaryBicSwift\"\n },\n \"addressCity\": \"City\",\n \"description\": \"description\",\n \"phoneNumber\": \"0904547087\",\n \"addressState\": \"State\",\n \"relationship\": \"Employee\",\n \"addressStreet\": \"Street\",\n \"addressCountry\": \"US\",\n \"addressZipCode\": \"1000\",\n \"addressLocation\": \"Location\",\n \"beneficiaryName\": \"beneficiary indicidual with US dev\",\n \"phoneCountryCode\": \"+84\",\n \"identificationType\": \"NATIONAL_ID\",\n \"identificationValue\": \"1234345445\"\n}" response = http.request(request) puts response.read_body ``` ```java Payout Beneficiary_Create new beneficiary_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/api/v1/beneficiaries") .header("Content-Type", "application/json") .body("{\n \"dob\": \"1999-03-01\",\n \"type\": \"INDIVIDUAL\",\n \"email\": \"testNiumIndividual104@gmail.com\",\n \"pspId\": \"nium\",\n \"lastName\": \"Miracle\",\n \"firstName\": \"Nigma\",\n \"customerId\": \"cus-01k0s6n7ad06fcqpwb7qrgxn02\",\n \"accountInfo\": {\n \"payId\": \"emailTest@gmail.com\",\n \"bankName\": \"Bank of America\",\n \"currency\": \"USD\",\n \"payIdType\": \"EMAIL\",\n \"proxyType\": \"MOBILE\",\n \"proxyValue\": \"+919021221212\",\n \"accountType\": \"BANK\",\n \"bankCountry\": \"US\",\n \"accountNumber\": \"318351267899\",\n \"routingCodeType1\": \"bic_swift\",\n \"routingCodeType2\": \"aba\",\n \"routingCodeValue1\": \"BOFAUS3N\",\n \"routingCodeValue2\": \"121000358\",\n \"intermediaryBicSwift\": \"intermediaryBicSwift\"\n },\n \"addressCity\": \"City\",\n \"description\": \"description\",\n \"phoneNumber\": \"0904547087\",\n \"addressState\": \"State\",\n \"relationship\": \"Employee\",\n \"addressStreet\": \"Street\",\n \"addressCountry\": \"US\",\n \"addressZipCode\": \"1000\",\n \"addressLocation\": \"Location\",\n \"beneficiaryName\": \"beneficiary indicidual with US dev\",\n \"phoneCountryCode\": \"+84\",\n \"identificationType\": \"NATIONAL_ID\",\n \"identificationValue\": \"1234345445\"\n}") .asString(); ``` ```php Payout Beneficiary_Create new beneficiary_example request('POST', 'https://https/api/v1/beneficiaries', [ 'body' => '{ "dob": "1999-03-01", "type": "INDIVIDUAL", "email": "testNiumIndividual104@gmail.com", "pspId": "nium", "lastName": "Miracle", "firstName": "Nigma", "customerId": "cus-01k0s6n7ad06fcqpwb7qrgxn02", "accountInfo": { "payId": "emailTest@gmail.com", "bankName": "Bank of America", "currency": "USD", "payIdType": "EMAIL", "proxyType": "MOBILE", "proxyValue": "+919021221212", "accountType": "BANK", "bankCountry": "US", "accountNumber": "318351267899", "routingCodeType1": "bic_swift", "routingCodeType2": "aba", "routingCodeValue1": "BOFAUS3N", "routingCodeValue2": "121000358", "intermediaryBicSwift": "intermediaryBicSwift" }, "addressCity": "City", "description": "description", "phoneNumber": "0904547087", "addressState": "State", "relationship": "Employee", "addressStreet": "Street", "addressCountry": "US", "addressZipCode": "1000", "addressLocation": "Location", "beneficiaryName": "beneficiary indicidual with US dev", "phoneCountryCode": "+84", "identificationType": "NATIONAL_ID", "identificationValue": "1234345445" }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Payout Beneficiary_Create new beneficiary_example using RestSharp; var client = new RestClient("https://https/api/v1/beneficiaries"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"dob\": \"1999-03-01\",\n \"type\": \"INDIVIDUAL\",\n \"email\": \"testNiumIndividual104@gmail.com\",\n \"pspId\": \"nium\",\n \"lastName\": \"Miracle\",\n \"firstName\": \"Nigma\",\n \"customerId\": \"cus-01k0s6n7ad06fcqpwb7qrgxn02\",\n \"accountInfo\": {\n \"payId\": \"emailTest@gmail.com\",\n \"bankName\": \"Bank of America\",\n \"currency\": \"USD\",\n \"payIdType\": \"EMAIL\",\n \"proxyType\": \"MOBILE\",\n \"proxyValue\": \"+919021221212\",\n \"accountType\": \"BANK\",\n \"bankCountry\": \"US\",\n \"accountNumber\": \"318351267899\",\n \"routingCodeType1\": \"bic_swift\",\n \"routingCodeType2\": \"aba\",\n \"routingCodeValue1\": \"BOFAUS3N\",\n \"routingCodeValue2\": \"121000358\",\n \"intermediaryBicSwift\": \"intermediaryBicSwift\"\n },\n \"addressCity\": \"City\",\n \"description\": \"description\",\n \"phoneNumber\": \"0904547087\",\n \"addressState\": \"State\",\n \"relationship\": \"Employee\",\n \"addressStreet\": \"Street\",\n \"addressCountry\": \"US\",\n \"addressZipCode\": \"1000\",\n \"addressLocation\": \"Location\",\n \"beneficiaryName\": \"beneficiary indicidual with US dev\",\n \"phoneCountryCode\": \"+84\",\n \"identificationType\": \"NATIONAL_ID\",\n \"identificationValue\": \"1234345445\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Payout Beneficiary_Create new beneficiary_example import Foundation let headers = ["Content-Type": "application/json"] let parameters = [ "dob": "1999-03-01", "type": "INDIVIDUAL", "email": "testNiumIndividual104@gmail.com", "pspId": "nium", "lastName": "Miracle", "firstName": "Nigma", "customerId": "cus-01k0s6n7ad06fcqpwb7qrgxn02", "accountInfo": [ "payId": "emailTest@gmail.com", "bankName": "Bank of America", "currency": "USD", "payIdType": "EMAIL", "proxyType": "MOBILE", "proxyValue": "+919021221212", "accountType": "BANK", "bankCountry": "US", "accountNumber": "318351267899", "routingCodeType1": "bic_swift", "routingCodeType2": "aba", "routingCodeValue1": "BOFAUS3N", "routingCodeValue2": "121000358", "intermediaryBicSwift": "intermediaryBicSwift" ], "addressCity": "City", "description": "description", "phoneNumber": "0904547087", "addressState": "State", "relationship": "Employee", "addressStreet": "Street", "addressCountry": "US", "addressZipCode": "1000", "addressLocation": "Location", "beneficiaryName": "beneficiary indicidual with US dev", "phoneCountryCode": "+84", "identificationType": "NATIONAL_ID", "identificationValue": "1234345445" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://https/api/v1/beneficiaries")! 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() ```