Tokenization

Tokenization protects sensitive card information by replacing the sensitive data with unique identification symbols, also known as tokens. Tokens retain all the essential information without compromising on security, and the gateway stores real data safely and securely in a token vault. The gateway supports Credential on File (CoF) tokenization through proprietary gateway tokenization and network tokenization.

POST/merchant/{merchantId}/token

Create or Update Token

Request for the gateway to store a payment instrument against a token, where the system generates the token ID.

Request Parameters

These are the most common properties for this request.

  • Name
    session
    Type
    object
    Description
    Session Information

Response Parameters

Required Properties for a simple request.

  • Name
    result
    Type
    enum
    Description
    A system-generated high level overall result of the operation.
    Enum Options:
    FAILUREPENDINGSUCCESSUNKNOWN
  • Name
    status
    Type
    enum
    Description
    An indicator of whether or not you can use this token in transaction requests.
    Enum Options:
    INVALIDVALID
DELETE/merchant/{merchantId}/token/{tokenid}

Delete Token

Request to delete a token.

Request Parameters

All the properties that exist for this request.

  • Name
    correlationId
    Type
    string
    Description
    A transient identifier for the request, that can be used to match the response to the request.
  • Name
    subMerchant
    Type
    object
    Description
    Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.

Response Parameters

Required Properties for a simple request.

  • Name
    result
    Type
    enum
    Description
    A system-generated high level overall result of the operation.
    Enum Options:
    FAILUREPENDINGSUCCESSUNKNOWN
GET/merchant/{merchantId}/token/{tokenid}

Retrieve Token

Request to retrieve the payment details saved against the specified token.

Request Parameters

All the properties that exist for this request.

  • Name
    correlationId
    Type
    string
    Description
    A transient identifier for the request, that can be used to match the response to the request.
  • Name
    responseControls
    Type
    object
    Description
    Container for fields that control the response returned for the request.
  • Name
    subMerchant
    Type
    object
    Description
    Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.

Response Parameters

Required Properties for a simple request.

  • Name
    result
    Type
    enum
    Description
    A system-generated high level overall result of the operation.
    Enum Options:
    FAILUREPENDINGSUCCESSUNKNOWN
  • Name
    status
    Type
    enum
    Description
    An indicator of whether or not you can use this token in transaction requests.
    Enum Options:
    INVALIDVALID
GET/merchant/{merchantId}/tokenSearch

Search Tokens

Request to find token records that match the query. If the token records span across pages, you can limit the results returned per page and retrieve the next set of results using subsequent requests.

Request Parameters

All the properties that exist for this request.

  • Name
    correlationId
    Type
    string
    Description
    A transient identifier for the request, that can be used to match the response to the request.
  • Name
    limit
    Type
    int
    Description
    The maximum number of records that you want returned in one page.
  • Name
    nextPage
    Type
    string
    Description
    Provide this field on subsequent search requests, i.e. if the query matches many records and the search results span across pages.
  • Name
    query
    Type
    string
    Description
    A JSON formatted query request that must be provided on an initial search request.
  • Name
    subMerchant
    Type
    object
    Description
    Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.

Response Parameters

Required Properties for a simple request.

  • Name
    result
    Type
    enum
    Description
    A system-generated high level overall result of the operation.
    Enum Options:
    FAILUREPENDINGSUCCESSUNKNOWN