Updated: July 7, 2021

Configuring Checkout.com In sticky.io

To configure the Checkout.com 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/Checkout.com 2.0/Checkout.com (REST) from the drop-down. Fill out the gateway parameters which are outlined below and click “Save”.

Checkout.com = This is the oldest version of Checkout.com. It is recommended you go with Checkout.com (REST)
Checkout.com 2.0 = This is a newer version of Checkout.com. It is recommended you go with Checkout.com (REST)
Checkout.com (REST) = This is Checkout.com 2.0 but with the latest updates and we recommend you use this gateway profile.

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

These parameters are briefly described here for your reference and are based on the specific provider profile:

Checkout.com

Private Key: This will be provided to you by Checkout.com
Test Mode: Select whether or not to use Checkout.com Gateway in test mode.
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.
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. Below is the format of your redirect URL:
- https://{appkey}.sticky.io/admin/alternative_provider/ajax.php?mode=3d_capture&ll_token=3ds_process
- https://{appkey}.sticky.io/admin/alternative_provider/ajax.php?mode=3d_capture&ll_token=1
Rebill Preauth: Select Yes if you would like to use the rebill pre-auth. When selecting Yes, an additional field will populate called Days Prior.

Checkout.com 2.0

Private Key: This will be provided to you by Checkout.com
Test Mode: Select whether or not to use Checkout.com Gateway in test mode.
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.
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. Below is the format of your redirect URL:
- https://{appkey}.sticky.io/admin/alternative_provider/ajax.php?mode=3d_capture&ll_token=3ds_process
Rebill Preauth: Select Yes if you would like to use the rebill pre-auth. When selecting Yes, an additional field will populate called Days Prior.
Capture on Shipment: Select Yes if you want to capture the authorized amount once the order is marked as shipped.

Checkout.com (REST) - {Recommended}

Private Key: This will be provided to you by Checkout.com
Test Mode: Select whether or not to use Checkout.com Gateway in test mode.
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.
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. Below is the format of your redirect URL:
- https://{appkey}.sticky.io/admin/alternative_provider/ajax.php?mode=3d_capture&ll_token=3ds_process

When using the Rebill Preauth, X number of days prior to the rebill, an auth will be created. If the auth is successful, it spawns a pending child order which represents the auth that will be captured on the parent's next recurring date.If the auth fails, the system will create a declined child order and the parent will still perform a full sale on the next recurring date. Please note that these orders will still go through the decline salvage process.

Webhooks and URLs

Checkout.com and Checkout.com 2.0 require webhooks to be configured and all three versions of Checkout.com require URLs to be configured for 3D Secure.

Here are instructions and screenshots to do so.
- Log into the sandbox terminal.
- Click on the gear icon (settings) for the account.
- Once you select Channels there will be a section for the Channel URL, this is where adjustments to the Payment Success & Payment Error URL (more info below) need to be made.
- There will also be a section for Webhooks where the required webhook (more info below) can be configured.

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.

Payment Success URL:
- https://{appkey}.sticky.io/admin/alternative_provider/ajax.php?mode=3d_capture&ll_token=3ds_process
Payment Error URL:
- https://{appkey}.sticky.io/admin/alternative_provider/ajax.php?mode=3d_capture&ll_token=3ds_process

Webhooks

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. Please contact Checkout.com for additional details.

For Checkout.com Only

NOTE: Orders processed through this gateway are initially created as Pending until we receive a post back from the gateway with the final status, whether it be approved or declined. The post back will be almost instantaneous. Here is the template for the post back URL that will need to be configured with your Checkout.com account:
- https://{appkey}.sticky.io/admin/api/provider_api.php?provider=checkout_dot_com

For Checkout.com 2.0 Only

NOTE: Orders processed through this gateway are initially created as Pending until we receive a post back from the gateway with the final status, whether it be approved or declined. The post back will be almost instantaneous. Here is the template for the post back URL that will need to be configured with your Checkout.com account:
- https://{appkey}.sticky.io/admin/api/provider_api.php?provider=checkout_2

Checkout.com (REST)

No webhooks are needed for this provider profile.

Please reach out to Checkout.com for further details about configuring this URL within your account.

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.