Guest Checkout Tokenization

To learn more about Guest Checkout Tokenization, please visit Guest Checkout Tokenization

The following JSON document represents an example of a request and response with minimal set of elements:

Endpoint: POST https://test.ipg-online.com/ipgrestapi/v2/services/payment-tokens/guestcheckoutTokencryptogram



{
    "storeId": "331164004",
    "paymentMethod": {
        "paymentCard": {
            "number": "489538xxxxxx2363",
            "securityCode": "123",
            "expiryDate": {
                "month": "12",
                "year": "28"
            },
            "brand": "VISA"
        }
    },
    "transactionAmount": {
        "total": "12.34",
        "currency": "INR"
    }
}

{
    "type": "getGuestCheckoutTokenCryptogramResponse",
    "clientRequestId": "2838649",
    "apiTraceId": "aCG9jpKkLakp4ZX7ql8s-AAAAwY",
    "requestStatus": "SUCCESS",
    "requestTime": 1747041678391,
    "guestCheckoutToken": {
        "value": "4895370019776555",
        "expiryMonth": "12",
        "expiryYear": "24",
        "cardLast4": "6555",
        "brand": "VISA",
        "guestCheckoutcryptogram": "AwAAAAABpSrvk/gAABFcgnIAAAA=",
        "paymentAccountReferenceNumber": "V0010013018285637880259595866"
    }
}

The table below represents the full list of parameters under guestCheckoutToken object:

Field name	Description
`value`	Guest checkout token number
`expiryMonth`	Guest checkout token expiry month
`expiryYear`	Guest checkout token expiry year
`cardLast4`	Last four digits of the original Card Number represented by the guest checkout token
`brand`	Available values: "AMEX" "MASTERCARD" "VISA"
`guestCheckoutcryptogram`	Guest checkout token cryptogram as assigned by a scheme.
`paymentAccountReferenceNumber`	Payment account reference as assigned by a scheme.

The data received in response can be used to initiate a sale or preauthorisation request.

The following table describes the most important objects for the initiation of a sale or preauthorization:

Field name	M/O/C	Description
`paymentCard.number`	M	Value from `GuestCheckoutToken.value` retrieved in the response from Guest Checkout Tokenization call
`paymentCard.securityCode`	M	Real card security code from the card
`paymentCaard.expiryDate`	M	Value from `guestCheckoutToken.expiryMonth` and `guestCheckoutToken.expiryYear`retrieved in the response from Guest Checkout Tokenization call
`order.tokenCryptogram`	M	Value from `guestCheckoutToken.guestCheckoutcryptogram` retrieved in the response from Guest Checkout Tokenization call
`paymentAccountReferenceNumber`	O	Value from `guestCheckoutToken.paymentAccountReferenceNumber` retrieved in the response from Guest Checkout Tokenization call. (recommended to be to sent)

The following JSON document represents an example of a request and a response with minimal set of elements:

Endpoint: POST .../services/payments/

{
    "requestType": "PaymentCardSaleTransaction",
    "storeId": "331164004",
    "transactionAmount": {
        "total": "19.50",
        "currency": "INR"
    },
    "paymentMethod": {
        "paymentCard": {
            "number": "48953xxxxxx76555",
            "securityCode": "123",
            "expiryDate": {
                "month": "12",
                "year": "28"
            }
        }
    },
    "authenticationResult": {
        "authenticationType": "Secure3D21AuthenticationResult",
        "transactionId": "c3c40592-b50d-4415-b54a-023a7dd24d51",
        "authenticationResponse": "Y",
        "cavv": "AAAAAAAAAAAAAAAAAAAAAAAAAAA=",
        "transactionStatus": "Y"
    },
    "order": {
        "tokenCryptogram": "AGX1lvbYlypcAAFHV22IGgADFA==",
        "paymentAccountReferenceNumber": "V0010013018285637880259595866"
    }
    
}

{
    "type": "transactionResponse",
    "clientRequestId": "2838649",
    "apiTraceId": "aCG_mt4SskPW7z6dl3j6TAAAA34",
    "ipgTransactionId": "85032634336",
    "orderId": "R-8cbe2dd4-f05f-xxxx-a8ea-ee2120a95049",
    "transactionType": "SALE",
    "paymentToken": {
        "reusable": true,
        "declineDuplicates": false,
        "brand": "VISA",
        "type": "PAYMENT_CARD"
    },
    "transactionOrigin": "ECOM",
    "paymentMethodDetails": {
        "paymentCard": {
            "expiryDate": {
                "month": "12",
                "year": "2030"
            },
            "bin": "489537",
            "last4": "6555",
            "brand": "VISA"
        },
        "paymentMethodType": "PAYMENT_CARD",
        "paymentMethodBrand": "VISA"
    },
    "country": "Argentina",
    "terminalId": "0000xx15",
    "merchantId": "470000xxx001125",
    "transactionTime": 1747042202,
    "approvedAmount": {
        "total": 19.50,
        "currency": "INR",
        "components": {
            "subtotal": 19.50
        }
    },
    "transactionAmount": {
        "total": 19.50,
        "currency": "INR",
        "components": {
            "subtotal": 19.50
        }
    },
    "transactionStatus": "APPROVED",
    "approvalCode": "Y:146071:5032634336:PPX :513209044125",
    "secure3dResponse": {
        "responseCode3dSecure": "1"
    },
    "processor": {
        "referenceNumber": "513209044125",
        "authorizationCode": "146071",
        "responseCode": "00",
        "responseMessage": "Function performed error-free",
        "avsResponse": {
            "streetMatch": "NO_INPUT_DATA",
            "postalCodeMatch": "NO_INPUT_DATA"
        },
        "taxRefundData": {}
    }
}

API Products

Point of Sale

Developer

Resources