StatusLog In
API Reference and Guides

Sections

Theme switcher

/recipients

Header Parameters

idempotencystring
Max length
36
Pattern
^[a-zA-Z 0-9-_+=/]*$
Authorizationstring

Body Parameters

accountIdstring Required

The account that the recipient should be linked to.

Min length
38
Max length
100
Pattern
account_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
clientReferenceNamestring

Client reference name for the recipient.

firstNamestring

First name for the Recipient (Only for Individuals).

lastNamestring

Last name for the Recipient (Only for Individuals).

middleNamestring

Middle name for the Recipient (Only for Individuals).

recipientTypestring Required

Defines what type of entity the receipient is. This will dictate which other fields become required (ie First name is required for Individuals).

Enum values:
individualcorporate
countryOfResidencestring

Country where the individual is a legal resident. Denoted using 2 letter ISO standard for country codes.

Min length
2
Max length
2
physicalAddressobject Required

Address object representing the physical address of the recipient, not the postal address. Can use any valid combination of optional address lines.

writeOnly

Show child attributes

phoneCountryCodestring

Country calling code for the phone number of the recipient.

Min length
2
Max length
5
Pattern
^[0-9]{2,4}$
phoneNumberstring

Phone number of the recipient. Required for international payments to certain countries.

Min length
3
Max length
15
emailstring

Email address of the recipient. Required for international payments to certain countries.

Min length
3
Max length
254
dateOfBirthstring

Date of Birth of the recipient. Required for international payments to certain countries.

writeOnly
taxIdentifierstring

Relevant countries Tax identification number/reference for the recipient (both business and individual). Required for international payments to certain countries.

writeOnly
corporateNamestring

Legally registered name of the recipient. Required if type of recipient is "corporate"

corporateBusinessNamestring

Common or trading name of the recipient.

corporateRegistrationNumberstring

Registration number of the corporate based on their country of registration. Recommended if type of recipient is "corporate"

corporateCountryOfRegistrationstring

Country where the corporate is registered. Denoted using 2 letter ISO standard for country codes. Recommended if type of recipient is "corporate".

Min length
2
Max length
2
externalReferencestring

An optional value that can be passed in to later reference a related resource in the partner system.

paymentAddressesarray

Show child attributes

Response

201
Object
Successful response.

Response Attributes

itemobject

Show child attributes

400
Object
Bad Request

Response Attributes

messagestring Required
errorsarray Required

Show child attributes

401
Object
Unauthorized

Response Attributes

messagestring
errorsarray Required

Show child attributes

409
Object
Conflict

Response Attributes

messagestring
errorsarray Required

Show child attributes

500
Object
Unknown Error

Response Attributes

messagestring
errorsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?