List card subscriptions

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

subaccountId

uuid

cardId

uuid

limit

integer

1 to 100

Defaults to 25

Maximum number of items to return

offset

number

Defaults to 0

The offset to use for pagination. Identifies the position of the first item returned in the collection

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

first

object

first object

next

object

next object

prev

object

prev object

last

object

last object

_embedded

object

required

cardSubscriptions

array of objects

required

cardSubscriptions*

object

_links

object

required

_links 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.

totalItems

integer

required

Total number of card subscriptions matching the search criteria

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

``500 The server encountered an unexpected condition that prevented it from fulfilling the request

Updated about 2 months ago

* * *

ShellNodeRubyPHPPython

Bearer

xxxxxxxxxx

curl --request GET \

--url 'https://api.astrada.co/card-subscriptions?limit=25&offset=0' \

--header 'accept: application/hal+json'


xxxxxxxxxx

{ "_links": { "self": { "href": "/card-subscriptions" } }, "_embedded": { "cardSubscriptions": [ { "_links": { "self": { "href": "/card-subscriptions/75ea3c99-6bf5-4b16-8f68-0cdc43d75806" }, "card": { "href": "/cards/5dec2c49-0aa5-4683-a317-427eb5d115f3" }, "networkBulkFeed": { "href": "/network-bulk-feeds/7b3e4f12-9a8c-4d5e-b6f1-2c3d4e5f6a7b" } }, "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": "7b3e4f12-9a8c-4d5e-b6f1-2c3d4e5f6a7b", "enrollmentType": "network-bulk", "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" }, { "_links": { "self": { "href": "/card-subscriptions/c73f2da7-aa1f-4775-ad38-864b1b6f3162" }, "card": { "href": "/cards/0457c83a-8eb7-4526-b05a-dc9fb1854fe8" } }, "id": "c73f2da7-aa1f-4775-ad38-864b1b6f3162", "subaccountId": "29cb4277-b812-4137-b008-e0befa8c6a47", "cardId": "0457c83a-8eb7-4526-b05a-dc9fb1854fe8", "customerReferenceId": "0457c83a-8eb7-4526-b05a-dc9fb1854fe8", "networkBulkFeedId": "d4e5f6a7-b8c9-4d0e-a1b2-c3d4e5f6a7b8", "enrollmentType": "cardholder-single", "state": "active", "effectiveDate": "2024-10-20T14:45:00Z", "expirationDate": "2025-05-19T14:45:00Z", "createdAt": "2024-10-19T14:45:00Z", "updatedAt": "2024-10-19T14:45:00Z" }, { "_links": { "self": { "href": "/card-subscriptions/5f8e6832-97d3-4ab5-8144-9fbbbcd2b285" }, "card": { "href": "/cards/24595efb-4fe5-4c76-a7d3-8bd9d44a96cc" }, "networkBulkFeed": { "href": "/network-bulk-feeds/0a20c636-b445-4a95-a3ea-621306ed685c" } }, "id": "5f8e6832-97d3-4ab5-8144-9fbbbcd2b285", "subaccountId": "29cb4277-b812-4137-b008-e0befa8c6a47", "cardId": "24595efb-4fe5-4c76-a7d3-8bd9d44a96cc", "customerReferenceId": "0457c83a-8eb7-4526-b05a-dc9fb1854fe8", "networkBulkFeedId": "0a20c636-b445-4a95-a3ea-621306ed685c", "enrollmentType": "network-bulk", "state": "active", "effectiveDate": "2025-03-20T14:45:00Z", "expirationDate": "2029-05-19T14:45:00Z", "createdAt": "2025-03-19T14:45:00Z", "updatedAt": "2025-03-19T14:45:00Z" } ] }, "totalItems": 3 }