AccountDetails

    • This document describes data structures related to user payment card information.

    • It defines two ways to represent card details: card for physical cards and paymentToken for tokenized cards.

    • PaymentToken stores tokenized card data, including name, account number, and optional expiry and cryptogram.

    • Both representations are part of the account_representation field, which is required.

    Contains data related to the user's payment card.

    JSON representation 
     { 
 // Union field account_representation 
can be only one of the following: 
 "card" 
 : 
 { 
 object (  Card 
 
) 
 } 
 , 
 "paymentToken" 
 : 
 { 
 object (  PaymentToken 
 
) 
 } 
 // End of list of possible types for union field account_representation 
. 
 }
    Fields
    card

    object ( Card )

    Representation of a card in its physical format (i.e. the FPAN).

    paymentToken

    object ( PaymentToken )

    Representation of a card that has been tokenized by the network.

    PaymentToken

    The representation of a card after it has been tokenized by the network.

    JSON representation 
     { 
 "nameOnCard" 
 : 
 string 
 , 
 "paymentTokenAccountNumber" 
 : 
 string 
 , 
 "expiryMonth" 
 : 
 string 
 , 
 "expiryYear" 
 : 
 string 
 , 
 "cryptogram" 
 : 
 string 
 , 
 // Union field token_type 
can be only one of the following: 
 "tokenTypeDeviceToken" 
 : 
 { 
 object (  Empty 
 
) 
 } 
 , 
 "tokenTypeMerchantToken" 
 : 
 { 
 object (  Empty 
 
) 
 } 
 , 
 "tokenTypeUnsupported" 
 : 
 { 
 object (  Empty 
 
) 
 } 
 , 
 "tokenTypeNotApplicable" 
 : 
 { 
 object (  Empty 
 
) 
 } 
 // End of list of possible types for union field token_type 
. 
 }
    Fields
    nameOnCard

    string

    REQUIRED: The customer's name as it appears on the card.

    expiryMonth

    string

    OPTIONAL: Expiration month, formatted MM .

    expiryYear

    string

    OPTIONAL: Expiration year, formatted YY .

    cryptogram

    string

    OPTIONAL: The single-use key generated by the token provider for the transaction.

    Union field token_type . REQUIRED: The type of token. token_type can be only one of the following:
    tokenTypeDeviceToken

    object ( Empty )

    The token is bound to a device. It is represented by a DPAN and was generated by the user going through a SCA (Strong Customer Authentication) / Step Up flow.

    tokenTypeMerchantToken

    object ( Empty )

    The token is bound to a merchant. It could be used while the user is offline and might be accompanied by additional, transaction time authentication details, such as 3DS2.

    tokenTypeUnsupported

    object ( Empty )

    Unsupported token type.

    tokenTypeNotApplicable

    object ( Empty )

    Payment token type is not applicable. Not passed in the request.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: