Skip to main content

Get Token Status

GET 

/network-tokens/:tokenId

This endpoint retrieves the status of a network token.

The Network Tokenization SDK returns the result of the token provisioning in a promise object when the render function is executed. The integrator can handle this promise to perform additional steps. This should trigger your server (backend) to call the SmartPay API method Get Token to verify the status of the provisioned token.

Request

Path Parameters

    tokenId uuidrequired

    The ID of the token to retrieve the status for.

Header Parameters

    Content-Type stringrequired

    Must be application/json

    Accept-Language stringrequired

    Must be be en-US

    Origin stringrequired

    The origin of the request

    User-Agent stringrequired

    The client making the request

Responses

Successful response with token status.

Evaluate the response parameter status which should be:

  • ACTIVE if the token has been provisioned successfully and became available for payments
  • ERROR if the token provisioning has failed

Network token is returned in the field networkToken.tokenNumber. It can be used for cryptogram requesting during the payments.

tokenNumber, tokenReferenceIdentifier and tokenId must be stored for further requests or webhooks processing.

Schema

    tokenId uuid

    Possible values: <= 36 characters

    The unique identifier for the token.

    createdAt date-time

    Possible values: <= 30 characters

    The timestamp when the token was created.

    updatedAt date-time

    Possible values: <= 30 characters

    The timestamp when the token was last updated.

    authorizationId uuid

    Possible values: <= 36 characters

    The authorization ID associated with the token.

    tokenReferenceIdentifier uuid

    Possible values: <= 36 characters

    The reference identifier for the token.

    externalMerchantId uuid

    Possible values: <= 36 characters

    The external merchant ID associated with the token.

    status string

    Possible values: <= 6 characters, [ACTIVE, ERROR]

    The status of the token, either ACTIVE or ERROR.

    networkToken

    object

    The Network token ID is generated through Create Network token.

    extIdentifier uuid

    Possible values: <= 36 characters

    External identifier for the network token.

    tokenExpiryMonth string

    Possible values: <= 2 characters, Value must match regular expression ^(0[1-9]|1[0-2])$

    The month when the token expires.

    tokenExpiryYear string

    Possible values: <= 2 characters, Value must match regular expression ^\d{2}$

    The year when the token expires.

    tokenNumber string

    Possible values: <= 16 characters, Value must match regular expression ^\d{16}$

    The actual token number.

    tokenizedCardData

    object

    accountHolderReferenceId uuid

    Possible values: <= 36 characters

    Reference ID for the account holder.

    expiryMonth string

    Possible values: <= 2 characters, Value must match regular expression ^(0[1-9]|1[0-2])$

    The month when the card expires.

    expiryYear string

    Possible values: <= 2 characters, Value must match regular expression ^\d{2}$

    The year when the card expires.

    brand string

    The brand of the card.

    last4Digits string

    Possible values: <= 4 characters, Value must match regular expression ^\d{4}$

    The last four digits of the card number.

Loading...