Skip to main content
GET
List claimable payouts

Authorizations

Authorization
string
header
required

Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/redeem. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy.

Query Parameters

status
enum<string>

Filter by status Status of a claimable payout. Grid holds the amount against the sender's Embedded Wallet balance and the agent's spending limits from creation until the payout is PAID, or releases it when the payout ends in any other status.

Available options:
PENDING_APPROVAL,
AWAITING_CLAIM,
CLAIMED,
PAID,
EXPIRED,
CANCELLED,
FAILED
limit
integer
default:20

Maximum number of results to return (default 20, max 100)

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

Cursor for pagination (returned from previous request)

Response

Successful operation

data
object[]
required

The claimable payouts on this page.

hasMore
boolean
required

Whether more results exist past this page.

nextCursor
string

Cursor for the next page.