On This Page

Transient Token Format

The transient token is issued as a JSON Web Token (JWT) (RFC 7519). For information on JSON Web Tokens, see JSON Web Tokens.

The payload portion of the token is a Base64URL-encoded JSON string and contains various claims. For more information, see JSON Web Tokens.

Example: Transient Token Format

Transient Token Payload

IMPORTANT

The empty field values in the transient token indicate which fields were captured by the application without exposing you to personally identifiable information directly.

{
  "metadata" : {
    "sequenceNumber" : "1",
    "cardholderAuthenticationStatus" : false,
    "paymentType" : "PANENTRY"
  },
  "iss" : "Flex/00",
  "exp" : 1762870464,
  "type" : "gda-0.10.0",
  "iat" : 1762869564,
  "jti" : "1D4Q8FJSSZ9ASKQ9ZCJ7E13IFOITOOH2GGHY6TRZ3O28TUQ1BN8H691344C098CA",
  "content" : {
    "deviceInformation" : {
      "fingerprintSessionId" : { }
    },
    "orderInformation" : {
      "billTo" : {
        "country" : { },
        "lastName" : { },
        "firstName" : { },
        "phoneNumber" : { },
        "address1" : { },
        "postalCode" : { },
        "locality" : { },
        "buildingNumber" : { },
        "company" : {
          "name" : { }
        },
        "administrativeArea" : { },
        "email" : { }
      },
      "amountDetails" : {
        "totalAmount" : { },
        "currency" : { }
      },
      "shipTo" : {
        "firstName" : { },
        "lastName" : { },
        "country" : { },
        "address1" : { },
        "postalCode" : { },
        "locality" : { },
        "buildingNumber" : { },
        "administrativeArea" : { }
      }
    },
    "paymentInformation" : {
      "card" : {
        "expirationYear" : {
          "value" : "2027"
        },
        "number" : {
          "maskedValue" : "XXXXXXXXXXXX1111",
          "bin" : "411111"
        },
        "securityCode" : { },
        "expirationMonth" : {
          "value" : "03"
        },
        "typeSelectionIndicator" : {
          "value" : "1"
        },
        "type" : {
          "value" : "001"
        }
      }
    }
  }
}

PAN BIN in

metadata

Object

The

cardDetails

object, including the PAN BIN, is included in the transient token

metadata

when a Click to Pay network token is used as a payment method. This allows you to display information about the card on invoices and see the BIN details that are linked to the underlying card.

"metadata": {
  "cardDetails": {
    "suffix": "9876",
    "prefix": "123456",
    "expirationMonth": "MM",
    "expirationYear": "YYYY"
  }
}

Authentication Status in

metadata

Object

The

cardholderAuthenticationStatus

object is included in the

metadata

and enables you to determine if the payload is fully authenticated. When

cardholderAuthenticationStatus

is set to

true

, the payload is fully authenticated. When

cardholderAuthenticationStatus

is set to

false

, the transaction is not authenticated.

If you are using Unified Checkout with

unifiedPayment.complete()

and

consumerAuthentication

is set to

3DS

PASSKEY

in the complete mandate request, then Payer Authentication is called automatically if it is available for the selected payment method and card network. If you use a transient token to request follow-on services directly, the value of this field indicates if the transaction has been authenticated.

"metadata": {
  "cardholderAuthenticationStatus": "true"
  }
}

Apple Pay Status in

metadata

Object

The

paymentTypeDetails.APPLEPAY

object in the transient token

metadata

contains additional data about the card that is linked to the Apple Pay transaction, such as the card

displayName

network

, and

type

To inspect this data before you complete the payment, you must set

autoProcessing

false

when you create the checkout. When

autoProcessing

is set to

false

, you can retrieve the transient token and review its contents before you call

unifiedPayment.complete()

{
  "metadata": {
    "paymentType": "APPLEPAY",
    "paymentTypeDetails": {
      "APPLEPAY": {
        "displayName": "Visa 1234",
        "network": "Visa",
        "type": "credit"      }
    }
  }
}