Skip to main content
GET
Download the pay run report

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id
string

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: 128

Path Parameters

run_id
string
required

Pay run id (run_…).

Pattern: ^run_[0-9A-HJKMNP-TV-Z]{26}$

Query Parameters

format
enum<string>
default:pdf

File format.

Available options:
pdf,
csv

Response

Signed download link.

A signed, short-lived download link.

object
string
required

Always file_link.

Allowed value: "file_link"
url
string<uri>
required

Signed URL. Valid for 5 minutes.

expires_at
string<date-time>
required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

filename
string

Suggested file name.

content_type
string

MIME type.