Articles in this section

Set up a connection to Checkout.com

Tanisha Ray
Updated

Checkout.com is a global payment processing and payment gateway platform that enables businesses to accept, process, and manage online payments across multiple countries, currencies, and payment methods.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type *

Choose your Checkout.com account API type:

  • Core: Process payments, manage customers, refunds, disputes, and payment operations

  • Transfers: Move funds between accounts and manage payouts

  • Balances: Access account balance information to view available funds, pending balances, and currency-specific balances for reconciliation and financial reporting

  • Forward: Route payment data and transaction events to external systems for downstream processing and reconciliation

  • Platform: Files: Upload, retrieve, and manage files for connected accounts and platform operations, including documents used for onboarding, verification, and compliance workflows

  • Identities: Verify and manage customer identity information to support onboarding, compliance, and fraud prevention

Prefix * 

Enter your Checkout.com account prefix. For more information on identifying prefix, see Base URLs.

Auth type * 

Select your Checkout.com account authentication type (OAuth 2.0 or Token).

Auth type: OAuth 2.0 

OAuth 2.0 client * 

Enter your Checkout.com account client ID and secret. For more information on retrieving your client ID and secret, see Manage API authentication.

Auth type: Token 

API secret key * 

Enter your Checkout.com account API secret key. For more information on retrieving the API access key, see Manage API authentication.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

Core API type 

Environment * 

Select your Checkout.com Core API account environment:

Transfers API type 

Environment * 

Select your Checkout.com Transfers API account environment:

Transfer ID * 

Enter your Checkout.com account transfer ID. For more information on retrieving the transfer ID, see View transfers.

Balances API type 

Environment * 

Select your Checkout.com Balances API account environment:

Entity ID * 

Enter your Checkout.com account entity ID. For more information on retrieving the entity ID, see Where can I find my entity ID.

Forward API type 

Environment * 

Select your Checkout.com Forward API account environment:

Forward request ID * 

Enter your Checkout.com account forward request ID. 

Platform: Files API type 

Environment * 

Select your Checkout.com Platform: Files API account environment:

Entity ID * 

Enter your Checkout.com account entity ID. For more information on retrieving the entity ID, see Where can I find my entity ID.

File ID * 

Enter your Checkout.com account file ID. 

Identities API type 

Environment * 

Select your Checkout.com Identities API account environment:

Applicant ID * 

Enter your Checkout.com account applicant ID. For more information on retrieving the applicant ID, see Create an applicant.

Core API authentication compatibility

Authentication type

API resource

Supported resource(s)

Notes

API secret key

Payment Links

All endpoints

Supported only with API Secret Key authentication

Hosted Payments Page

All endpoints

Supported only with API Secret Key authentication

OAuth

Forex

All endpoints

Supported only with OAuth authentication

Apple Pay

Enroll a domain to the Apple Pay Service

The remaining two endpoints require Public Key authentication

Google Pay

All endpoints

Supported only with OAuth authentication

Instruments

Get bank account field formatting

The remaining five endpoints support both OAuth and Token authentication

Disputes

Get dispute evidence

The remaining nine endpoints support both OAuth and Token authentication

Disputes

Submit dispute evidence

The remaining nine endpoints support both OAuth and Token authentication

Disputes

Submit dispute arbitration evidence

The remaining nine endpoints support both OAuth and Token authentication

Platforms

Onboard an entity

Other endpoints are either available under the Files resource or support both OAuth and Token authentication

Platforms

Get entity details

Other endpoints are either available under the Files resource or support both OAuth and Token authentication

Platforms

Update entity details

Other endpoints are either available under the Files resource or support both OAuth and Token authentication

Cardholders

All endpoints

Supported only with OAuth authentication

Cards

All endpoints

Supported only with OAuth authentication

Controls

All endpoints

Supported only with OAuth authentication

Control Profiles

All endpoints

Supported only with OAuth authentication

Control Groups

All endpoints

Supported only with OAuth authentication

Card Testing

All endpoints

Supported only with OAuth authentication

Standalone Account Updater

All endpoints

Supported only with OAuth authentication

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see Token auth universal connector documentation.

Additional references