Checkout.com Gateway (REST)
Support avatar
Written by Support
Updated over a week ago

Updated: November 20, 2023

****IMPORTANT NOTE: ****

Checkout.com is deprecating their HUB Merchant accounts by 1/31/24. Contact checkout.com to change your existing HUB mids to NAS mids before this date. Once checkout.com updates your MIDS you must ensure that the provider you use in sticky.io is Checkout.com(REST) and the MID type is set to NAS.

Configuring Checkout.com In sticky.io

To configure the Checkout.com REST Gateway into your sticky.io CRM, you will go to Payments > Gateways, under Actions select Add New Provider Profile. Select the Payment/Gateway and select Checkout.com (REST) from the drop-down. Fill out the gateway parameters which are outlined below and click “Save”.

  • Checkout.com (REST) = This is Checkout.com 2.0 but with the latest updates and we recommend you use this gateway profile.

  • DO NOT USE - Will be deprecated 1/31/24 - Checkout.com = This is the oldest version of Checkout.com. It is recommended you go with Checkout.com (REST)

  • DO NOT USE - Will be deprecated 1/31/24 - Checkout.com 2.0 = This is a newer version of Checkout.com. It is recommended you go with Checkout.com (REST)

    For more information on this Gateway click here https://www.checkout.com/

These parameters are briefly described here for your reference:

Checkout.com (REST)

  • Alias: Name that you will assign to the gateway. This is for internal purposes only; it helps you identify a specific gateway account among several of them in your CRM.

  • Private Key: This will be provided to you by Checkout.com

  • Currency: The Checkout.com Gateway currently supports: AED, USD, EUR, GBP, CAD, AUD, ZAR, JPY, DKK, NOK, SEK, BRL, CLP, MXN, KRW, NZD, PLN, SGD, HKD, ARS, COP, PEN, TRY, PYG, BOB, CHF, INR, PHP, TWD, and MYR currencies.

  • Public Key: This will be provided to you by Checkout.com

  • Test Mode: Select whether or not to use Checkout.com Gateway in test mode.

  • 3D Secure: Select whether or not you are using 3D Secure with Checkout.com. Please note that you will need to have 3D Secure enabled within Checkout.com and also configure the redirect URL in order for 3D Secure to take effect.

    Points to be Aware of Regarding 3DS

    • 3Dredirect URL (three_d_redirect_url) is essential to be submitted with the New Order request. This will allow the consumer to redirect to the merchant's Thank You page, after the 3D authentication process.

    • 3D Secure is dynamic to each transaction and the processing bank determines if 3D Secure is needed on each transaction.

    • If 3DS is not needed, the transaction will process and we will return the OrderID and TransID in API response.

    • If 3DS is needed for the transaction, Checkout.com will return to us the ACS URL, and you will receive a 101 response code indicating that you need to submit the 3DS call with the order Id in it to finalize the sale.

    • Once transaction is verified, the consumer is redirected to the 3Dredirect URL (Thank You) that was provided in NewOrder request.

    • There are certain circumstances where the bank will require 3DS on the rebill transaction. This is outside of sticky.io's control.

  • Account Type - Select the correct account type for your MIDS - This type is controlled by checkout.com. Choices are HUB or NAS

  • Sticky.io 3D Verify: This is a VAS option. For more information contact your Client Success Manager.

URLs (For 3D Secure) - All Versions

You will be responsible for configuring your own URL's within your Checkout.com terminal. Your URL’s can be derived from the following template URL.


Apple Pay for Checkout.com

With Apple Pay, you can start accepting credit card payments from your customers via Touch ID or Face ID on Apple devices. This eliminates the need for these customers to manually enter their credit card and shipping details at time of checkout.

Apple Pay for Checkout.com does support subscriptions or straight sale transactions.

To set up Apple Pay for Checkout.com, please refer to this article from the Checkout.com help center documentation.

Important Note -

Wallet tokens must be passed in the new_order request in the following format (must be valid JSON):

Depiction of Code with Proper Formatting:

Code:

{"wallet_token": { "paymentData": { "data": "Rp1uU25JZaElwxC2WN3JpjJPgMAAYBFTg3Xp2nJIMGDBDvA+aY6DHaOq+32u0gUHZKEIBfH\/uLYjnqaJOydKjWb3qXsv1HDyeAGBrWcAVEEAznfe7lc99i2vlYjKqyoSaLHAktCKkWifZry+Z+xkC7Ru6FprLbINxl5YpeuGygBv4FJmMwT3iHf2osz52ul4obd80hGH5bK+laudQiPYmIANs77J7PvevIpI6Dj9MTiTnPR5V6HeXfDDBXounXe0DSlSsnVBtJHdomNsemtUroWoCTIoux+bZPWxhax5vJo7+3MU1B5KFpayS9NsxjkqNHO4u05oLE9Pjfdafac2if0rSbwlUV\/5xf7VonRMc1RPcVvjlPM5tvwZcVB\/IbRLmWBbNwCTjyv+z\/CwCvfH9rDycVBRGBxm5\/Cl3RFKNg==", "signature": "MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJKoZIhvcNAQcBAACggDCCA+MwggOIoAMCAQICCEwwQUlRnVQ2MAoGCCqGSM49BAMCMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xOTA1MTgwMTMyNTdaFw0yNDA1MTYwMTMyNTdaMF8xJTAjBgNVBAMMHGVjYy1zbXAtYnJva2VyLXNpZ25fVUM0LVBST0QxFDASBgNVBAsMC2lPUyBTeXN0ZW1zMRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABMIVd+3r1seyIY9o3XCQoSGNx7C9bywoPYRgldlK9KVBG4NCDtgR80B+gzMfHFTD9+syINa61dTv9JKJiT58DxOjggIRMIICDTAMBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFCPyScRPk+TvJ+bE9ihsP6K7\/S5LMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB\/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMB0GA1UdDgQWBBSUV9tv1XSBhomJdi9+V4UH55tYJDAOBgNVHQ8BAf8EBAMCB4AwDwYJKoZIhvdjZAYdBAIFADAKBggqhkjOPQQDAgNJADBGAiEAvglXH+ceHnNbVeWvrLTHL+tEXzAYUiLHJRACth69b1UCIQDRizUKXdbdbrF0YDWxHrLOh8+j5q9svYOAiQ3ILN2qYzCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI\/JJxE+T5O8n5sT2KGw\/orv9LkswDwYDVR0TAQH\/BAUwAwEB\/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv\/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn\/Rd8LCFtlk\/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYcwggGDAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIITDBBSVGdVDYwCwYJYIZIAWUDBAIBoIGTMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTIzMDIwODIzMTQxNFowKAYJKoZIhvcNAQk0MRswGTALBglghkgBZQMEAgGhCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEIKJaIqYaRE+IGxi6\/GckX\/eOWbbluyn0jTsy\/JbRBn1tMAoGCCqGSM49BAMCBEYwRAIgZAaGAAv+MwDW8Id8V56hF5tLCQ1wVg29WAF6vChKn5gCIFwm0kU0ByWxd0nsrnsUXixKhny234Cux1hxsg7EMxekAAAAAAAA", "header": { "publicKeyHash": "QH4ZYLsRp\/NemXeokxG8mFcLFRynZfvPIKC6dHH\/dgE=", "ephemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBGZUPP5jwgH60IIr4QPy3dWA4FQ9nXHO61lxLw3d2G6TEILzPD5wk+XjURhJgXoaCpxGvjeVsxmR+i9jfSPTaA==", "transactionId": "12b7bd54ca5884797b93d304308a6f25f50ba81355da65f7e811036f01b6f446" }, "version": "EC_v1" }, "paymentMethod": { "displayName": "Visa 0326", "network": "Visa", "type": "debit" }, "transactionIdentifier": "12B7BD54CA5884797B93D304308A6F25F50BA81355DA65F7E811036F01B6F446" }

GooglePay for Checkout.com

With Google Pay, you can start accepting secure one-touch payments using any credit or debit card connected to their Google account. This eliminates the need for these customers to manually enter their card information at time of checkout.

Google Pay for Checkout.com does support subscriptions or straight sale transactions.

To set up Google Pay for Checkout.com, please refer to this article from the Checkout.com help center documentation.

When a wallet token is generated from the checkout page, it will look like the example token depicted below.

After this wallet token has been generated, the sticky.io Platform will exchange the wallet token with Checkout.com and receive a Google token for capturing funds for the transaction. The Google token will look like the example string depicted below.

A plain text version of an example token is depicted below.

"message": "Checkout.com Token Generated from GooglePay token [paymentData object]",
"context": [
"TOKEN",
{
"token_data": {
"protocolVersion": "",
"signature": "",
"signedMessage": ""
},
"type": "googlepay",
"token": "tok_hlksfixkmshujkir3mnrbmmloe",
"expires_on": "2023-07-21T08:56:35Z",
"expiry_month": 12,
"expiry_year": 2025,
"scheme": "Visa",
"last4": "1111",
"bin": "411111",
"card_type": "Credit",
"issuer": "JPMORGAN CHASE BANK, N.A.",
"issuer_country": "US",
"token_format": "pan_only",
"http_code": 201
}
],
"level": 100,
"level_name": "DEBUG",
"channel": "local",
"datetime": "2023-07-21T04:41:35.904872-04:00",
"extra": {
"clientid": "2377",
"appkey": "marv",
"sessionid": "6i28f",
"dbuser": "apiuser_2377",
"dbpair": "4A",
"environment": "dev",
"version": "8.25.0.6",
"hostname": "ip-10-1-0-4.ec2.internal"
}
}
{
"message": "Checkout Sale Request",
"context": {
"request": "{\"source\":{\"type\":\"token\",\"token\":\"tok_hlksfixkmshujkir3mnrbmmloe\"},\"currency\":\"USD\",\"amount\":19900,\"capture\":true,\"customer\":{\"email\":\"freddie.curtis.123testemail.stickyio@gmail.com\",\"name\":\"Freddie Curtis\"},\"payment_ip\":\"191.30.69.143\",\"payment_type\":\"Recurring\",\"reference\":14536,\"shipping\":{\"address\":{\"address_line1\":\"1398 W Pecan St\",\"address_line2\":\"\",\"city\":\"Des Moines\",\"state\":\"RI\",\"zip\":\"29414\",\"country\":\"US\"},\"phone\":{\"country_code\":\"1\",\"number\":\"(555) 749-3240\"}}}"
},
"level": 100,
"level_name": "DEBUG",
"channel": "local",
"datetime": "2023-07-21T04:41:36.014751-04:00",
"extra": {
"clientid": "2377",
"appkey": "marv",
"sessionid": "6i28f",
"dbuser": "apiuser_2377",
"dbpair": "4A",
"environment": "dev",
"version": "8.25.0.6",
"hostname": "ip-10-1-0-4.ec2.internal"
}
}
{
"message": "CheckoutDotComServiceProvider Payment Provider Response:",
"context": {
"response": "{\"0\":\"1\",\"1\":\"resp_code\",\"3\":\"\",\"4\":\"\",\"6\":\"pay_ue7cpr4coa72zcjvezb6ly5ye4\",\"authId\":\"\",\"errorMessage\":\"\",\"resp_code\":\"000\",\"status\":\"OK\",\"transId\":\"pay_ue7cpr4coa72zcjvezb6ly5ye4\"}"
},
"level": 100,
"level_name": "DEBUG",
"channel": "local",
"datetime": "2023-07-21T04:41:37.187714-04:00",
"extra": {
"clientid": "2377",
"appkey": "marv",
"sessionid": "6i28f",
"dbuser": "apiuser_2377",
"dbpair": "4A",
"environment": "dev",
"version": "8.25.0.6",
"hostname": "ip-10-1-0-4.ec2.internal"
}
}

Lastly, the Transaction ID for an order captured using a Google token received from Checkout.com will be an alphanumeric string. An example Transaction ID is depicted below.

Did this answer your question?