URL Expired

The URL for this request expired after 30 days.

subscriptionId

uuid

required

accept

string

enum

Defaults to application/hal+json

Generated from available response content types

application/hal+jsonapplication/problem+json

Allowed:

application/hal+json``application/problem+json

``200 Successful operation

object

_links

object

required

self

object

required

self object

card

object

required

card object

verifications

object

The link to this card's 3-D Secure verifications (/card-verifications/3ds?cardId=). Useful when a subscription is stuck at reqSCA to inspect why verification failed.

verifications object

networkBulkFeed

object

The link to the network bulk feed associated with this card subscription, if applicable. This link may be present when the enrollmentType is network-bulk. It will not be present for subscriptions created through the cardholder-single flow.

networkBulkFeed object

bankAccount

object

The link to the bank account this subscription's card was materialized from (/bank-accounts/{bankAccountId}). Present only when the enrollmentType is bank-feed — the bank-connected analog of networkBulkFeed. Not present for cardholder-single or network-bulk subscriptions.

bankAccount object

id

uuid

required

The unique identifier of this subscription entity.

accountId

uuid

The unique identifier of the account related to this entity.

subaccountId

uuid

required

The unique identifier of the subaccount related to this entity.

cardId

uuid

required

The unique identifier of the card related to this entity.

customerReferenceId

uuid | null

An optional id in UUID format passed by the customer to associate a context with the subscription.

state

string

enum

required

State of the subscription.

active``deactivated``expired``reqSCA``failed-to-create

effectiveDate

date-time

required

Date and time when this card subscription will be activated and start receiving data, in UTC, following ISO 8601 format.

expirationDate

date-time

required

Date and time when this card subscription will become expired and stop receiving data, in UTC, following ISO 8601 format.

networkBulkFeedId

uuid | null

The unique identifier of the network bulk feed associated with this card subscription. Present when the enrollmentType is network-bulk, null otherwise. bankAccountId

uuid | null

The bank account this subscription's card was originally materialized from — present only when enrollmentType is bank-feed (the analog of networkBulkFeedId for bank-connected enrollments). This is provenance and does not re-point if a re-link later attaches the card to a successor account; the current link surface is the bank account's cardIds. enrollmentType

string

enum

required

The flow that led to the creation of the card subscription. cardholder-single refers to enrollments where cardholders themselves are responsible for inputting card data and where a single card is attempted at a time. network-bulk refers to enrollments where card data will be captured by Astrada using network data sources (eg Mastercard Smart Data) and where many cards may be attempted at once. bank-feed refers to cards materialized from a bank connection (e.g. American Express via the hosted bank-linking flow) — the bank-side analog of network-bulk, with bankAccountId as the back-reference.

cardholder-single``network-bulk``bank-feed

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.

``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 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

{
  "_links": {
    "self": {
      "href": "/card-subscriptions/75ea3c99-6bf5-4b16-8f68-0cdc43d75806"
    },
    "card": {
      "href": "/cards/5dec2c49-0aa5-4683-a317-427eb5d115f3"
    }
  },
  "id": "75ea3c99-6bf5-4b16-8f68-0cdc43d75806",
  "subaccountId": "f297d659-c13d-4219-aeaa-e10a845140a5",
  "cardId": "5dec2c49-0aa5-4683-a317-427eb5d115f3",
  "customerReferenceId": "5dec2c49-0aa5-4683-a317-427eb5d115f3",
  "networkBulkFeedId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "enrollmentType": "cardholder-single",
  "state": "active",
  "effectiveDate": "2024-12-20T14:45:00Z",
  "expirationDate": "2025-06-19T14:45:00Z",
  "createdAt": "2024-12-19T14:45:00Z",
  "updatedAt": "2024-12-19T14:45:00Z"
}