For archived content, access the previous documentation here or the previous API reference here.

Report webhook notification

  • Updated on Jul 31, 2025
  • Published on Jul 31, 2025
Prev Next
Post
/your_report_webhook_url

Webhook notification that will be sent to your defined webhook url for updates to report generation status.

Header parameters
x-callback-token
string

Verification token that can be used to validate webhook requests

Body parameters

Report generation status callback

Report Generation Completed
{
  "id": "report_068581fd-ff7c-447f-8b16-a2ac00ebf98c",
  "url": "https://transaction-report-files.s3.us-west-2.amazonaws.com/675bdaf542c2f448122e71d5/LIVE_TRANSACTIONS_REPORT_068581fd-ff7c-447f-8b16-a2ac00ebf98c_20250423040155_20250627040155.csv?AWSAccessKeyId=AKIAWDX4EPHWLBHIQYEQ&Expires=1751548921&Signature=nng1ZrXLGtVc7xSJbIigUXabPWs%3D",
  "type": "TRANSACTIONS",
  "filter": {
    "from": "2025-04-23T04:01:55.574Z",
    "to": "2025-06-27T04:01:55.574Z"
  },
  "format": "CSV",
  "status": "COMPLETED",
  "created": "2025-07-02T13:21:31.355Z",
  "updated": "2025-07-02T13:22:01.630Z",
  "currency": "MYR",
  "business_id": "675bdaf542c2f448122e71d5"
}
Report Generation Failed
{
  "id": "report_5c1b34a2-6ceb-4c24-aba9-c836bac82b28",
  "type": "BALANCE_HISTORY",
  "filter": {
    "from": "2021-06-23T04:01:55.574Z",
    "to": "2021-06-24T04:01:55.574Z"
  },
  "format": "CSV",
  "status": "FAILED",
  "created": "2021-06-24T04:01:55.570Z",
  "updated": "2021-06-24T04:01:55.570Z",
  "currency": "IDR",
  "business_id": "5f34f60535ba7c1c0eed846a"
}
Expand All
object
id
string

Report ID

url
string

URL to download after report is completed. The file to download will only be accessible for 24 hours. When the url is expired, you will need to send a new request to generate the report.

type
string

The type of report that will be generated

Valid values[ "BALANCE_HISTORY", "TRANSACTIONS", "UPCOMING_TRANSACTIONS", "DETAILED_TRANSACTIONS" ]
filter
object (ReportFilter)

Filtering that are applied to report

The combination of from and to must be less than 92 days.

from
string (date-time) Required

The start time of the transaction to be filtered (ISO 8601)

Example2025-07-01T00:00:00Z
to
string (date-time) Required

The end time of the transaction to be filtered (ISO 8601)

Example2025-07-31T23:59:59Z
format
string

The format of the report. Available format is CSV.

Valid values[ "CSV" ]
Default"CSV"
status
string
Valid values[ "PENDING", "COMPLETED", "FAILED" ]
created
string

The time when the report request is created at UTC+0.

updated
string

The time when the report is updated at UTC+0.

currency
string

The currency to filter.

Valid values[ "IDR", "PHP", "USD", "VND", "THB", "MYR", "SGD", "EUR", "GBP", "HKD", "AUD" ]
Default"IDR"
business_id
string

Unique ID generated by Xendit for the particular file

Responses
200

OK

400

Bad Request - Invalid webhook payload