The Recipient object
Description
A Recipient represents the beneficiary and the beneficiary account (typically a bank account) of a payout.
The new set of Recipient endpoints replaces the legacy Bank Account endpoints, including bank account types.
Each recipient can be used for one combination of a payout method and currency, which together determine the account details required.
The Recipients feature also provides endpoints for you to:
- Dynamically retrieve the schema of a Recipient
- Validate a user’s data in advance of registering the account
Recipient registration for payouts also systematically requires SCA, thereby enabling the payout request benefit from an SCA exemption as a trusted beneficiary.
For more details, see the Recipients guide.
Attributes
The Recipient object is returned by the POST Create a Recipient and GET View a Recipient endpoints. The GET List recipients for a User endpoint returns a condensed RecipientListItem.