v1
latestOpenAPI 3.1.02026-07-2478315484.9 KBCreate Payouts Destination(s)
Create payment destinations for use with Payouts. Destinations created with Payouts create a corresponding beneficiary with your bank.
Request body
Uniquely identifies the bank of the benefeciary account
The name of the legal entity associated with the account.
The IBAN of the account
The friendly display name for the account.
The account number for the account.
The SWIFT Code for the bank account - required for most international destinations
The IFSC number for the bank account - required for international destinations in India.
The Sort Code for the bank account - required for international destinations in the UK
The Routing Number for the bank account - required for international destinations in the US.
The Transit Number for the bank account - required for international destinations in Canada
The address of the owner of the destination bank account has registered with the bank.
The address of the branch that holds the account - required for all beneficiaries outside of ARE. This should be a single string with commas separating lines.
The country that the holding financial institution is located in as a 3 letter ISO code.
The city that the holding financial institution is located in.
The associated Lean Customer
The currency of the payee account
The postal code of the bank branch that holds the account
Response
The unique ID to track the destination creation request. This is useful for debugging
The unique identifier for the Payment Destination object.
IBAN of the destination account
The account number for the account.
The friendly display name for the account.
Specifies the status of the destination
Error meesage received from the bank