Retrieve bank subscription

URL Expired

The URL for this request expired after 30 days.

Bank Subscription Schema

Properties

• bankSubscriptionId
  UUID (required):
  The unique identifier of the bank subscription.

• accountId
  UUID (required):
  The unique identifier of the account that owns this subscription.

• subaccountId
  UUID (required):
  The unique identifier of the subaccount associated with this subscription.

• connectionId
  String (required):
  The provider's unique connection identifier (e.g. Plaid item ID).

• provider
  String (enum, required):
  The banking data provider for this subscription.

  Enum Value: PLAID

• institutionName
  String (required):
  The name of the connected financial institution.

• state
  String (enum, required):
  Current state of the subscription.

  Possible Values:

  • active: The connection is functioning normally.
  • error: The connection has encountered an error.
  • auth_required: The connection requires user re-authentication.
  • disconnected: The connection has been disconnected.

• webhook
  Object (required):
  Webhook configuration for this subscription.

  Properties:

  • url
    String | null (required):
    The URL where webhook events will be delivered.

  • status
    String (enum, required):
    The current status of the webhook configuration.

    Possible values:

    • pending: The webhook URL has been set but not yet confirmed by the provider.
    • confirmed: The provider has acknowledged the webhook URL.
    • none: No webhook URL has been configured.

• syncCursor
  String | null (required):
  The current transaction sync cursor for this subscription.

• createdAt
  Date-time (required):
  Date and time when this resource was created, in UTC, following ISO 8601 format.

• updatedAt
  Date-time (required):
  Date and time when this resource was last updated, in UTC, following ISO 8601 format.

Response Codes

• 200: Successful operation
• 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
• 500: The server encountered an unexpected condition that prevented it from fulfilling the request

Example CURL Request

curl --request GET \
     --url https://api.astrada.co/bank-subscriptions/bankSubscriptionId \
     --header 'accept: application/json'

Example Response

{
  "id": "e4b7c9a2-1d3f-4e8a-9c6b-5f2d7a0e8b1c",
  "accountId": "8f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "subaccountId": "1fcb895e-9217-4a6f-9d10-5a7dcef86c11",
  "connectionId": "conn_abc123def456",
  "provider": "PLAID",
  "institutionName": "Chase",
  "state": "active",
  "webhook": {
    "url": "https://example.com/webhooks/banking",
    "status": "confirmed"
  },
  "syncCursor": null,
  "createdAt": "2025-10-03T10:55:42.000Z",
  "updatedAt": "2025-10-03T10:55:42.000Z"
}