You're viewing documentation for our latest API. This will not impact your integration, but you will need the documentation relevant to you. If you have an account with Checkout.com you have received an email confirming which version to use.
This quick guide will help you get up and running with payments. We help you create your first keys and make a payment using Frames in our sandbox.
There are 2 forms of API authentication available for you to use: API keys and OAuth 2.0 access keys.
In the Dashboard, you can:
List and view your keys.
Create new keys.
Edit or delete existing keys.
Any user with Developer or Admin permissions can view or create keys, but only users with the Owner permission are able to edit or delete existing keys.
You can only create keys for the entity and its processing channels that you have access to in the Dashboard. This is controlled by your Owner or Admin role.
To create a key:
Sign in to Dashboard and go to either Developers > Overview or Developers > Keys.
Select Create a new key.
Select the type of key you want to create.
Give it a description. This will help you identify what the key is used for.
Scopes grant access to specific APIs. For secret API and access keys, we automatically assign all scopes by default for convenience. If you want to limit the scopes a key has access to, use the Customize option.
Depending on your selected scopes, select an entity and, optionally, a processing channel. By default, a key will be assigned to allow any processing channel. Alternatively, you can manually assign up to 25 processing channels to a single key.
Select Submit to create the key. For secret API and access keys, copy the secret value securely – you will only see this value here once. Public API keys can be viewed at any time after creation.
You can create test data for payments, disputes, and refunds to use in your sandbox environment.
Test data creation is currently designed for use by Direct Seller merchants.
You can either create pre-defined sample sets of data with the Auto add test data option, or customize the test data set with the Add custom test data option.
The service status viewer allows you to monitor the status of Checkout.com's various services.
A green marker next to a service indicates that there are no issues, while an amber marker means that there are minor issues. A red marker indicates that an outage has been reported for the specified service.
For more details about our system status reports, contact your Account Manager or Solutions Engineer.
The developer resources section provides a handy way to access our documentation, API reference, and GitHub repository from a single location.