Report generated

Last updated: February 5, 2025

This event occurs when a scheduled report is generated and available to retrieve.


1{
2  "id":"evt_jaudu78q7duakmcakady18djass",
3  "type":"report_generated",
4  "version":"1.1.0",
5  "created_on":"2024-07-10T15:24:13.8431084Z",
6  "data":{
7    "report_id":"rpt_bzhlovfpy32e3fbveixijllwfe",
8    "report_type":"FinancialActions",
9    "files":[
10      "my-entity-name/reports-my-entity-name/.../file_01.csv",
11      "my-entity-name/reports-my-entity-name/.../file_02.csv"
12    ],
13    "api_resources":{
14      "report":{
15        "id":"rpt_bzhlovfpy32e3fbveixijllwfe",
16        "url":"https://api.checkout.com/reports/rpt_bzhlovfpy32e3fbveixijllwfe"
17      },
18      "files":[
19        {
20          "id":"file_j7pzfrawcyoep7stxmln25psu",
21          "url":"https://api.checkout.com/reports/rpt_bzhlovfpy32e3fbveixijllwfe/files/file_j7pzfrawcyoep7stxmln25psu"
22        }
23      ]
24    },
25    "account":{
26      "client_id":"cli_urq524lg2lzevf6qapnfwrvyee",
27      "entity_id":"ent_r7nge7vl53crsa3ozjxzoiykj4"
28    },
29    "tags":[
30      "payout_id:AB00012"
31    ]
32  },
33  "_links":{
34    "self":{
35      "href":"https://api.checkout.com/workflows/events/evt_jaudu78q7duakmcakady18djass"
36    }
37  }
38}

Field name	Description
`id` string	The unique identifier for the event, prefixed by `evt_`.
`type` string	The type of event. This value is `report_generated`.
`version` string	The version of the webhook.
`created_on` datetime	The date and time when the event was triggered, in UTC. Format – ISO 8601 code Example – `yyyy-mm-ddThh:mm:ss.sss`
`data` object	The notification payload.
`data.report_id` string	The unique identifier for the report, prefixed by `rpt_`.
`data.report_type` string	The type of report. This can be one of: `Authentication` – The Authentication Report `BalanceBreakdown` – The Balance Breakdown Report `Balance` – The Balance Report `BankPayouts` – The Bank Payouts Report `CardPayouts` – The Card Payouts Report `Disputes` – The Disputes Report `FinancialActions` – The Financial Actions by Date Range Report `FinancialActionsByPayout` – The Financial Actions by Payout ID Report `FraudDetection` – The Fraud Detection Report `IssuingAuthorizations` – The Issuing: Authorizations Report `IssuingCards` – The Issuing: Cards Report `IssuingChargebacks` – The Issuing: Chargebacks Report `IssuingDisputeLifecycle` – The Issuing: Dispute Lifecycle Report `IssuingPresentments` – The Issuing: Presentments Report `IssuingSettlementActivity` – The Issuing: Settlement Activity Report `IssuingSettlementSummary` – The Issuing: Settlement Summary Report `Payments` – The Payments Report `PayoutSummary` – The Payouts Report `RealTimeAccountUpdater` – The Real Time Account Updater Report `ReportedFraudulentTransactions` – The Reported Fraudulent Transactions Report `Retrievals` – The Retrievals Report `SettlementBreakdown` – The Settlement Breakdown Report `SettlementStatement` – The Settlement Statement
`data.files` array of strings	Contains the report as one or more CSV files.
`data.api_resources` object	Contains information for retrieving the report and report files using the API.
`data.api_resources.` `report` object	Contains information for retrieving the report using the API.
`data.api_resources.` `report.id` string	The unique identifier for the report, prefixed by `rpt_`.
`data.api_resources.` `report.url` string	The URL for retrieving the report using the Get report details endpoint.
`data.api_resources.` `files` object	Contains information for retrieving a specific report file using the API.
`data.api_resources.` `files.id` string	The unique identifier for the report file, prefixed by `file_`.
`data.api_resources.` `files.url` string	The URL for retrieving the report file using the Get report file endpoint.
`data.account` object	Contains information about the Checkout.com account the report relates to.
`data.account.` `client_id` string	The unique identifier for your Checkout.com client account, prefixed by `cli_`.
`data.account.` `entity_id` string	The unique identifier for the entity the report relates to, prefixed by `ent_`.
`data.tags` string	The unique identifier for the settlement the report relates to, as it appears on your bank statement, prefixed by `payout_id:`. This is only included for the Financial Actions by Payout ID Report and the Settlement Breakdown Report.
`_links` object	Contains links relating to the event.
`_links.self.href` string	The URL for the event.

Report generated

Example webhook

Webhook fields