We've made some changes to our API
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
You're viewing documentation for our latest API. You can access the previous version if you need it.
Browse by category
Popular questions
Reporting
Each payment is uniquely identified with an ID, which is created at the first action administered to a payment – usually the authorization.
If you include this ID in your request, you'll get all the actions associated with the payment and all the related fees and amounts.
In the CSV report, you'll see that each row corresponds to a payment fee or an amount relating to a certain action.
Reports are an easy way to view the processed amount, refunds, chargebacks, processing fees, rolling reserve moments, and general adjustments for a given period in your account.
They are generated automatically based on your payout frequencies, and you can find them in the Reports screen in the Dashboard.
You can find more information in our Reporting documentation.
Integration
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.
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.
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.
Account management
To reset the password on your live account, complete the Forgot Password form. To reset the password on your sandbox account, complete the Forgot Password form. You'll then receive an email with instructions on how to reset your password.
Information
If you remember your password and just want to change it, go to the My profile section on the Dashboard, and follow the steps to change your password.
Risk management
In short, Strong Customer Authentication only applies to you if both of the following statements are true:
- You are located in the EEA or in the UK, and
- The card issuing bank is also located in the EEA or in the UK
Payments and refunds
You can issue a refund (full or partial) either through the Dashboard, or by calling the Refund endpoints.
For more information, see Refund a payment.
Integrated Platforms
If your business sells on a platform or marketplace that uses Checkout.com, see how you can set up your account to start accepting payments.
Checkout.com will send you an email asking you to create your account. The link in the email will take you to dashboard.checkout.com, where you can activate the account linked to your email address.
If you are creating your account for the first time, Checkout.com will need to verify your information before activating your account. This usually takes 24 hours, but in some cases can take up to three working days.
Each country or region will have different regulations. Your registered country and business type will therefore determine what information you will need to submit for Checkout.com’s verification. See the relevant FAQ for the specific requirements if your business is based in the UK, the EEA, or the US.
Checkout.com supports onboarding for two business type groups:
- registered business: a legal entity formed by a group of individuals that operate a business together. Some of these individuals can be shareholders or ultimate beneficial owners (UBOs) who own ≥25% of the company or voting rights. If there are no UBOs who own ≥25% of the company, the representative(s) should be an individual with the right to sign on behalf of the company. We require information about these representatives during onboarding.
- sole trader or individual: a person running their own business as an individual (sometimes referred to as a sole proprietor or trader)
To keep you updated with your account status, we will always send you an email to inform you of any account status changes. You can sign in to the Dashboard at any time to check the current status of your account.
If we cannot verify your business details successfully, we will inform you both by email and in your Dashboard. You will then be required to submit further information for Checkout.com to continue the verification process.
To submit further information:
- Open the email and click on the link Complete setup to be directed to your Dashboard.
- Sign in to your Dashboard.
- Review the highlighted fields where action is required.
- Click Edit business details and make all the required amendments.
- Click Submit.
Information
You must action all the highlighted errors in the Action required status. Otherwise, Checkout.com will not be able to rerun the verification checks. Your account status will return to Pending once you've actioned all onboarding errors.
Once you have submitted your details for verification, you can go ahead and add your bank account details via your Dashboard. You do not need to wait until your account has been successfully verified. Your bank account details will also go through a verification process before you get paid.
If any of your business details change, then you can sign in to your Dashboard and update your details. For example, if a new director is appointed or the principal trading address changes. Submitting changes to your business details may require Checkout.com to verify the new information. If this is the case, you will receive a confirmation email.
Additionally, if you change your business bank account, you can sign in to your Dashboard to add the new details and select this account as the default account to receive your earnings.
Information
Submitting new business details for additional verification checks will not affect your account’s ability to continue doing business, unless we cannot complete the verification. You will still be able to accept payments and get paid out. However, your account status will return to Pending for the duration of the checks.
If you’re setting up your Dashboard account for the first time, you’ll need to add your bank account details to it so you can get paid.
- Sign in to your Dashboard.
- Click on the ... icon and go to Add bank account to input your bank account details and upload your bank statement document. For the correct payout formatting, see our country-by-country guide.
- Submit by clicking the Add bank account button.
- The bank account will now be visible on your Dashboard profile with a label showing the last four digits of the account number. You can edit this label in the Dashboard. This helps identify accounts if you have added more than one.
If you need to update your existing bank account details, you can add a new bank account and set it as your primary (default) method for payouts. The new account must pass verification before it can receive payouts. Until then, your existing bank account will continue to receive payouts.
Checkout.com lets you get paid through two methods, either via an automated schedule (for example, weekly on a monday) or on-demand, based on your requests.
The platform or marketplace you are selling on controls these methods and may only offer you payouts timings based on their business rules. For more information on your payout schedule, contact the platform that you are selling on.
Checkout.com can support you getting paid in different currencies depending on the country you’re in.
See the relevant FAQ for a list of supported payout currencies if your business is based in the United Kingdom (UK), the European Economic Area (EEA), or the United States (US).
Can't find what you're looking for?
Email us at [email protected].