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

Get Report by ID

  • Updated on Aug 6, 2025
  • Published on Jul 23, 2025
Prev Next
Get
/reports/{report_id}

Request this endpoint to get single specific report details by report id. You can use this endpoint as alternative compared to using the report callback.

Security
HTTP
Type basic

API Key authentication using HTTPS Basic Auth. Use your API key as the username. The password field can be left empty. Note: In the API documentation "Try it" section, password is required, you may include any value.

Path parameters
report_id
stringRequired

Unique ID generated by Xendit for the particular report

Responses
200

Successful operation

getReport
{
  "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",
  "url": "https://transaction-report-files.s3-us-west-2.amazonaws.com/{report_name}",
  "currency": "IDR",
  "business_id": "5f34f60535ba7c1c0eed846a",
  "created": "2021-06-24T04:01:55.570Z",
  "updated": "2021-06-24T04:01:55.570Z"
}
Expand All
object
id
string

Report ID

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)

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

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

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"
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.

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

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.

400

Inputs are failing validation. The errors field contains details about which fields are violating validation.

object
error_code
string
Valid values[ "API_VALIDATION_ERROR", "FEATURE_NOT_AVAILABLE" ]
message
string
errors
Array
OneOf
string
string
object
object
404

The provided id does not exist. Please review the id and try again

object
error_code
string
Valid values[ "RATE_LIMIT_EXCEEDED" ]
message
string
errors
Array
OneOf
string
string
object
object