Creates a new beneficiary.

The authorisation requirements for a new beneficiary depend on each merchant's settings. By
default new beneficiaries do not require authorisation before being enabled.

Authorization: End user token is required.

User permissions required: CanCreateBeneficiaries

Body Params

The beneficiary to create.

uuid
uuid
required

Gets or Sets the merchant id.

sourceAccountIDs
array of uuids | null
sourceAccountIDs
string
required
length ≥ 1

The descriptive name for the beneficiary.

string
enum
required

Gets or Sets the currency.

destination
object
required
string | null

Optional reference that will be used by default as TheirReference when creating payouts to this beneficiary
if no TheirReference is specified for the payout.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

201

The newly created beneficiary.

409

Beneficiary already exists for this merchant.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json