Sign in

v1

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

Create status reason

Create an account status reason on the platform.

This endpoint generates a Reason created event.

For more information, refer to the Account status guide section.

post/accounts/v4/reasons

Request body

namestring required

Reason name

descriptionstring

Reason description

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.
external_idstring

Client-created ID from an external system or application. REQUIRED for VIRTUAL accounts.

Example request

{
  "name": "Unblocked",
  "description": "Unblocked account after settling the account.",
  "allowed_operations": [
    "EARMARK_CREATE"
  ],
  "external_id": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f"
}

Response

Created

idinteger

Reissue reason identifier. You can get reason IDs using the List reissue reasons endpoint. The must_block flag comes from the reissue reason object.

descriptionstring

Reissue reason description

must_blockboolean

Should a PLASTIC card be canceled upon reissue or can it be used until the new card is activated?

VIRTUAL cards are automatically canceled when reissued, regardless of this setting.

must_chargeboolean

Should the reissue be charged?

This field is information only as only issuers can make debit entries to a customer's account.

costnumber

Reissue card cost

typestring

Issuer-defined reissue reason enum

enabledboolean

Is reason active?

This field is for information only and allows the issuer to provide only active reasons for re-issuance.

Example response

{
  "id": 123,
  "description": "Card was lost by the customer",
  "must_block": true,
  "must_charge": true,
  "cost": 20.5,
  "enabled": true
}