Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Statuses and reasons

Create status

Create an account status on the platform.

When a new account status is created, its initial state (see response) is ACTIVE.

This endpoint generates an Account status created event.

Refer to the Account status guide section for more information.

post/accounts/v4/statuses

Request body

namestring required

Account status name. Pre-defined account statuses include DEBIT_ONLY, NORMAL, BLOCKED and CANCELLED. You can create your own account statuses with the Create status endpoint.

allowed_operationsOperationsBlocksOperation[] required

List of operations allowed to bypass the block enforcement logic.<br>

  • EARMARK_RELEASE: Release an earmark even when an operation block is active.
  • EARMARK_UPDATE: Update an earmark (set amount, increase, or decrease) while the account is blocked by an operation block.
  • PAYMENT_DEBIT: Execute a debit transaction while the account is blocked by an operation block.
  • PAYMENT_CREDIT: Execute a credit transaction while the account is blocked by an operation block.
  • PAYMENT_CONFIRM: Confirm a value transaction while the account is blocked by an operation block.
  • PAYMENT_CANCEL: Cancel an existing transaction while the account is blocked by an operation block.
  • ACCOUNT_STATUS_UPDATE: Change the account status and the associated status reason.
  • CHECK_POST: Post a check while the account is blocked by an operation block.
  • CHECK_RELEASE: Release an uncleared check or operation while the account is blocked by an operation block.
  • CHECK_CANCEL: Cancel an existing check while the account is blocked by an operation block.
  • RESTRICTED_FUNDS_CREATE: Hold a specified amount by transferring it from the available balance to restricted funds.
  • RESTRICTED_FUNDS_RELEASE: Release restricted funds from hold. This transfers funds from restricted funds back to available balance.
descriptionstring

Account status description

is_finalboolean

Is this a final status? An account with a final status cannot have its status updated. Defaults to false.

Note: Even if a status is final, it can still be rolled back.

Example request

{
  "name": "NORMAL",
  "allowed_operations": [
    "EARMARK_CREATE"
  ],
  "description": "Full operational account"
}

Response

Created

status_idinteger

Account status ID

namestring

Account status name. Pre-defined account statuses include DEBIT_ONLY, NORMAL, BLOCKED and CANCELLED. You can create your own account statuses with the Create status endpoint.

descriptionstring

Account status description

state'ACTIVE' | 'INACTIVE'

Status state

is_finalboolean

Is this a final status? An account with a final status cannot have its status updated. Defaults to false.

Note: Even if a status is final, it can still be rolled back.

allowed_operationsOperationsBlocksOperation[]

List of operations allowed to bypass the block enforcement logic.<br>

  • EARMARK_RELEASE: Release an earmark even when an operation block is active.
  • EARMARK_UPDATE: Update an earmark (set amount, increase, or decrease) while the account is blocked by an operation block.
  • PAYMENT_DEBIT: Execute a debit transaction while the account is blocked by an operation block.
  • PAYMENT_CREDIT: Execute a credit transaction while the account is blocked by an operation block.
  • PAYMENT_CONFIRM: Confirm a value transaction while the account is blocked by an operation block.
  • PAYMENT_CANCEL: Cancel an existing transaction while the account is blocked by an operation block.
  • ACCOUNT_STATUS_UPDATE: Change the account status and the associated status reason.
  • CHECK_POST: Post a check while the account is blocked by an operation block.
  • CHECK_RELEASE: Release an uncleared check or operation while the account is blocked by an operation block.
  • CHECK_CANCEL: Cancel an existing check while the account is blocked by an operation block.
  • RESTRICTED_FUNDS_CREATE: Hold a specified amount by transferring it from the available balance to restricted funds.
  • RESTRICTED_FUNDS_RELEASE: Release restricted funds from hold. This transfers funds from restricted funds back to available balance.

Example response

{
  "status_id": 1234567890,
  "name": "NORMAL",
  "description": "Full operational account",
  "state": "ACTIVE",
  "allowed_operations": [
    "EARMARK_CREATE"
  ]
}