PIpismo
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

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/accounts/v4/reasons
  • Auth
    HTTP bearer

Request body

namestring required

Reason name

descriptionstring

Reason description

allowed_operations'ALL_OPERATIONS' | 'CREDIT_ONLY' | 'DEBIT_ONLY' | 'NO_OPERATIONS'

Allowed operations for this status.

Possible values:

  • ALL_OPERATIONS—Both credit and debit operations are allowed.
  • CREDIT_ONLY—Only credit operations allowed.
  • DEBIT_ONLY—Only debit operations allowed.
  • NO_OPERATIONS—Neither account credit nor debit operations allowed.
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": "ALL_OPERATIONS",
  "external_id": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f"
}

Response

Created

reason_idinteger

Reason ID

namestring

Reason name

descriptionstring

Reason description

allowed_operations'ALL_OPERATIONS' | 'CREDIT_ONLY' | 'DEBIT_ONLY' | 'NO_OPERATIONS'

Allowed operations for this status.

Possible values:

  • ALL_OPERATIONS—Both credit and debit operations are allowed.
  • CREDIT_ONLY—Only credit operations allowed.
  • DEBIT_ONLY—Only debit operations allowed.
  • NO_OPERATIONS—Neither account credit nor debit operations allowed.
state'ACTIVE' | 'INACTIVE'

Reason state

external_idstring

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

Example response

{
  "reason_id": 1234567890,
  "name": "Unblocked",
  "description": "Unblocked account after settling the account.",
  "allowed_operations": "ALL_OPERATIONS",
  "state": "ACTIVE",
  "external_id": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f"
}

Changes

No recorded changes to this operation across all 1 revision of this API.