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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Account status details

string
required
length ≤ 200

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.

string
enum
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.
Allowed:
string
length ≤ 500

Account status description

boolean

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.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json