Reconciliation FAQ

Here you'll find some common questions and a bit more detail about our reconciliation API.

General

Action and amount types explained

The following table describes the action types and their possible associated amount and fee types.

Action type
Amount and fees

Authorization

  • Gateway fee
  • Authorization fee
  • Scheme fixed fee
  • Scheme variable fee
  • Blended fee

Void

  • Gateway fee
  • Void fee
  • Scheme variable fee
  • Scheme fixed fee

Capture

  • Gateway fee
  • Captured
  • Capture fee
  • Rolling reserve
  • Scheme fixed fee
  • Scheme variable fee
  • Premium fee
  • Scheme IC fee
  • Reconciliation fee
  • Blended fee

Refund

  • Gateway fee
  • Refunded
  • Scheme fixed fee
  • Scheme variable fee
  • Refund fee

Retrieval

  • Retrieval fee

Chargeback

  • Chargeback (ADJM)
  • Chargeback fee
  • Scheme chargeback variable fee
  • Scheme chargeback fixed fee
  • Chargeback (RPCB)
  • Representment fee
  • Chargeback (CBRV)
  • Chargeback (AUTO)
  • Chargeback (PARB)
  • Chargeback (RPDR)
  • Chargeback (RPDL)
  • Chargeback (RPDW)

Payout to Card

  • Scheme fixed fee
  • Scheme variable fee
  • Scheme IC fee

Payments endpoint FAQ

Are alternative payments available in the response as well?

Yes, all payments including alternative payments are available with this endpoint.


Are payments from multiple regions available through the same API?

Yes, you are able to see all your payments globally in a single location to facilitate your business decisions and reconciliation process.


How do I see the entire history of a payment?

Each payment is uniquely identified with an ID which is generated at the first action administered to a payment which is usually the authorization. You can query this particular ID in your request and you will get all the actions administered to this payment and all the associated fees and amounts. In the CSV report, you will see that each row corresponds to a payment fee or an amount relating to a certain action.


How long do I need to wait before being able to download an accurate list of my payments for the day?

Data is accessible in real-time, but keep in mind that some fees are not applied in real-time and might not appear in your report yet. For instance, interchange fees are only typically applied one day after the original date of the capture and will only appear in your report at that moment.


To which date does the date parameter in the request correspond?

When you create your request, you can specify a date. This date corresponds to the original date of the first action administered to a payment, usually the authorization. In the payments endpoint’s response, you will get all the subsequent actions and amounts that are related to this payment even if they happened on a later date.

For example, when you set a date range from 2019-01-21 to 2019-01-21, you will get all actions related to the payments where the first date of the first action of the payment was 2019-01-21, which will be the date of the authorization most likely. Even if the interchange fees are only applied on 2019-01-22 (i.e., one day later), you would still see them in your report for the 2019-01-21 as long as your request happens after they have been taken into account (i.e., after 2019-01-22).


What is the difference between the payments I can see in the Hub and the ones in the payments endpoint?

In the payments endpoint, you will only find payments that are associated with movement of funds or fee application. For example, you will not find any mention of a declined payment that would have no associated fees, but the payment will be visible on the Hub, as it is a reflection of payments processed through Checkout.com.


What should I do if I want to reconcile the amount deposited in my bank account against one of the reports provided by the reconciliation API?

To do so, please refer to the statements endpoint.

Statements endpoint FAQ

What is the difference between the content of PDF statement report and information retrieved from the statement endpoint?

The data contained in your statement report and the reconciliation API is the same.


What is the difference between the payments endpoint and the statement reports?

The payments endpoint only contains transactional information. Non-transactional information (i.e., business or merchant level data such as the payout fee, payout fee tax, admin fees or general adjustments) is only included in the statements endpoint. The payments endpoint is a view of your processed volume and fees at payment level, but it will not allow you to reconcile the amounts against your payout amounts. This is because payouts contain non-transactional elements which are not reflected in this report.


How should I use the reconciliation API if I want to reconcile it against one of my statements?

You should get the statement ID of your statement and add it in the statements endpoint. Do not use the statement period date because if for some reason an action has only been taken into account in a later date, then it will appear in a later statement even if it will still show the original date when the action was taken.


Does my payments endpoint report for a given date always match with the corresponding statement?

Not always, in the scenario of a bug leading to a delay of processing, you will still see the original date recorded in your reports even if the effective date was later.

Reconciliation FAQ


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.