reports.write
scope.Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The ID of the merchant account to use for this request.
"default"
Body
The name of the report.
1 - 100
"Monthly Transaction Report"
The schedule for the report.
daily
, monthly
, once
, weekly
"daily"
Whether the report schedule is enabled.
true
The report specification.
A description of the report.
1 - 1000
"Monthly transaction summary for May 2024."
The timezone for the report schedule.
"UTC"
Response
Successful Response
The unique ID for the report.
"a1b2c3d4-5678-90ab-cdef-1234567890ab"
The merchant account ID this report belongs to.
"merchant-account-12345"
The name of the report.
1 - 100
"Monthly Transaction Report"
The date this report was created at.
"2024-05-30T12:34:56.000Z"
The date this report was last updated.
"2024-05-30T13:00:00.000Z"
The schedule for the report.
daily
, monthly
, once
, weekly
"daily"
Whether the report schedule is enabled.
true
The timezone for the report schedule.
"UTC"
The report specification.
Always report
.
"report"
"report"
The ID of the user who created the report.
"d290f1ee-6c54-4b01-90e6-d701748f0851"
The display name of the report creator.
1 - 1000
"Jane Doe"
The type of the report creator.
user
, private_key
"user"
The next scheduled execution time for the report.
"2024-06-01T00:00:00.000Z"
A description of the report.
1 - 1000
"Monthly transaction summary for May 2024."
The latest execution summary for the report.