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.
Unsure which version you need? Contact Support
Find information on payment methods, testing, and implementation.
For the test (sandbox) environment, email our Support team at [email protected] to add new payment methods to your account.
For the live environment, either contact your Account Manager or email our Support team at [email protected] to add new payment methods to your account.
You can find out more about the payment methods we support on our documentation site.
You'll find various test card numbers (including those for 3D Secure (3DS) transactions), and all the information you need to run tests in your sandbox environment, in the testing section of our docs.
You can create a sandbox account via the sign up for a test account page.
You can test card payments straight away with your sandbox account. To test alternative payment methods, or payments that use raw card details (assuming you have SAQ-D PCI compliance), email our Support team at [email protected].
To find out more about the payment methods we support, see our documentation site.
For information on creating a test account in our sandbox environment, see our Get Started page.
First, you'll want to:
By default, you can test most card payment flows. You cannot however test card payouts. Email our Support team at [email protected] if you would like more information on testing card payouts.
If you require any alternative payment methods (for example, PayPal, Sofort, iDEAL), email our Support team at [email protected] to enable them on your test account.
Once you've run some initial tests to make sure everything's running smoothly, you can then apply for a live account to start processing payments with us. To do this, contact our Sales team at [email protected].
We'll need you to complete an online application form, which will then be reviewed by our in-house Onboarding team. We may ask you to provide further documentation, including corporate structure documentation, legal entity details, bank account information, and principal owners.
Once we've approved your application, you’ll execute a contract and we'll provide you with your production credentials. We then recommend that you perform a test transaction, or run a pilot in production, before processing real customer transactions. This allows you to ensure that everything is set up correctly and will work as expected.
After that, you're ready to start accepting live payments from your customers.
Payment Links are our simplest method for accepting payments, through any device or channel. Send a Payment Link to your customer via their preferred channel (email, live chat, text message or other) and they'll be taken to a Checkout.com-hosted payment page to complete their purchase.
Hosted Payments Pages allow you to accept payments through a Checkout.com-hosted page. The customer enters their payment details on the page, and in the background we generate a token and complete the payment request.
Frames is a highly customizable payment form which allows your customers to enter their sensitive card information in a safe environment right on your own checkout page. This information will be exchanged with a secure token that you can use to perform payments. By using Frames, your platform will never touch the card details.
SDKs (software development kits) give you the freedom to build your own custom payment form on your website or mobile app, or use our own pre-built form. We'll take care of the processing side of things, and return the tokenized payment information to you.
Ecommerce platforms are great if you want to get up and running quickly. Use one of our plugins to start accepting payments through your favorite ecommerce platform.
If you're looking for total control over the checkout experience, our Full card details API may be the option for you. Unlike our other integration methods, the full card details API does not use card tokens. Instead, you process your customers' card details directly. As a result, you must have the correct level of PCI DSS compliance (Self-Assessment Questionnaire D – SAQ D) to use this method.
You can learn more about each integration method on our documentation site.
See our integration documentation to learn about the ecommerce platforms we support, as well as the relevant plugins and installations guides.
You can find all of the alternative payment methods we support, as well as integration and testing information, in the payment methods section of our documentation site.
Before you can start accepting Apple Pay payments, you'll need a few things:
Once you've sorted the above, you can:
signing-requests endpoint/applepay/certificates endpoint endpointSee our Apple Pay guide for more information on Apple Pay integration and payments.
Go to Developers > Keys in your Dashboard to generate and manage keys. A detailed guide can be found in the Dashboard documentation.
Go to Developers > Keys in your Sandbox account to generate and manage keys. A detailed guide can be found in the Dashboard documentation.
Go to Developers > Keys in your Dashboard to generate and manage keys. A detailed guide can be found in the Dashboard documentation.
Yes, multiple people can use one sandbox account. If you are an administrator, you can add a new user by going to Settings > Team permissions and clicking New user in the Dashboard.
Yes. To add multiple channels, either contact your Account Manager or email our Support team at [email protected].
Yes, you can test most of the alternative payment methods (APMs) we support in the sandbox environment. You can configure Apple Pay and Google Pay, however, we need to activate the other APMs before you can use them. To get this done, email our Support team at [email protected].
Yes. To activate this feature, contact our Support team at [email protected].
To start receiving webhook notifications, you can use our Workflows API or the Dashboard to create a workflow by specifying both:
On the Dashboard, go to the Settings tab, and then to Notifications.
You can find more information in our dedicated webhook guide.
Yes, the Reports API and Financial Actions API are both available in your sandbox environment.
More information can be found in the Reports API documentation.
Yes. You can simulate a dispute by using specific combinations of payment methods and amounts, as described in our disputes testing guide.
Yes. When sending a payment request, you can pass a parameter called reference. This allows you to send a unique identifier (for example, a customer or transaction ID) with the transaction.
You can see all the parameters that can be sent in a payment request Unified Payments API.
Yes. The previous_payment_id field passed in recurring payment requests supports payment IDs, charge IDs, and scheme IDs.
You can create Payment Links in two ways. Either use our API or via the Payment Links tab on the Dashboard. Learn more about creating Payment Links.
Depending on your integration with Checkout.com, you can request the payment with 3DS by setting the 3DS parameter to true in your payment request body. For example, "3ds": {"enabled": true}.
For more information, see the API reference.
Before removing 3DS, it is always best to first try and understand why the transactions are failing. Depending on your region, 3DS could be mandatory and removing it without an adequate exemption in place may result in Strong Customer Authentication (SCA) non-compliance.
To handle cases where the customer's card is not enrolled for any version of 3DS, you can set the attempt_n3d field to true to downgrade the transaction to non-3DS. This means that if the customer's bank does not support 3DS, we will automatically attempt to process the payment without 3DS authentication instead.
For more information, see our SCA compliance guide.
On the Dashboard, go to the Developers tab, and then to Keys. This is where you can view and manage your keys.
A webhook is a notification we send you when an event occurs. It is the definitive confirmation of a status update. Webhooks are sent for a variety of events, such as when a payment is voided or flagged. You can choose which specific webhook you'd like to subscribe to.
To learn more, see our Manage webhooks documentation.