Retrieve card subscription

get https://api.astrada.co/card-subscriptions/{subscriptionId}

Returns detailed information about a specific card subscription by its identifier, including its data-sharing state.

Responses

Response body

object

_links

object

required

self

object

required

card

object

required

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

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 following ISO 8601 format.

expirationDate

date-time

required

Date and Time when this card subscription will become expired and stop receiving data following ISO 8601 format.

enrollmentType

string

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.

cardholder-single network-bulk

createdAt

date-time

required

Date and Time at which this entity was created following ISO 8601 format.

updatedAt

date-time

required

Date and Time at which this entity was last updated following ISO 8601 format.

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.astrada.co/card-subscriptions/subscriptionId \
3
     --header 'accept: application/hal+json'


xxxxxxxxxx
20
 
1
{
2
  "_links": {
3
    "self": {
4
      "href": "/card-subscriptions/75ea3c99-6bf5-4b16-8f68-0cdc43d75806"
5
    },
6
    "card": {
7
      "href": "/cards/5dec2c49-0aa5-4683-a317-427eb5d115f3"
8
    }
9
  },
10
  "id": "75ea3c99-6bf5-4b16-8f68-0cdc43d75806",
11
  "subaccountId": "f297d659-c13d-4219-aeaa-e10a845140a5",
12
  "cardId": "5dec2c49-0aa5-4683-a317-427eb5d115f3",
13
  "customerReferenceId": "5dec2c49-0aa5-4683-a317-427eb5d115f3",
14
  "enrollmentType": "cardholder-single",
15
  "state": "active",
16
  "effectiveDate": "2024-12-20T14:45:00Z",
17
  "expirationDate": "2025-06-19T14:45:00Z",
18
  "createdAt": "2024-12-19T14:45:00Z",
19
  "updatedAt": "2024-12-19T14:45:00Z"
20
}

200Successful operation

400The server cannot or will not process the request due to something that is perceived to be a client error

401Authentication credentials were either missing or incorrect

403Authentication credentials used do not have have permissions to perform the request

404The requested resource was not found on the server

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