Statements endpoint

The statements endpoint provides a summary of statements and payouts in accordance with your specified parameters.

If you're not familiar with creating API requests, you might want to take a look at our Postman guide.

Please note: No payments before February 7th, 2019 at 00.00.00 UTC will appear using the statements endpoint. To view payments before this time, please use the legacy transactions endpoint.

The request

Use the details below to set up your request. To set the timeframe of your request, replace {start-date} and {end-date} with your desired start and end dates in ISO format. Please note that the time zone for the request will be UTC. The response will be returned in JSON format – but you can also download a CSV copy if you'd like.

Endpoint

GEThttps://api.checkout.com/reporting/statements?from={start-date}&to={end-date}

Header parameters

Header
Parameter

Authorization
Required

secret key

Use the valid secret key of your Checkout.com account. You can find this in the Hub.

Content-Type
Required

application/json

The response

If your summary is returned, the request was successful.

{  
  "count": 1,
  "data": [
    {
      "id": "190110B107654",
      "period_start": "2019-01-09T00:00:00.000",
      "period_end": "2019-01-09T23:59:59.000",
      "date": "2019-01-10T00:00:00.000",
      "payouts": [
        {
          "currency": "GBP",
          "carried_forward_amount": 0,
          "current_period_amount": 15005.24,
          "net_amount": 15000.24,
          "date": "2019-01-10T00:00:00.000",
          "period_start": "2019-01-09T00:00:00.000",
          "period_end": "2019-01-09T23:59:59.000",
          "id": "ABCDEFGH",
          "status": "Remitted",
          "payout_fee": -5,
          "_links": {
            "payments": {
              "href": "http://api.checkout.com/reporting/statements/190110B107654/payments?payout_id=ABCDEFGH"
            } 
          } 
        } 
      ],
      "_links": { 
        "payments": {
          "href":  "http://api.checkout.com/reporting/statements/190110B107654/payments"
        } 
      } 
    } 
  ],
  "_links": {
    "next": {
      "href": "http://api.checkout.com/reporting/statements?from=01%2F01%2F2019%2000%3A00%3A00&to=01%2F11%2F2019%2000%3A00%3A00&limit=1&skip=1" 
    },
    "self": { 
      "href": "http://api.checkout.com/reporting/statements?from=01%2F01%2F2019%2000%3A00%3A00&to=01%2F11%2F2019%2000%3A00%3A00&limit=1" }
    }
  }
}

Understanding the response

The response is designed to present your information as clearly as possible.

1. Statements


Listed in chronological order (descending), this is a record of all your statements within the selected timeframe. The table below outlines the information included and its meaning.

Parameter
Description

id

The ID of the generated statement.

period_start

The start date of all transactions and amounts that are encompassed within the statement.

period_end

The end date of all transactions and amounts that are encompassed within the statement.

date

The date the statement was generated.

payouts

The summary is a breakdown of your statement, ordered by the payout currency and its associated payout ID.

2. Payouts

Grouped by payout currency, this section details all payouts to your bank account within the chosen date range. The table below describes this data and its purpose.

Parameter
Description

currency

The currency of the payout.

carried_forward_amount

The amount carried forward before the statement period.

current_period_amount

The total amount of transactions during the statement period.

net_amount

The total amount paid out to your bank account.

date

The date the payout was completed.

id

Identifies the associated payment (e.g., PO_123).

status

The status of the payout (e.g., Carry Forward).

payout_fee

The total fee charged for the payout.

Did you know?
You can work out your net amount by calculating the sum of the carried forward amount, current period amount and payout fee.

3. Links

Next

This link allows you to move to the next page of results in the response. Responses are paginated at the payout level.

"_links": {
  "next": {
    "href": "http://api.checkout.com/reporting/statements?from=01%2F01%2F2019%2000%3A00%3A00&to=01%2F11%2F2019%2000%3A00%3A00&limit=1&skip=1" 
  }
}

Self

This is a direct link to the response associated with the submitted request.

"_links": {
  "self": {
    "href": "http://api.checkout.com/reporting/statements?from=01%2F01%2F2019%2000%3A00%3A00&to=01%2F11%2F2019%2000%3A00%3A00&limit=1"
  }
}

Extensions

1. Payout breakdown

You can break down the detail even further by using the payout_breakdown field. This will provide all totals from each section of the statement.

The request

Set up your request as described above, then simply add &include=payout_breakdown at the end of the URL.
 For example:


https://api.checkout.com/reporting/statements?from=2018-09-01&to=2018-09-19&include=payout_breakdown

The response

The initial structure of your response will be the same as described above. However, you will also get the following additional fields on your payouts in the current_period_breakdown and processing_fees_breakdown sections of your response:

  • processed_amount
  • refund_amount
  • chargeback_amount
  • payouts_to_card_amount
  • processing_fees
  • interchange_fees
  • scheme_and_other_network_fees
  • premium_and_apm_fees
  • chargeback_fees
  • payout_to_card_fees
  • payment_gateway_fees
  • rolling_reserve_amount
  • tax
  • admin_fees
  • general_adjustments
{
  "count": 1,
  "data": [
    {
      "id": "270903C203347",
      "period_start": "2019-06-20T00:00:00.000",
      "period_end": "2019-06-23T23:59:59.000",
      "date": "2019-06-28T00:00:00.000",
      "payouts": [
        {
          "currency": "GBP",
          "carried_forward_amount": -28242.06,
          "current_period_amount": -10925.15,
          "net_amount": -39167.21,
          "date": "2019-06-28T00:00:00.000",
          "period_start": "2019-06-20T00:00:00.000",
          "period_end": "2019-06-23T23:59:59.000",
          "id": "FSTBC82N7",
          "status": "Carried Forward",
          "payout_fee": 0,
          "current_period_breakdown": {
            "processed_amount": 44364.87,
            "refund_amount": -2686.95,
            "chargeback_amount": 0,
            "payouts_to_card_amount": -52367.29,
            "processing_fees": -235.78,
            "processing_fees_breakdown": {
              "interchange_fees": -102.18,
              "scheme_and_other_network_fees": -24.31,
              "premium_and_apm_fees": -44.37,
              "chargeback_fees": 0,
              "payout_to_card_fees": -52.36,
              "payment_gateway_fees": -12.56
            },
            "rolling_reserve_amount": 0,
            "tax": 0,
            "admin_fees": 0,
            "general_adjustments": 0
          }
        }
      ]
    }
  ]
}

2. Statement ID / Payments

This extension allows you to link payments to statements and payouts. This will allow you to retrieve the list of payments and associated fees included in a given statement or payout that has been deposited into your bank account, or a specific payout currency.

There are three available parameters in the request for this endpoint, described below:

Filter
Parameter

Statement ID

https://api.checkout.com/reporting/statements/{StatementId}/payments

You can find your statement ID on your statement, which is available in the Hub.

Payout ID

https://api.checkout.com/reporting/statements/{StatementId}/payments?payout_id={PayoutId}

This is the reference of your payout.

Payout currency

https://api.checkout.com/reporting/statements/{StatementId}/payments?payout_currency={PayoutCurrency}

The payout currency must be given in the 3-letter ISO format (e.g., GBP).

CSV download

In addition to the JSON format described above, you can download a CSV report containing data from the statements endpoint.

If you are using Postman or an equivalent application, rather than sending the GET request, use the Send and Download functionality to download the CSV report.

Statements endpoint

Statement only

In the URL for the statements endpoint, add /download after /statements.
For example:
http://api.checkout.com/reporting/statements/download?from={start-date-time}&to={end-date-time}

Statement with payout breakdown

To include the payout breakdown, add &include=payout_breakdown at the end of the previous URL.
For example:
http://api.checkout.com/reporting/statements/download?from={start-date-time}&to={end-date-time}&include=payout_breakdown

Statement ID/payments

In the URL for statement ID/payments, add /download after payments.
For example:
https://api.checkout.com/reporting/statements/{StatementId}/payments/download

For more information about the parameters available for this endpoint, see this section.

Can we help?

Thanks for using Checkout.com. If you need any help or support, then message our support team at support@checkout.com.

Statements endpoint


Suggested Edits are limited on API Reference Pages

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