v1
latestOpenAPI 3.1.02026-07-2478315484.9 KBCreate Payment Destination
Payment Destination defines the target account to which funds will be transferred. It is used when creating a Beneficiary in the user's bank via the LinkSDK, either through the .connect() flow or the .createBeneficiary() method. In Open Finance flows, the Payment Destination represents the consent beneficiary i.e. the account explicitly authorised to receive funds under the granted consent.
Request body
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 name of the legal entity that owns the account.
The IBAN of the account. This is required for all countries except for the US.
The friendly display name for the account. This is rendered in the LinkSDK when referencing the Destination.
The address of the owner of the destination bank account has registered with the bank.
The city that the holding financial institution is located in.
The three letter ISO code for the holding financial institution's country.
The SWIFT Code for the bank account - required for most international destinations
The account number for the account.
The Customer object associated with this account. This field is optional, and will designate the Destination as owned by the application if not provided.
The IFSC number for the bank account - required for international destinations in India.
The Transit Number for the bank account - required for international destinations in Canada
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 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
The currency of the destination bank account - required for international destinations in the UK or the US
Defines the banking segment of the merchant’s account
Response
The unique identifier for the Payment Destination object.
The status of the Destination
When true this Destination is automatically populated into Payment Intents where an alternative payment_destination_id is not provided.
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 name of the legal entity that owns the account.
The IBAN of the account. This is required for all countries except for the US.
The friendly display name for the account. This is rendered in the LinkSDK when referencing the Destination.
The address of the owner of the destination bank account has registered with the bank.
The city that the holding financial institution is located in.
The three letter ISO code for the holding financial institution's country.
The SWIFT Code for the bank account - required for most international destinations
The account number for the account.
The Customer object associated with this account. This field is optional, and will designate the Destination as owned by the application if not provided.
The IFSC number for the bank account - required for international destinations in India.
The Transit Number for the bank account - required for international destinations in Canada
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 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
The currency of the destination bank account - required for international destinations in the UK or the US