Skip to main content
GET
List beneficiaries created or referenced by a batch

Authorizations

DPoP
string
header
required

Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.

Path Parameters

id
string
required
Pattern: ^bat_[a-zA-Z0-9]+$

Query Parameters

limit
integer
default:20

Items per page. Maximum 100.

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

Opaque cursor returned by a previous list response. Omit for the first page.

Response

Beneficiaries associated with this batch.

data
object[]
required

Array of results for this page. Element schema varies by endpoint.

has_more
boolean
required

Whether more results exist beyond this page.

next_cursor
string

Cursor for the next page. Present only when has_more is true.