POST Create Beneficiary

post

https://sandbox.api.alphagroup.com/v1/beneficiaries

This endpoint allows you to create a new beneficiary. The beneficiary can be validated via the validate beneficiary endpoint and depending on the Country, Account Number, IBAN, National Bank Code and Swift may be required. The parameter Account ID is a required parameter. A successful response will return the newly created beneficiary details. In the event of an error, a failure response will be returned with problem details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request object for creating a beneficiary. Can be validated via the beneficiaries validation endpoint. Depending on the country, AccountNumber, Iban, NationalBankCode and Swift may be required.

Name

string

required

length ≥ 1

The name of the beneficiary.

FriendlyName

string | null

Friendly name of the beneficiary (RM Only)

DateOfBirth

date | null

The beneficiary's date of birth in YYYY-MM-DD format.

Postcode

string | null

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

City

string | null

Name of a built-up area, with defined boundaries, and a local government.

State

string | null

State field for address (RM Only)

AddressLine1

string | null

First address line.

AddressLine2

string | null

Second address line.

BankCountryCode

string

required

length between 2 and 2

The two letter country code of the beneficiary's bank country.

CountryCode

string

required

length between 2 and 2

The two letter country code of the beneficiary's country.

Iban

string | null

The beneficiary's bank account IBAN.

BankName

string | null

The beneficiary's bank name.

NationalBankCode

string | null

The beneficiary's bank code, e.g. UK sort code.

AccountNumber

string | null

The beneficiary's bank account number.

Swift

string | null

The beneficiary's bank account SWIFT code.

Type

enum

The beneficiary type.

Party

enum

First or Third.

EntityId

string

required

length ≥ 1

The Entity ID of the client creating the beneficiary.

Currency

string | null

The currency of the beneficiary.

Headers

Idempotency-Key

string | null

Optionally provide an idempotency key header. If an idempotency key is present and this is a duplicate request, a 409 status will be returned. A duplicate request is a request which has the same EntityId/idempotency-key pair as another recent request.

Responses

401

Unauthorized.

403

Forbidden.

404

Resource not found.

409

Matching the idempotency key within 24 hours.

201Beneficiary created successfully.

400There were errors in the request.

500Internal server error.