POST/v2/beneficiary/create

Create Beneficiary

Creates a beneficiary required for outbound transfers. Use the examples for beneficiaries with or without a virtual account. Note: If you include Beneficiary_Document in the request and Virtual Account is enabled on your account, a virtual account is created automatically.

Headers

Field	Type	Required	Possible values	Description
`Authorization`	string	Required	Bearer {SessionToken}	Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request.

Request body

Field	Type	Required	Possible values	Description
`fields`	textarea	Required	[{ "field": "FieldName", "value": "..." }]	Use Get Required Fields (Create Beneficiary) (POST /v2/beneficiary/get-required-fields) endpoint to get the field values.

Example request

[
  {
    "field": "Beneficiary_Type",
    "value": "individual"
  },
  {
    "field": "Beneficiary_Email",
    "value": "john6@mailinator.com"
  },
  {
    "field": "Beneficiary_Address",
    "value": "1437 VIP Road"
  …

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 301 \| 503 \| 422	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	ID of the newly created beneficiary.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "BeneficiaryId": "4934710774492212995"
  }
}

Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.