Create Payment Destination

post

https://sandbox.leantech.me/payments/v1/destinations

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.

Body Params

branch_address

string

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.

name

string

required

The name of the legal entity that owns the account.

iban

string

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

display_name

string

required

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

address

string

required

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

city

string

required

The city that the holding financial institution is located in.

country

string

required

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

swift_code

string

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

account_number

string

required

The account number for the account.

customer_id

string

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

ifsc

string

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

transit_number

string

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

sort_code

string

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

routing_number

string

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

postal_code

string

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

currency

string

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

bank_type

string

enum

required

Defines the banking segment of the merchant’s account

Allowed:

government_identifier

object

required

A government‑issued identifier for the merchant. This is required by the UAE Open Finance specification to uniquely identify the merchant.

Response

200