Skip to main content
GET
List a batch's rows

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

batch_id
string
required

bat_…

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

Query Parameters

limit
integer
default:25

Page size, 1–100.

Required range: 1 <= x <= 100
after
string

Cursor from the previous page's next_cursor. Returns older items. Don't send with before.

status
string[]

Comma-separated MovementStatus values, e.g. failed.

Example:

Response

A page of the batch's transfers.

Cursor page. Domain files compose this with allOf and set data.items.

object
string
required
Allowed value: "list"
data
object[]
required

Transfers.

has_more
boolean
required

True when another page exists.

next_cursor
string | null

Cursor for the next page in the same direction: pass it as after if this page was read with after (or no cursor), as before if it was read with before. Null when has_more is false.

total_count
integer

Only when include=total_count was sent.