List claimable payouts

List the claimable payouts the authenticated agent sent, newest first.

GET /agents/me/claimable-payouts

List claimable payouts

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/agents/me/claimable-payouts \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "ClaimablePayout:019542f5-b3e7-1d02-0000-000000000077",
      "agentId": "Agent:019542f5-b3e7-1d02-0000-000000000042",
      "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000010",
      "platformCustomerId": "user-a1b2c3",
      "status": "PENDING_APPROVAL",
      "sourceAccountId": "InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
      "amount": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "recipient": {
        "name": "Maria",
        "phoneNumber": "[phone]",
        "email": "[e-mail]",
        "country": "PH"
      },
      "expiresAt": "2025-10-10T15:00:00Z",
      "createdAt": "2025-10-03T15:00:00Z",
      "updatedAt": "2025-10-03T15:02:00Z",
      "note": "Happy birthday, Mom",
      "agentActionId": "AgentAction:019542f5-b3e7-1d02-0000-000000000099",
      "externalAccountId": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
      "transactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000030",
      "receivedAmount": {
        "amount": 12550,
        "currency": {
          "code": "USD",
          "name": "United States Dollar",
          "symbol": "$",
          "decimals": 2
        }
      },
      "paymentRail": "ACH",
      "failureReason": "INSUFFICIENT_FUNDS"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

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.

Status	Description
PENDING_APPROVAL	Waiting for the customer to approve the agent's request. No claim token can be issued yet
AWAITING_CLAIM	Approved; the recipient can claim it with a claim token until expiresAt
CLAIMED	The recipient confirmed a locked quote and Grid is paying her
PAID	The payout reached the recipient's account
EXPIRED	Not claimed by expiresAt, or not approved in time. The hold is released
CANCELLED	Cancelled by the agent, or rejected by the customer. The hold is released
FAILED	The payout could not be made; see failureReason. The hold is released

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

200

application/json

Successful operation

data · object[] · required

The claimable payouts on this page.

Show child attributes

hasMore · boolean · required

Whether more results exist past this page.

nextCursor · string

Cursor for the next page.