Network Token Statuses – Spreedly Help Center

One of the benefits of Network Tokens is that they receive proactive updates to their status and metadata. As a result, Network Tokens have a status from the moment a token is requested until they are deleted. These statuses dictate if a network token and its underlying PAN can be used for a transaction. The following is a list of token statuses are their meanings.

Inactive

The token has been requested but the token has not yet been activated.

Active

The Network Token is ready for transactions.

Suspended

The Network Token is suspended and unable to transact. Issuing banks can suspend individual tokens if there is an issue with fraud or if the cardholder locks the card.

Deactivated/Deleted

Depending on the network, a network token can be in a deactivated or deleted status after it has been permanently deleted by the issuing bank or by the merchant. Issuing banks will delete a token if the account is closed.

Null

The most common cause for a 'null' status is we're awaiting a response from the network after first requesting the network token. Often this will resolve itself in 4-5 seconds. If you notice an abundance of `null` status network tokens, please contact Spreedly and we'll investigate.

How can I view a network token's status?

You can view a network token status by using the Show API call on any payment method that has been tokenized. The same response is also available with the List API.

If the payment method has a network token associated with it, it will return a network token object in the response as seen in the example below. Otherwise, if there is no network token associated with the payment method, the response will not return the network token object.

{
    "payment_method": {
        "token": "GYxUicC6gSeFMgMas2s8U00AZ96",
        "created_at": "2021-05-14T19:19:49Z",
        "updated_at": "2021-05-14T19:19:50Z",
        "email": null,
        "data": null,
        "storage_state": "retained",
        "test": false,
        "metadata": null,
        "callback_url": null,
        "last_four_digits": "3216",
        "first_six_digits": "520424",
        "card_type": "master",
        "first_name": "Test",
        "last_name": "Test",
        "month": 1,
        "year": 2023,
        "address1": null,
        "address2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null,
        "phone_number": null,
        "company": null,
        "full_name": "Test Test",
        "eligible_for_card_updater": true,
        "shipping_address1": null,
        "shipping_address2": null,
        "shipping_city": null,
        "shipping_state": null,
        "shipping_zip": null,
        "shipping_country": null,
        "shipping_phone_number": null,
        "payment_method_type": "credit_card",
        "errors": [],
        "network_token": {
            "status": "ACTIVE"
        },
        "fingerprint": "f9efaf874494bf8e322c443b1bf19ad6e37a",
        "verification_value": "",
        "number": "XXXX-XXXX-XXXX-3216"
    }
}

Articles in this section