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 webhooks, reports, and settlements.
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.
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.
The Settlements screen in the Dashboard enables you to view your current settlements and download previous ones.
Alternatively, you can use the reports endpoint of the Reports API to call a summary of your settlements and payouts within specified parameters.
There is no difference. The data contained in your statement pdf and financial actions by payout ID report is the same.
In the payments report endpoint, you'll only find payments that are associated with movement of funds or fee application. For example, you won't find any mention of a declined payment that would have no associated fees.
But that payment would be visible on the Dashboard, because it is a reflection of any payments processed through Checkout.com.
Yes, you can see all of your payments globally by retrieving your reports using the Reports API and via Secure File Transfer Protocol (SFTP).
You can also use our Financial actions API to query your financial action data and perform near real-time reconciliation.
Yes. All payments, including those made with alternative payment methods (APMs), are available with this endpoint.
Data is accessible in real time, but keep in mind that some fees are not applied in real time, so they might not appear in your report immediately.
For example, interchange fees are typically only applied one day after the original date of the capture so will only then appear in your report.
You can retrieve your reports by calling our reports endpoint. You can find more information in our Reports API documentation.
Not always. If, for example, an error led to a delay in the processing, you would still see the original date recorded in your reports, even if the effective date was later.
To reconcile between your bank statements and Checkout.com’s payouts report, first identify a payout from Checkout.com shown on your bank statement. Payouts from us can be identified on your bank statement by the unique 12-character ID, which is also shown in the reports (for example, 000G7HDD96SH).
Look up the Payout Amount field within the corresponding payouts report for the date range during which that payout to your bank account occurred. Then simply reconcile between each amount displayed on your bank statement or transaction history and the payout amounts shown on your payouts report.
If Checkout.com has paid out the correct amounts to you, then the two values will reconcile.
You can find more information in our Reconciliation with Checkout.com documentation.
Yes. The unique identifier (for example, the customer or transaction ID) you send with the transaction using the reference parameter will appear in your Financial actions, Balance, and Payouts reports.
It means that the webhook associated with a specific event type is not being received properly.
We will keep trying to send to that endpoint for 7 days, after which you will be unsubscribed from that event type.
You will continue to receive webhook notifications for other events that are being processed successfully.
Failed webhooks will never impact the processing of payments in any way. They are only notifications designed to help you stay informed of what's happening with your business in real time.
Learn more about webhooks and the webhook retry mechanism using our Webhooks documentation.
The payment actions and their associated fees are as follows:
Authorization
Capture
Chargeback
Expiry
Payout to Card
Refund
Retrieval
Void
You can download CSV files of the settlement reports for successful settlements. To do this, go to the Settlements section in the Dashboard, and click Download CSV within the Transaction Breakdown report.