/recipients
Header Parameters
Body Parameters
The account that the recipient should be linked to.
Client reference name for the recipient.
First name for the Recipient (Only for Individuals).
Last name for the Recipient (Only for Individuals).
Middle name for the Recipient (Only for Individuals).
Defines what type of entity the receipient is. This will dictate which other fields become required (ie First name is required for Individuals).
individualcorporateCountry where the individual is a legal resident. Denoted using 2 letter ISO standard for country codes.
Address object representing the physical address of the recipient, not the postal address. Can use any valid combination of optional address lines.
Show child attributes
Country calling code for the phone number of the recipient.
Phone number of the recipient. Required for international payments to certain countries.
Email address of the recipient. Required for international payments to certain countries.
Date of Birth of the recipient. Required for international payments to certain countries.
Relevant countries Tax identification number/reference for the recipient (both business and individual). Required for international payments to certain countries.
Legally registered name of the recipient. Required if type of recipient is "corporate"
Common or trading name of the recipient.
Registration number of the corporate based on their country of registration. Recommended if type of recipient is "corporate"
Country where the corporate is registered. Denoted using 2 letter ISO standard for country codes. Recommended if type of recipient is "corporate".
An optional value that can be passed in to later reference a related resource in the partner system.