Menu

Vantiv OmniTokens

Vantiv OmniToken examples are shown below. Each example includes a request and a response.


Headers

Include theTMS-specific headersin all of your requests.

Tokenize card

Tokenize card request and response examples are shown below.

  • expirationDate and cvv2 are optional.

Request

Copied!
{
    "token": {
        "payloadType": "Card"
    },
    "cardDetails": {
        "cardNumber": "4111111111111111",
        "cvv2": "1234",
        "expirationDate": "12/20"
    },
    "outputTokenProviderProfileIds": [
        "Your_Vantiv_Profile"
    ]
}

Response

Copied!
{
    "tokens": [
        {
            "statusCode": "100",
            "tokenProvider": "Vantiv Token Provider",
            "profileId": "Your_Vantiv_Profile",
            "value": "4111116905781111",
            "payloadType": "Card",
            "tokenProviderRefId": "1f11a103-d28c-4d6e-9ccf-99e97d49143d",
            "isNewlyCreated": false
        }
    ],
    "statusCode": "100",
    "requestId": "nOCX0eui2UaziAMlrB56g"
}

Detokenize card

Detokenize card request and response examples are shown below.

  • Query parameters &includeCvv2=true and &includeExpirationDate=true are optional.
  • If provided in the request, they will return expirationDate and/or cvv2.

Request

GET https://cert-tesapi.paymetric.com/api/tokens/4111116905781111?profileId=Your_Vantiv_Profile&payloadType=Card&includeCvv2=true&includeExpirationDate=true

Response

Copied!
{
    "cardDetails": {
        "cardNumber": "4111111111111111",
        "expirationDate": "12/20",
        "cvV2": "1234"
    },
    "statusCode": "100",
    "requestId": "O8AyvftfkqTka8yiTbU3A"
}

Tokenize eCheck

Tokenize eCheck request and response examples are shown below. Values are case sensitive.

Valid values for accountType include the following:

  • personal checking
  • personal savings
  • business checking
  • business savings

Request

Copied!
{
    "token": {
        "payloadType": "eCheck"
    },
    "eCheckDetails": {
        "accountNumber": "12345",
        "routingNumber": "123456789",
        "accountType": "personal checking"
    },
    "outputTokenProviderProfileIds": [
        "Your_Vantiv_Profile"
    ]
}

Response

Copied!
{
    "tokens": [
        {
            "statusCode": "100",
            "tokenProvider": "Vantiv Token Provider",
            "profileId": "Your_Vantiv_Profile",
            "value": "23090241879153850",
            "payloadType": "eCheck",
            "tokenProviderRefId": "d7d72b85-ade2-4a29-a519-ed1fd4ee7c4e",
            "isNewlyCreated": false
        }
    ],
    "statusCode": "100",
    "requestId": "Rl641UchpUK5jPxy0QC4A"
}

Detokenize eCheck

Detokenize eCheck request and response examples are shown below.

Request

GET https://cert-tesapi.paymetric.com/api/tokens/23090241879153850?profileId=Your_Vantiv_Profile&payloadType=eCheck

Response

Copied!
{
    "eCheckDetails": {
        "accountType": "personal checking",
        "routingNumber": "123456789",
        "accountNumber": "12345"
    },
    "statusCode": "100",
    "requestId": "GV9qmFyKr0yqFA1cLQWZOw"
}