Adding a Checkout.com Connection

Modified on Tue, 8 Oct at 9:49 AM

Adding a Checkout.com connection to your BR-DGE retail channel requires you to collect some information for us to add to your BR-DGE retail channels. This article details the information BR-DGE requires, and how you can locate it.

Checkout.com Account

If you don't already have a Checkout.com Account, then you will need to create one with Checkout.com.

BR-DGE requires the following information to allow you to route payments to Checkout.com through our platform:

Processing Channel Id
Merchant Api Key
entity Id (for Payouts only)
Checkout Notification Passphrase
Authorization Key

Please note that some of these details are sensitive. We ask you to handle these with care.

How to locate your Processing Channel Id & Merchant Api Key?

Login to your Checkout.com account.
Go to Developers > Keys and select Create a new key.
Select Secret API Key for server side authentication.
Enter an appropriate description in the Key description field.
Under Scopes, select Customise > Payments radio button. No other changes in this section are required.
Under Processing channels:
Ensure Allow any processing channel is NOT ticked.
Ensure the relevant processing channel IS ticked in the checkbox list:

Click on the Create Key button.
Copy the value for Secret API Key.
Click the Close button.
The saved value for Secret API Key is to be used as the value for Merchant Api Key.

How to locate your entity Id?
To obtain your entityId, please contact Checkout.com support and ensure they grant you access to the balances endpoint.
They may ask your Processing channel Id and API key, so ensure you have these on hand.

The Processing channel ID is required if you are using Checkout for Payouts, or if using the same API Key across multiple retail channels within BR-DGE Portal. Entity ID is required for Payouts. Otherwise, these fields are optional.

How to create your Checkout Notification Passphrase & Authorization Key?
Firstly, Configure the following notifications to be sent to BR-DGE;
Refund notifications
Void notifications
Capture notifications
Payment Declined notifications (optional)

If using Payouts with Checkout.com, Configure also the following notifications;

Then, Login to your Checkout.com account and select the correct environment (Test | Live)
Go to Developers > Webhooks.
Select + New webhook.
Enter a name for your notification in the Name field.
Enter the following URL in the Endpoint URL field;

Sandbox (Test): sandbox.comcarde.com/v1/notifications/checkout/{RetailChannelId}
Production (Live): secure.comcarde.com/v1/notifications/checkout/{RetailChannelId}

BR-DGE will need to issue your Retail Channel Id for the corresponding retail channel in advance. Please get in contact with Customer Support to get this information.

Click Generate key under Authorization header Key and record the value generated.
Click Generate key under Signature Key and record the value generated.
Select the Events you wish to receive notifications for; see below example:

Click Create webhook.

If required, you can click on Developers > Webhooks to access the Authorization header Key and/or Signature Key on a previously generated notification.