PIpismo
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

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

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_operations'ALL_OPERATIONS' | 'CREDIT_ONLY' | 'DEBIT_ONLY' | 'NO_OPERATIONS' required

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.
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": "ALL_OPERATIONS",
  "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_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.

Example response

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

Changes

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