API endpoints
Beta

Last updated: March 5, 2025

The Checkout.com API is designed around REST principles:

To interact with the API, perform an HTTP request to an endpoint.
Endpoints are relative to the base URL.
You must authenticate your request.
If the endpoint requires you to provide data, you pass this as a JSON payload in the request body.
Data in the response body is also sent as a JSON payload.
Requests return a standard HTTP response code.

Base URLs are unique to each merchant and have two variants, depending on which environment you want to perform the API call in:

Live: https://[prefix].api.checkout.com/[path]
Test: https://[prefix].api.sandbox.checkout.com/[path]

Information

The Test environment enables you to perform test API calls without affecting live data.

The [prefix] value in the base URL is a string containing the first eight characters of your unique client_id, excluding the cli_ prefix.

You can view your client ID in the Dashboard if you have the Owner or Admin user role.

To find your client ID:

Sign in to the Dashboard.
Select the Settings icon in the top navigation bar and open the Account structure tab.

The client ID is displayed in the top right corner of the tab.

Information

Your Live and Test environments have different client_id values. If you are unsure of your client ID for either environment, contact your Account Manager or [email protected].

For example, if your client ID is cli_vkuhvk4vjn2edkps7dfsq6emqm, the base URL for your Live environment is:

https://vkuhvk4v.api.checkout.com/[path]

The [path] value in the endpoint represents the resource from the API. For example, payments/{id}.

All Checkout.com services use HTTPS to communicate and provide a certificate when you connect. The certificate allows your client to authenticate that we own the service you are connecting to.

Note

Do not pin certificates. We regularly renew and update certificates and pinning them will cause your integration to break after a certificate renewal.