v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Payment Destination

Get Payment Destinations for Customer

Retrieve a list of all Payment Destinations associated with a given Customer.

get/customers/v1/{customer_id}/destinations

Path parameters

customer_idstring required

Response

idstring uuid required

The unique identifier for the Payment Destination object.

status'CONFIRMED' | 'PENDING' required

The status of the Destination

defaultstring required

When true this Destination is automatically populated into Payment Intents where an alternative payment_destination_id is not provided.

branch_addressstring

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.

namestring required

The name of the legal entity that owns the account.

ibanstring

The IBAN of the account. This is required for all countries except for the US.

display_namestring required

The friendly display name for the account. This is rendered in the LinkSDK when referencing the Destination.

addressstring required

The address of the owner of the destination bank account has registered with the bank.

citystring required

The city that the holding financial institution is located in.

countrystring required

The three letter ISO code for the holding financial institution's country.

swift_codestring

The SWIFT Code for the bank account - required for most international destinations

account_numberstring required

The account number for the account.

customer_idstring

The Customer object associated with this account. This field is optional, and will designate the Destination as owned by the application if not provided.

ifscstring

The IFSC number for the bank account - required for international destinations in India.

transit_numberstring

The Transit Number for the bank account - required for international destinations in Canada

sort_codestring

The Sort Code for the bank account - required for international destinations in the UK

routing_numberstring

The Routing Number for the bank account - required for international destinations in the US.

postal_codestring

The Postal Code of the owner of the destination bank account has registered with the bank - required for international destinations in the UK or the US

currencystring

The currency of the destination bank account - required for international destinations in the UK or the US