Checkout.com HUB Disputes Webhook

Pre-Step: Map the Checkout.com id in the Validation API

To ensure that the checkout.com chargeback is matched with the correct original order, please map the Checkout.com Request Payment id (the value that starts with pay_ ) that is generated at the payment authorization, to the gatewayTransactionId field in the Order Validation API. For more information on where to find and retrieve the checkout.com Id, please see checkout.com's Request Card Payment Documentation.

The JSON below shows example mapping of the gatewayTransactionId within the creditCard object of the Validation API's payment array.

Securely Upload your Checkout.com secret key

In your Checkout.com dashboard, click Developers -> Keys.

Find and copy your Secret Key and send this value in a text file named "JCBR-merchantName-Checkout.txt" to your secure, S3 bucket.

You can find your S3 bucket name and instructions on the bottom of the S3 file transfer page. Let your Forter onboarding team or CSM know once you've uploaded the key to your S3!

2. Forter encrypts your Secret key

Your Forter onboarding team will encyrpt and securely add your secret key to the Forter database and your onboarding team or CSM will let you know when this step is complete.

Create a new Webhook

Once Forter has added your encrypted secret key, log back into your Checkout.com dashboard and click Developers -> Webhooks. Create a new Webhook using the following information:

Endpoint URL: https://api.forter-secure.com/webhooks/checkoutcom/
Your site Id can be found by going directly to the Forter portal's General Settings page and toggling to the Production environment.

Authoriation Header Key

In the Authorisation header Key field, copy and paste your Forter API Secret key which can also be found on the Forter portal General Settings page.

Signature Key

In the Signature Key Section, copy and paste the Checkout Secret key you generated in the Developer Section in Step 1.

Events

Select all events related to disputes. The dispute events should include:

Dispute canceled
Dispute evidence required
Dispute expired
Dispute lost
Dispute won
Dispute resolved
Request for information received

Entities and processing Channels

Under this section, select all relevant channels

Click Create Webook.

All Set!
This should complete your Checkout.com claims webhook configuration! If you have any questions, please contact your Forter Onboarding team or dedicated Forter CSM at [email protected].

Testing the Checkout Dispute Webhook
To simulate a chargeback with the checkout.com webhook, please reference checkout.com's full list of test cards and scenarios here.

Multiple Checkout Accounts for a single Forter site

Currently, Forter only supports 1 checkout account to 1 portal site. This means that if you have multiple checkout accounts pointing to a single portal site, you will only be able to set up a dispute webhook for one account. Remaining accounts will need to provide chargebacks via an alternate method such as the Forter claims API, a csv file, or manual update in the Forter portal.