Activate or deactivate an account

patch

https://api.qfp.quantnetwork.net/api/accounts/{accountRef}

Sets the account's status. Only ACTIVE and INACTIVE can be requested; PENDING and FAILED are set by provisioning. Accounts are deactivated, not deleted, so an accountRef is never released for reuse. An ACTIVE account can be deactivated, and an INACTIVE one reactivated while its customer is ACTIVE.

PENDING and FAILED accounts cannot be changed. Any other request returns 422 Unprocessable Content. Setting the status an account already has returns it unchanged.

Path Params

accountRef

string

required

length ≤ 128

[A-Za-z0-9._:-]+

The bank's own reference for the account.

Body Params

status

string

enum

required

The statuses a caller may request. PENDING and FAILED are set by provisioning and are rejected with 400 if requested.

Allowed:

Headers

API-Version

string

required

^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

Idempotency-Key

string

required

length ≤ 255

Caller-supplied key making the write at-most-once. Replay semantics are endpoint-specific: customer and account registry writes replay the original response and reject a changed payload with 422; transaction and deployment submissions return the current operation with 200 and ignore a changed payload. See the operation's response documentation. Use one key per intent. Missing, blank or longer than 255 characters is a 400.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The account as it now stands.

400status is missing or outside [ACTIVE, INACTIVE], or the Idempotency-Key header is missing, blank or longer than 255 characters. A status outside the pair is reported against the field name settableStatus.

401Returned once authentication is enforced, when the request carries no Authorization header or an unresolvable token. (planned — not returned today, see the API description.)

404No account exists with that reference.

409An earlier request under the same Idempotency-Key is still running. Carries a Retry-After header with the seconds to wait before retrying.

422The transition is not allowed from the account's current status, including reactivating an account whose customer is INACTIVE, or an earlier request reused this Idempotency-Key with a different payload.

500An unexpected error occurred while handling the request.