Create earmark

Create an earmark.
An account holder can use an earmark to hold the needed funds in reserve until an specified release date and time.
Optionally, the account holder can schedule a payout for the release date and time.
At the specified date and time, an automatic process releases the earmarked funds and settles the payout.
If no release_datetime is set, the account holder's fund is held indefinitely until the customer calls to cancel.
It is also possible to force an earmark creation by not performing any regular validations, such as account status, account balance, or flex controls validations.

This endpoint produces the follow events:

NOTES:

  • This endpoint requires an account-specific access token. Getting an account token requires you to call the Get OpenID access token endpoint with an external account ID. Tokens can expire quickly, which can result in an unauthorized message.
  • The events Platform authorization created and Transaction created include "corporate_metadata" in the "metadata" and "details" fields respectively. The "corporate_metadata" contains the following fields:
    • debit_external_account_id: The debited account in the creation operation.
    • earmark_id: The created earmark id.
  • The event Earmark created, updated, or canceled only contains internal_operation that refers to the operation performed (Earmark creation).
  • If the account has any reason-based force debit restrictions, the force earmark creation fails. The reasons that restrict force debit operations are:
    • Credit Only - No Force Debit Allowed
    • Any - No Force Allowed
    • Manual - No Force Allowed
  • To get respective reason IDs, refer to the List account status reasons endpoint.
Language
Authorization
Bearer
JWT
Click Try It! to start a request and see the response here!