List the escrows this account operates

List escrow agreements operated by the authenticated account, newest first.

GET /escrow

List the escrows this account operates

cURL

curl --request GET \
  --url https://api.example.com/escrow \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "status": "draft",
      "availableActions": [
        "approve"
      ],
      "sender": {
        "clientId": "<string>"
      },
      "receiver": {
        "clientId": "<string>"
      },
      "token": "<string>",
      "maxAmount": "500.00",
      "authorizedAmount": "500.00",
      "capturableAmount": "500.00",
      "refundableAmount": "500.00",
      "windows": {
        "approveBy": "2023-11-07T05:31:56Z",
        "holdUntil": "2023-11-07T05:31:56Z",
        "refundableUntil": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "action": {
        "action": "approve",
        "idempotencyKey": "<string>",
        "status": "awaitingSignature",
        "amount": "500.00",
        "feeBps": 123,
        "transactionHash": "<string>",
        "approval": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payload": "<string>",
          "expiresAt": "2023-11-07T05:31:56Z"
        }
      },
      "consistent": true
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Hevn-Account · string | null

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Query Parameters

status · enum<string>[] | null

Available options: draft, authorized, charged, partiallyCaptured, captured, voided, reclaimed, partiallyRefunded, refunded

senderClientId · string | null

receiverClientId · string | null

limit · integer · default: 50

Required range: 1 <= x <= 100

cursor · string | null

Maximum string length: 512

Response

200

application/json

Successful Response

items · EscrowView · object[] · required

Resources in this page, in stable server-defined order.

Show child attributes

nextCursor · string | null

Opaque cursor for the next page; absent when this is the final page.