Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Payment Source

Get Payment Source by ID

Payment Sources are created upon successful completion of the .connect() method in the LinkSDK when payments is set as a Permission.

get/customers/v1/{customer_id}/payment-sources/{payment_source_id}

Path parameters

customer_idstring required
payment_source_idstring required

Response

idstring uuid required

The id of the Payment Source

customer_idstring uuid required

The unique identifier for the Customer that owns the Payment Source

app_idstring required

The application associated with the Payment Source

status'AWAITING_BENEFICIARY_COOL_OFF' | 'ACTIVE' required

The current status of the beneficiary. Indicates whether the Payment Destination and Payment Source channel is chargeable.

beneficiary_cool_off_expirystring date-time required

The time that the beneficiary cool down period will, or did, expire. After this time the beneficiary will be chargeable.

bank_identifierstring required

Identifier that specifies the financial institution that holds the accounts