This API is used to check a bank linking session and save the account when it is done.

Poll it every few seconds after the customer returns. When successful is true, the bank account is saved to the customer and returned in payment_method (its id is the payment_method_id for Transfer out).

Note: Calling it again after success returns the same account; it is not saved twice.

URL

{{interface_url}}/{{version}}/customers/{{customer_id}}/bank-linking-sessions/{{session_id}}?location_id={{location_id}}

Method

GET

Headers

Authorization: Bearer {access_token} (or Api-Key)

Request Parameters

None.

URL Parameters

Example Request (cURL)

curl --location '{{interface_url}}/{{version}}/customers/{{customer_id}}/bank-linking-sessions/{{session_id}}?location_id={{location_id}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}'

Example Response (JSON) — 200

{
  "session_id": 123,
  "location_id": 279685,
  "status": "vaulted",
  "result": "success",
  "completed": true,
  "successful": true,
  "expires_at": "2026-11-05T18:46:18Z",
  "error": null,
  "payment_method": {
    "id": 90312,
    "type": "ach",
    "location_id": 279685,
    "holder": "Ana Garcia",
    "default": false,
    "created_at": "2026-11-05T18:20:02Z",
    "bank_name": "Chase",
    "account_last4": "6789",
    "routing_last4": "0021"
  }
}

Error Responses

Format: { "error": { "code", "name", "message", "details" } }