The Token object Preview

Attributes

id string Unique identifier for the object.
object string, value is "issuing.token" String representing the object’s type. Objects of the same type share the same value.
card string Expandable Card associated with this token.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
device _ fingerprint nullable string The hashed ID derived from the device ID from the card network associated with the token.
last4 nullable string The last four digits of the token.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
network enum The token service provider / card network associated with the token. Possible enum values mastercard Mastercard token service provider. visa Visa token service provider.
network _ data nullable object Preview feature Includable Additional details obtained from the network about the token, primarily related to the token creation process. For security reasons, this is only available to view in the first 24 hours after token creation, based on the created value, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a token” endpoint and “Update a token status” endpoint.
network _ updated _ at timestamp Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.
status enum The usage state of the token. Possible enum values active Token is provisioned and usable for payments. deleted Terminal state. Token can no longer be used. requested Token has been requested to be provisioned, but has not completed the activation process. suspended Token temporarily cannot be used for payments.
wallet _ provider nullable enum The digital wallet for this token, if one was used. Possible enum values apple_pay Apple Pay. google_pay Google Pay. samsung_pay Samsung Pay.

The Token object

{ "id": "intok_1MzDbE2eZvKYlo2C26a98MDg", "object": "issuing.token", "card": "ic_1MytUz2eZvKYlo2CZCn5fuvZ", "created": 1682059060, "network_updated_at": 1682059060, "livemode": false, "status": "active", "last4": "2424", "token_service_provider": "visa", "wallet_provider": "apple_pay", "device_fingerprint": "intd_1MzDbE2eZvKYcp3095svdf"}

Update a token status

POST / v1 / issuing / tokens /:id

Attempts to update the specified Issuing Token object to the status specified.

Parameters

status enum Required Specifies which status the token should be updated to. Possible enum values active Token is provisioned and usable for payments. deleted Terminal state. Token can no longer be used. suspended Token temporarily cannot be used for payments.

Returns

Returns an updated Issuing Token object if a valid identifier was provided.

Response

{ "id": "intok_1MzDbE2eZvKYlo2C26a98MDg", "object": "issuing.token", "card": "ic_1MytUz2eZvKYlo2CZCn5fuvZ", "created": 1682059060, "network_updated_at": 1682059060, "livemode": false, "status": "suspended", "last4": "2424", "token_service_provider": "visa", "wallet_provider": "apple_pay", "device_fingerprint": "intd_1MzDbE2eZvKYcp3095svdf"}

Retrieve an issuing token

GET / v1 / issuing / tokens /:id

Retrieves an Issuing Token object.

Parameters

No parameters.

Returns

Returns an Issuing Token object if a valid identifier was provided.

Response

{ "id": "intok_1MzDbE2eZvKYlo2C26a98MDg", "object": "issuing.token", "card": "ic_1MytUz2eZvKYlo2CZCn5fuvZ", "created": 1682059060, "network_updated_at": 1682059060, "livemode": false, "status": "active", "last4": "2424", "token_service_provider": "visa", "wallet_provider": "apple_pay", "device_fingerprint": "intd_1MzDbE2eZvKYcp3095svdf"}