v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Earmarking (external accounts)

List earmarks

List all created earmarks, including ones that are canceled or have already been executed.

get/corporate/v1/earmarks

Query parameters

cursorstring

Cursor to the next page of results. If no value is specified, it fetches the first page.

limitinteger

Maximum number of items per page. Defaults to 10

balanceGtnumber float

Filters earmarks whose balance exceeds the specified amount.

balanceGenumber float

Filters earmarks with a balance greater than or equal to the specified amount.

balanceLtnumber float

Filters earmarks with a balance less than the specified amount.

balanceLenumber float

Filters earmarks with a balance less than or equal to the specified amount.

Response

Example response

{
  "earmarks": [
    {
      "earmark_id": "da85b309-a7f7-4316-b2ad-f069f0838058",
      "account_id": 102701621,
      "external_account_id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
      "amount": 50,
      "balance": 123.45,
      "release_datetime": "2022-02-10T15:00:00Z",
      "internal_operations": [
        {
          "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
          "business_date": "2023-03-09",
          "type": "HOLD_FUNDS",
          "processing_code": "99066",
          "amount": 50,
          "validation_rules": {
            "ACCOUNT_STATUS": {
              "override": false
            },
            "LEDGER": {
              "force": false
            },
            "FLEX_CONTROLS": {
              "override": true
            },
            "RATES": {
              "override": true
            }
          },
          "created_at": "2022-02-10T15:00:00Z"
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": 124,
    "has_next": true
  }
}