Create a new report run

Start generating a new report of the relevant transactions, and receive report_run_id.

After generation is done, use the link in file_url to download the report. Use the Retrieve report run details operation to check the status of the report run.

Request

Header Parameters

Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"

This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.

It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.

Request body

Body any

List of filtering parameters to be applied to the report.

This parameter specifies the start boundary for filtering transaction data in the report based on an order's payments.created_at parameter. It accepts ETC/UTC date and time in ISO 8601 format and includes all transactions created on or after this timestamp.

Combined with the to parameter, this determines the report's timeframe, including all transactions between the two values.

For example, by setting the from parameter to 2021-01-01T00:00:00Z, the report will include transactions created from the first second of January 1, 2021, UTC, and onwards.

This parameter specifies the end boundary for filtering transaction data in the report based on an order's payments.created_at parameter. It accepts ETC/UTC date and time in ISO 8601 format and includes all transactions created before this timestamp (exclusive).

Combined with the from parameter, this determines the timeframe for the report, including all transactions between the two values.

For example, setting the to parameter to 2021-12-31T23:59:59Z will include all transactions in the report created up to, but not including, the last second of December 31, 2021, UTC.

Possible values: [payment, refund, dispute]

Select transactions by type to be included in the report.

Possible values: [completed, failed, declined, processing, cancelled, reverted]

Select transactions by state to be included in the report.

If not provided, only completed transactions will be included in the report.

Possible length: >= 3 characters and <= 3 characters
Example: "GBP"

Select transactions with specific currencies to include in the report. Provide ISO 4217 currency code in upper case.

Select transactions by location ID to be included in the report.

Possible values: [csv]
Example: "csv"

Format of the generated report file.

Possible values: [settlement_report, custom_report, payout_statement_report, icpp_fee_breakdown_report]
Example: "settlement_report"

Type of the report.

Possible values:

Type of report	Description
`settlement_report`	Settlement report is a report including transactions settled to the user account. This parameter sets the predefined `options` and list of represented columns.
`custom_report`	Custom reports require users to define `options`.
`payout_statement_report`	Payout statement Reports provide a detailed breakdown of all transactions contributing to a specific payout amount. It requires the additional parameter `filter.payout_id`, which should be obtained from the payout ID retrieved via the payout list endpoint or from webhook events.
`icpp_fee_breakdown_report`	IC++ fee breakdown reports provide a detailed breakdown of fees for each IC++ transaction related to a payout. It requires the additional parameter `filter.icpp_charge_id`, which should be obtained from the `related_icpp_charge_id` column in the Payout statement report. A separate report should be generated for each IC++ transaction.

Further options to customize the report.

Example: "Europe/London"

Defaults to ETC/UTC. Defines the output timezone for all timestamps displayed in the report.

Has no effect on from or to parameters.

Example: ["transaction_id","amount","metadata.custom_attribute"]

Names of the columns to be included in the report.

If the columns parameter is not defined in the request, all available columns will be included in the report. An empty array will return an error.

If you created orders using the metadata object, you can include them in the report by adding them with metadata. prefix. For example: metadata.custom_attribute.

Available columns:

Column name	Description
`transaction_id`	Unique identifier of the transaction related to an order.
`order_id`	Unique identifier of the order.
`started_date`	Date and time the transaction was created.
`updated_date`	Date and time the transaction was last updated.
`completed_date`	Date and time the transaction was completed.
`type`	Type of the order.
`state`	State of the order.
`description`	Description of the order.
`merchant_order_ext_ref`	Merchant's order identifier for external reference.
`customer_id`	Unique identifier of the customer related to an order.
`amount`	Total amount of the order.
`currency`	The ISO 4217 currency code that represents the currency of the order.
`settlement_amount`	Total amount settled on the merchant's account.
`settlement_currency`	The ISO 4217 currency code that represents the currency of the settled amount.
`fee_amount`	Total amount of extra fees applied to the order.
`fee_currency`	The ISO 4217 currency code that represents the currency of extra fees.
`processing_fee_amount`	Total amount of processing fees applied to the order.
`processing_fee_currency`	The ISO 4217 currency code that represents the currency of processing fees.
`payment_method`	Type of the payment method the customer used to pay for the order.
`browser_url`	The URL where the customer initiated the payment.
`related_icpp_charge_id`	Unique identifier of the IC++ charge related to the transaction. This column is only available in the `payout_statement_report`.
`location_id`	Unique identifier of the location related to the transaction. This column is only available in `settlement_report` and `custom_report`.

Response

Report run created, report started generating

Create a new report run

Request​

Response​

Request

Response