Use **Report runs** operations to generate CSV reports of your Merchant account transactions. Choose from the following report types based on your use case:| Report type | Description || ----------- | ----------- || `custom_report` | Settled and processing transactions with a configurable set of columns. || `settlement_report` | All settled transactions, with a configurable set of columns. || `payments_report` | All payments, including failed and declined ones. || `payout_statement_report` | All transactions that contributed to a specific payout. || `icpp_fee_breakdown_report` | IC++ fee components broken down per transaction for a specific IC++ charge. |:::infoFor more information about how to generate CSV reports, see: [Create CSV reports of transactions](https://developer.revolut.com/docs/guides/merchant/monitor-and-observe/reports-reconciliation).:::
Revolut Report runs API is one of 46 APIs that Revolut publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Report runs. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
3 operations
across 3 paths,
and defines 33 schemas.
It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against 2 base URLs: https://b2b.revolut.com/api/1.0, https://sandbox-b2b.revolut.com/api/1.0.
3 operations3 paths33 schemas2 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://b2b.revolut.com/api/1.0
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Revolut Report runs API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessToken).
AccessToken — Each Business API request must contain an authorization header in the following format to make a call: Bearer . The access token will be obtained the first tim…
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Report runs 3
Use Report runs operations to generate CSV reports of your Merchant account transactions. Choose from the following report types based on your use case: | Report type | Descriptio…
POST
/api/report-runs
Create a report run
createReportRun1 parambody→ 201400401404
GET
/api/report-runs/{report_run_id}
Retrieve a report run
retrieveReportRun2 params→ 200400401404
GET
/api/report-runs/{report_run_id}/file
Download report file
downloadReportFile2 params→ 200400401404
Schemas 33
The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Report-Run-Csv-Custom (64 properties), Report-Run-Csv-Payout (31 properties), Report-Run-Csv-Payments (26 properties), Report-Run-Csv-Settlement (24 properties). Each schema is shown below with its type and property counts.
Report-Run-Currency
string
Select transactions with specific currencies to include in the report. Provide [ISO 4217](https://en.wikipedia.org/wiki/ISO4217) currency code in upper case. :…
Report-Run
object
The ReportRunDetails object contains all information associated with a specific report run, identified by the reportrunid.
3 properties2 required
Report-Run-Custom-Options
object
Further options to customise the report.
2 properties
Icpp-Charge-Id
string
Permanent ID of of the IC++ fee related to a payout transaction. This ID can be obtained from the relatedicppchargeid column of a payout statement report.
Report-Run-From
string
This parameter specifies the start boundary for filtering report data. It accepts ETC/UTC date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO8…
Report-Run-Csv-Payments
object
CSV output for paymentsreport report type. Contains all payments including failed and declined ones. The first row is a header row with column names. Subsequen…
26 properties
Report-Run-Icpp-Options
object
Further options to customise the report.
2 properties
Error-v2
object
3 properties
Report-Run-Csv-Custom
object
CSV output for customreport report type. Contains settled and processing transactions with a configurable set of columns. The first row is a header row with co…
64 properties
Report-Run-Settlement-Options
object
Further options to customise the report.
2 properties
Report-Run-Location-Id
string
Select transactions by location ID to be included in the report. :::info For more information, see: [Locations](https://developer.revolut.com/docs/api/merchant…
Report-Run-Format
string
Format of the generated report file.
Report-Run-Csv-Payout
object
CSV output for payoutstatementreport report type. Contains all transactions that contributed to a specific payout. The first row is a header row with column na…
31 properties
Report-Run-Filter
object
Filtering parameters to be applied to the report. :::note For settlementreport and customreport, from and to are evaluated against the transaction createddate,…
6 properties2 required
Report-Run-Custom-Report
object
A custom report contains all the query information for generating reports of selected transactions associated with a Merchant account.
4 properties3 required
Report-Run-Entity-States
array
Select transactions by state to be included in the report. | Value | Description | | ----- | ----------- | | completed | Include transactions that reached thei…
Report-Run-Settlement-Report
object
A settlement report contains all the query information for generating reports of settled transactions associated with a Merchant account.
4 properties3 required
Report-Run-Icpp-Filter
object
Filtering parameters to be applied to the report.
1 property1 required
Report-Run-Payments-Options
object
Further options to customise the report.
2 properties
Report-Run-Type
string
Type of the report. | Report type | Description | | -------------- | ----------- | | settlementreport | All settled transactions associated with a Merchant acc…
Report-Run-Payout-Filter
object
Filtering parameters to be applied to the report.
1 property1 required
Report-Run-Payout-Report
object
A payout statement report contains all the query information for generating reports of a selected payout associated with a Merchant account.
4 properties3 required
Report-Run-Icpp-Report
object
A IC++ fee breakdown report contains all the query information for generating reports of fees for each IC++ transaction related to a payout.
4 properties3 required
Report-Run-To
string
This parameter specifies the end boundary for filtering report data. It accepts ETC/UTC date and time in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO860…
Payout-Id
string
Permanent payout ID used for payouts operations.
Report-Run-Payments-Report
object
A payments report contains all the query information for generating reports of payments associated with a Merchant account, including failed and declined payme…
4 properties3 required
Report-Run-Payments-Filter
object
Filtering parameters to be applied to the report. :::note For paymentsreport, from and to are evaluated against the payment createddate. The captureddate colum…
3 properties2 required
Report-Run-Timezone
string
Defaults to ETC/UTC. Defines the output timezone for all timestamps displayed in the report. Has no effect on from or to parameters.
Report-Run-Csv-Settlement
object
CSV output for settlementreport. Contains settled transactions associated with a Merchant account. The first row is a header row with column names. Subsequent…
24 properties
Report-Run-Entity-Types
array
Select source entity families to be included in the report. | Value | Description | | ----- | ----------- | | payment | Include rows originating from payment s…
Report-Run-Csv-Icpp
object
CSV output for icppfeebreakdownreport report type. Contains IC++ fee components broken down per transaction for a specific IC++ charge. The first row is a head…
19 properties
Report-Run-Payments-Entity-States
array
Select payments by state to be included in the report. | Value | Description | | ----- | ----------- | | completed | Include payments that completed successful…
Report-Run-Payout-Options
object
Further options to customise the report.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
