Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Earmarking (external accounts)

Create earmark

Create an earmark. An account holder can use an earmark to hold needed funds in reserve until a specified release date and time.

Optionally, the account holder can schedule a payout for the release date and time. At that time, an automatic process releases the earmarked funds and settles the payout.

It's possible to force the creation of an earmark by not performing any regular validations, such as account status, account balance, or flex controls validations.

This endpoint generates the following events:

NOTES:

  • This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.
post/corporate/v2/earmarks

Request body

OR

Example request

{
  "amount": 50,
  "internal_operation": {
    "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
    "business_date": "2023-03-09",
    "validation_rules": {
      "ACCOUNT_STATUS": {
        "override": false
      },
      "LEDGER": {
        "force": false
      },
      "FLEX_CONTROLS": {
        "override": true
      },
      "RATES": {
        "override": true
      }
    }
  },
  "external_account_id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
  "earmark_id": "da85b309-a7f7-4316-b2ad-f069f0838058",
  "release_datetime": "2022-02-10T15:00:00Z"
}

Response

Created

earmark_idstring

Earmark ID. Used as the primary key for query and update operations. It has the same value as the tracking ID, if one is provided. Generated by Create Earmark.

account_idinteger

Account ID generated by Create Corporate Account.<br> minimum: 1 maximum: 4294967295

external_account_idstring

External ID of the account on which the earmark is created. Should be the same external_account_id that was used to log in. Should be the same external_account_id used in Create Corporate Account.

descriptionstring

Earmark description

amountnumber float

Earmark amount<br> minimum: 0.01 maximum: 18446744073709551617

balancenumber

Earmark balance. Initially equal to the earmarked amount and decreases as the reserved funds are used up or decreased in a decrease operation. It can also increase if an increase operation is performed.<br> minimum: 0 maximum: 18446744073709551617

release_datetimestring date-time

RFC 3339 date/time for earmark release. Used to schedule a cash-out (usually a payment) at the specified release date and time. At release_datetime, an automatic process releases the earmarked funds and settles the cash-out. If no release_datetime is set, the earmarked amount is held indefinitely until the customer cancels the earmark.

Example response

{
  "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"
    }
  ]
}