Complete bank link

URL Expired

The URL for this request expired after 30 days.

Bank link completion request

• bankLinkId
  string, required, length between 1 and 256, ^[a-zA-Z0-9_-]+$

  • The client-provided identifier of the bank link.

• state
  string, enum, required

  • The target state for the bank link. Only completed is accepted.

Allowed: completed

• accept
  string, enum, Defaults to application/json

  • Generated from available response content types

    Allowed: application/json, application/problem+json

Response

{
  "_links": {
    "self": {
      "href": "/bank-links/enrollment_792dcb7d"
    },
    "bankAccounts": [
      {
        "href": "/bank-accounts/3a8f2c1d-5e7b-4d9a-b6c8-9f0e1d2a3b4c"
      }
    ]
  },
  "id": "enrollment_792dcb7d",
  "accountId": "8f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "subaccountId": "1fcb895e-9217-4a6f-9d10-5a7dcef86c11",
  "state": "completed",
  "hostedLink": null,
  "linkExpiresAt": null,
  "completedAt": "2025-10-03T10:55:42.000Z",
  "bankAccounts": [
    {
      "id": "3a8f2c1d-5e7b-4d9a-b6c8-9f0e1d2a3b4c",
      "name": "Checking"
    }
  ],
  "createdAt": "2025-10-03T10:25:27.069Z"
}

Status Codes

• 200 - Bank link completed
• 400 - The server cannot or will not process the request due to something that is perceived to be a client error
• 401 - Authentication credentials were either missing or incorrect
• 403 - Authentication credentials used do not have permissions to perform the request
• 404 - The requested resource was not found on the server
• 409 - Request conflict with the current state of the target resource
• 500 - The server encountered an unexpected condition that prevented it from fulfilling the request

Example Request

curl --request PATCH \
     --url https://api.astrada.co/bank-links/bankLinkId \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "state": "completed"
}'