Pay runs
Download the pay run report
“Report” / “Download summary”: every line, totals, and the deductions to remit with where each goes (remits_to). Signed 5-minute link.
Error codes: invalid_api_key, parameter_invalid, resource_not_found, scope_missing, rate_limited.
GET
Download the pay run report
Authorizations
Server API key, scoped. pk_test_ keys hit the sandbox tenant.
Headers
Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always
our own req_… id. We log your value with the request as client_request_id, so support can find a request by
either id. A longer value is refused with 400 parameter_invalid.
Maximum string length:
128Path Parameters
Pay run id (run_…).
Pattern:
^run_[0-9A-HJKMNP-TV-Z]{26}$Query Parameters
File format.
Available options:
pdf, csv Response
Signed download link.