Guest Checkout Tokenization

To learn more about Guest Checkout Tokenization please visit: link

The following XML document represents an example of a request with minimal set of elements, as well as an example of a response in the second tab:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ipg="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
    <soapenv:Header/>
    <soapenv:Body>
        <ns4:IPGApiActionRequest
xmlns:ns4="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:ns2="http://ipg-online.com/ipgapi/schemas/a1" xmlns:ns3="http://ipg-online.com/ipgapi/schemas/v1">
            <ns2:Action>
                <ns2:GetGuestCheckoutTokenCryptogram>
                    <ns2:StoreId>331164004</ns2:StoreId>
                    <ns2:CreditCardData>
                        <ns3:CardNumber>4895********2363</ns3:CardNumber>
                        <ns3:ExpMonth>12</ns3:ExpMonth>
                        <ns3:ExpYear>28</ns3:ExpYear>
                        <ns3:CardCodeValue>123</ns3:CardCodeValue>
                        <ns3:Brand>VISA</ns3:Brand>
                    </ns2:CreditCardData>
                    <ns3:Payment>
                        <ns3:ChargeTotal>16.98</ns3:ChargeTotal>
                        <ns3:Currency>INR</ns3:Currency>
                    </ns3:Payment>
                </ns2:GetGuestCheckoutTokenCryptogram>
            </ns2:Action>
        </ns4:IPGApiActionRequest>
    </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ipgapi:IPGApiActionResponse xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
           <ipgapi:successfully>true</ipgapi:successfully>
           <ipgapi:GuestCheckoutTokenData>
             <v1:GuestCheckoutTokenNumber>4769*****7926</v1:GuestCheckoutTokenNumber>
             <v1:ExpMonth>12</v1:ExpMonth>
             <v1:ExpYear>2028</v1:ExpYear>
             <v1:CardLast4>2363</v1:CardLast4>
             <v1:Brand>VISA</v1:Brand>
             <v1:GuestCheckoutTokenCryptogram>AgAAAAD1R+1oMTv2HNIIQRAAAAA=</v1:GuestCheckoutTokenCryptogram>
             <v1:PaymentAccountReferenceNumber>V0010013018285637880259595866 </v1:PaymentAccountReferenceNumber>
            </ipgapi:GuestCheckoutTokenData>
        </ipgapi:IPGApiActionResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The table below represents the full list of parameters related to this functionality:

Path/Name	XML Schema type	Description
v1:GuestCheckoutTokenData/ v1: GuestCheckoutTokenNumber/	xs:string [0-9]{13,19}	Guest checkout token number
v1:GuestCheckoutTokenData/ v1:ExpMonth	xs:string	Guest checkout token expiry month
v1:GuestCheckoutTokenData/ v1:ExpYear	xs:string [0-9]{2}	Guest checkout token expiry year
v1:GuestCheckoutTokenData/ v1:CardLast4	xs:string \d{4}	Last four digits of the original Card Number represented by the guest checkout token
v1:GuestCheckoutTokenData/ v1:Brand	xs:string	Available values: "AMEX" "MASTERCARD" "VISA"
v1: GuestCheckoutTokenData/ v1: GuestCheckoutTokenCryptogram	xs:string minLength value="20 maxLength value="255"	Guest checkout token cryptogram as assigned by a scheme.
v1: GuestCheckoutTokenData/ v1: PaymentAccountReferenceNumber	xs:string maxLength value="30"	Payment account reference as assigned by a scheme.

The data received in API action response can be used to trigger a sale or preauthorization.

A payment transaction using Alt id token can be initiated by submitting the GuestCheckoutTokenNumber you received in previous API response as a value of the element CardNumber and the expiry date of the credit card replaced by the Guest checkout token expiry (ExpMonth). It is important to include the GuestCheckoutTokenCryptogram in the request as well. And it is also suggested to send the PaymentAccountReferenceNumber in all sale or preauthorization requests.

The following XML document represents an example of a request with minimal set of elements, as well as an example of a response in the second tab:

SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ipg:IPGApiOrderRequest xmlns:ipg="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
            <v1:Transaction>
                <v1:CreditCardTxType>
                    <v1:StoreId>331164004</v1:StoreId>
                    <v1:Type>sale</v1:Type>
                </v1:CreditCardTxType>
                <v1:CreditCardData>
                    <v1:CardNumber>489537XXXXXX6555</v1:CardNumber>
                    <v1:ExpMonth>12</v1:ExpMonth>
                    <v1:ExpYear>28</v1:ExpYear>
                    <v1:CardCodeValue>123</v1:CardCodeValue>
                </v1:CreditCardData>
                <v1:CreditCard3DSecure>
                    <v1:AuthenticationValue>AAABBWcSNIdjeUZThmNHAAAAAAA=</v1:AuthenticationValue>
                    <v1:Secure3D2TransactionStatus>Y</v1:Secure3D2TransactionStatus>
                    <v1:Secure3D2AuthenticationResponse>Y</v1:Secure3D2AuthenticationResponse>
                    <v1:Secure3DProtocolVersion>2.2.0</v1:Secure3DProtocolVersion>
                    <v1:DirectoryServerTransactionId>25a0317-9143-5130-8000-00</v1:DirectoryServerTransactionId>
                    <v1:ThreeDSServerTransactionId>925a0317-9143-5130-8000-0000000f8741</v1:ThreeDSServerTransactionId>
                    <v1:XID>lHIKE0y+R83SCIkrxanJkF5uzjQ=</v1:XID>
                </v1:CreditCard3DSecure>
                <v1:TokenCryptogram>/wAAAAACbEj8E1pvNR2SQIQAAAA=</v1:TokenCryptogram>
                <v1:PaymentAccountReferenceNumber>V0010013018285637880259595866</v1:PaymentAccountReferenceNumber>
                <v1:Payment>
                    <v1:ChargeTotal>16.98</v1:ChargeTotal>
                    <v1:Currency>INR</v1:Currency>
                </v1:Payment>
            </v1:Transaction>
        </ipg:IPGApiOrderRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ipgapi:IPGApiOrderResponse xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
            <ipgapi:ApprovalCode>Y:364169:5032633453:PPX :513206044009</ipgapi:ApprovalCode>
            <ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
            <ipgapi:Brand>VISA</ipgapi:Brand>
            <ipgapi:Country>ARG</ipgapi:Country>
            <ipgapi:CommercialServiceProvider>IMS</ipgapi:CommercialServiceProvider>
            <ipgapi:OrderId>A-285c2b3d-3e8d-4776-812b-7076cd1db412</ipgapi:OrderId>
            <ipgapi:IpgTransactionId>85032633453</ipgapi:IpgTransactionId>
            <ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>
            <ipgapi:ProcessorApprovalCode>364169</ipgapi:ProcessorApprovalCode>
            <ipgapi:ProcessorReferenceNumber>513206044009</ipgapi:ProcessorReferenceNumber>
            <ipgapi:ProcessorResponseCode>00</ipgapi:ProcessorResponseCode>
            <ipgapi:ProcessorResponseMessage>Function performed error-free</ipgapi:ProcessorResponseMessage>
            <ipgapi:TDate>1747030749</ipgapi:TDate>
            <ipgapi:TDateFormatted>2025.05.12 08:19:09 (CEST)</ipgapi:TDateFormatted>
            <ipgapi:TerminalID>00001115</ipgapi:TerminalID>
            <ipgapi:TransactionResult>APPROVED</ipgapi:TransactionResult>
            <ipgapi:TransactionTime>1747030749</ipgapi:TransactionTime>
            <ipgapi:Secure3DResponse>
                <v1:ResponseCode3dSecure>1</v1:ResponseCode3dSecure>
            </ipgapi:Secure3DResponse>
        </ipgapi:IPGApiOrderResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

API Products

Point of Sale

Developer

Resources