Skip to main content
GET
List transfer batches

Authorizations

Authorization
string
header
required

Query Parameters

status
enum<string>[]

Statuses to filter by. One or more of pending_authorization, rejected, expired, in_progress, succeeded, partially_succeeded, and failed. Returns the batches whose status matches any of the values you provide.

Available options:
pending_authorization,
rejected,
expired,
in_progress,
succeeded,
partially_succeeded,
failed
since
string<date-time>

Lower bound for the creation date. Returns batches created on or after this ISO 8601 datetime in UTC.

Example:

"2026-01-01T00:00:00Z"

until
string<date-time>

Upper bound for the creation date. Returns batches created on or before this ISO 8601 datetime in UTC.

Example:

"2026-03-31T23:59:59Z"

starting_after
string

Cursor that fetches the next page of batches. Use the ID of the last batch from the current page.

Example:

"trbatch_2rNxBkOrlHoOYsZTyQYhA0o8Ek0"

ending_before
string

Cursor that fetches the previous page of batches. Use the ID of the first batch from the current page.

Example:

"trbatch_2rNxBkOrlHoOYsZTyQYhA0o8Ek0"

limit
integer

Maximum number of batches to return per page. Ranges from 1 to 300. Defaults to 30.

Example:

50

Response

List of transfer batches for the current mode.

id
string
required

Unique identifier of the transfer batch.

Example:

"trbatch_2daFu0zqqDtZGJaSi2TGI2Mm1nN"

object
any
required

Type of the object. Always transfer_batch.

amount
integer
required

Sum of the amounts of the transfers in the batch, in the smallest currency unit. For MXN this is centavos; CLP has no minor unit.

Example:

150000

authorized_at
string<date-time> | null
required

Time the batch was approved from the Dashboard, as an ISO 8601 datetime in UTC, or null.

Example:

"2026-03-01T12:05:00Z"

created_at
string<date-time>
required

Time the batch was created, as an ISO 8601 datetime in UTC.

Example:

"2026-03-01T12:00:00Z"

currency
enum<string>
required

Currency of the transfers in the batch. One of CLP, MXN.

Available options:
CLP,
MXN
Example:

"MXN"

description
string
required

Human-readable label for the batch. Up to 40 characters.

Example:

"Supplier payouts March"

expired_at
string<date-time> | null
required

Time the batch expired without approval, as an ISO 8601 datetime in UTC, or null.

Example:

null

mode
enum<string>
required

Whether the batch is live or test data.

Available options:
live,
test
Example:

"test"

partially_succeeded_at
string<date-time> | null
required

Time the batch finished after only some transfers succeeded, as an ISO 8601 datetime in UTC, or null.

Example:

null

rejected_at
string<date-time> | null
required

Time the batch was rejected from the Dashboard, as an ISO 8601 datetime in UTC, or null.

Example:

null

settled_amount
integer
required

Sum of the settled_amount of the transfers in the batch, in the smallest currency unit. For MXN this is centavos; CLP has no minor unit.

Example:

0

status
enum<string>
required

Lifecycle status of the batch. One of pending_authorization (waiting for approval in the Dashboard), rejected (rejected in the Dashboard), expired (not approved in time), in_progress (approved, with transfers being sent), succeeded (every transfer succeeded), partially_succeeded (some transfers succeeded), or failed (no transfer succeeded).

Available options:
pending_authorization,
rejected,
expired,
in_progress,
succeeded,
partially_succeeded,
failed
Example:

"in_progress"

succeeded_at
string<date-time> | null
required

Time every transfer of the batch succeeded, as an ISO 8601 datetime in UTC, or null.

Example:

null

succeeded_count
integer
required

Number of transfers in the batch that succeeded.

Example:

0

transfer_count
integer
required

Number of transfers in the batch.

Example:

3