> 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 full documentation content, see https://apidoc-v1.maniscloud.com/llms-full.txt. # 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 ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/v1/beneficiaries: post: operationId: create-new-beneficiary summary: Create new beneficiary description: >- 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 tags: - subpackage_payoutBeneficiary responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/Payout Beneficiary_Create new beneficiary_Response_200 requestBody: content: application/json: schema: type: object properties: dob: type: string format: date type: type: string email: type: string format: email pspId: type: string lastName: type: string firstName: type: string customerId: type: string accountInfo: $ref: >- #/components/schemas/ApiV1BeneficiariesPostRequestBodyContentApplicationJsonSchemaAccountInfo addressCity: type: string description: type: string phoneNumber: type: string addressState: type: string relationship: type: string addressStreet: type: string addressCountry: type: string addressZipCode: type: string addressLocation: type: string beneficiaryName: type: string phoneCountryCode: type: string identificationType: type: string identificationValue: type: string identificationCustomType: description: Any type required: - dob - type - email - pspId - lastName - firstName - customerId - accountInfo - addressCity - description - phoneNumber - addressState - relationship - addressStreet - addressCountry - addressZipCode - addressLocation - beneficiaryName - phoneCountryCode - identificationType - identificationValue servers: - url: https:/ components: schemas: ApiV1BeneficiariesPostRequestBodyContentApplicationJsonSchemaAccountInfo: type: object properties: payId: type: string format: email bankName: type: string currency: type: string payIdType: type: string proxyType: type: string proxyValue: type: string accountType: type: string bankCountry: type: string accountNumber: type: string routingCodeType1: type: string routingCodeType2: type: string routingCodeType3: description: Any type routingCodeValue1: type: string routingCodeValue2: type: string routingCodeValue3: description: Any type intermediaryBicSwift: type: string required: - payId - bankName - currency - payIdType - proxyType - proxyValue - accountType - bankCountry - accountNumber - routingCodeType1 - routingCodeType2 - routingCodeValue1 - routingCodeValue2 - intermediaryBicSwift title: ApiV1BeneficiariesPostRequestBodyContentApplicationJsonSchemaAccountInfo ApiV1BeneficiariesPostResponsesContentApplicationJsonSchemaAccountInfo: type: object properties: payId: type: string format: email bankName: type: string currency: type: string createdAt: type: string format: date-time createdBy: type: string payIdType: type: string proxyType: type: string updatedAt: type: string format: date-time updatedBy: type: string cardNumber: type: string proxyValue: type: string accountType: type: string bankCountry: type: string accountNumber: type: string routingCodeType1: type: string routingCodeType2: type: string routingCodeValue1: type: string routingCodeValue2: type: string intermediaryBicSwift: type: string required: - payId - bankName - currency - createdAt - createdBy - payIdType - proxyType - updatedAt - updatedBy - cardNumber - proxyValue - accountType - bankCountry - accountNumber - routingCodeType1 - routingCodeType2 - routingCodeValue1 - routingCodeValue2 - intermediaryBicSwift title: ApiV1BeneficiariesPostResponsesContentApplicationJsonSchemaAccountInfo Payout Beneficiary_Create new beneficiary_Response_200: type: object properties: id: type: string dob: type: string format: date type: type: string email: type: string format: email lastName: type: string createdAt: type: string format: date-time createdBy: type: string firstName: type: string updatedAt: type: string format: date-time updatedBy: type: string customerId: type: string merchantId: type: string accountInfo: $ref: >- #/components/schemas/ApiV1BeneficiariesPostResponsesContentApplicationJsonSchemaAccountInfo addressCity: type: string description: type: string phoneNumber: type: string addressState: type: string relationship: type: string addressStreet: type: string addressCountry: type: string addressZipCode: type: string addressLocation: type: string beneficiaryName: type: string phoneCountryCode: type: string pspBeneficiaries: type: array items: description: Any type identificationType: type: string identificationValue: type: string required: - id - dob - type - email - lastName - createdAt - createdBy - firstName - updatedAt - updatedBy - customerId - merchantId - accountInfo - addressCity - description - phoneNumber - addressState - relationship - addressStreet - addressCountry - addressZipCode - addressLocation - beneficiaryName - phoneCountryCode - pspBeneficiaries - identificationType - identificationValue title: Payout Beneficiary_Create new beneficiary_Response_200 ``` ## SDK Code Examples ```python 400: Bad request import requests url = "https://https/api/v1/beneficiaries" headers = {"Content-Type": "application/json"} response = requests.post(url, headers=headers) print(response.json()) ``` ```javascript 400: Bad request const url = 'https://https/api/v1/beneficiaries'; const options = {method: 'POST', headers: {'Content-Type': 'application/json'}, body: undefined}; 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) 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 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) request["Content-Type"] = 'application/json' 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") .header("Content-Type", "application/json") .asString(); ``` ```php 400: Bad request request('POST', 'https://https/api/v1/beneficiaries', [ 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp 400: Bad request using RestSharp; var client = new RestClient("https://https/api/v1/beneficiaries"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); IRestResponse response = client.Execute(request); ``` ```swift 400: Bad request import Foundation let headers = ["Content-Type": "application/json"] let request = NSMutableURLRequest(url: NSURL(string: "https://https/api/v1/beneficiaries")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers 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() ``` ```python Create nium individual beneficiary import requests url = "https://https/api/v1/beneficiaries" headers = {"Content-Type": "application/json"} response = requests.post(url, headers=headers) print(response.json()) ``` ```javascript Create nium individual beneficiary const url = 'https://https/api/v1/beneficiaries'; const options = {method: 'POST', headers: {'Content-Type': 'application/json'}, body: undefined}; 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) 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 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) request["Content-Type"] = 'application/json' 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") .header("Content-Type", "application/json") .asString(); ``` ```php Create nium individual beneficiary request('POST', 'https://https/api/v1/beneficiaries', [ 'headers' => [ 'Content-Type' => 'application/json', ], ]); 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); request.AddHeader("Content-Type", "application/json"); IRestResponse response = client.Execute(request); ``` ```swift Create nium individual beneficiary import Foundation let headers = ["Content-Type": "application/json"] let request = NSMutableURLRequest(url: NSURL(string: "https://https/api/v1/beneficiaries")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers 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() ``` ```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() ```