OPopenpayd

Create Beneficiary

Create a new parent beneficiary.

post/beneficiaries

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/beneficiaries
  • Auth
    API key in header Authorization

Request body

beneficiaryType'RETAIL' | 'CORPORATE' required

Specifies the category of the beneficiary being created. Accepted values are CORPORATE (for business entities) and RETAIL (for individual persons). Determines which additional fields are required.

friendlyNamestring required

A user-friendly label to help you easily identify this beneficiary within your environment or dashboard. Used for internal reference and display only.

companyNamestring

The registered legal name of the beneficiary company. Required when beneficiaryType is set to CORPORATE. Must match the official company registration or incorporation documents.

firstNamestring

The given (first) name of the individual beneficiary. Required when beneficiaryType is set to RETAIL.

lastNamestring

The surname or family name of the individual beneficiary. Required when beneficiaryType is set to RETAIL.

titlestring

An optional courtesy title for the individual beneficiary e.g. Mr., Ms., Dr.. Used for display or communication purposes only.

tagstring

Indicates the relationship of the beneficiary to the account holder. Accepted values are SELF (the beneficiary is the account holder) or THIRD_PARTY (the beneficiary is another individual or organisation).

Response

200

idstring
beneficiaryTypestring
tagstring
accountHolderIdstring
titlestring
firstNamestring
lastNamestring
friendlyNamestring

Example response

{
  "id": "c04a2985-2e65-4c5b-ba20-2f29a6f6c235",
  "beneficiaryType": "RETAIL",
  "tag": "SELF",
  "accountHolderId": "71a32bf6-f190-4c19-8afa-6a1679829cb7",
  "title": "Mr.",
  "firstName": "John",
  "lastName": "Doe",
  "friendlyName": "My Beneficiary"
}

Changes

No recorded changes to this operation across all 1 revision of this API.