Activate or deactivate a customer

patch

https://api.qfp.quantnetwork.net/api/customers/{customerRef}

Sets the customer's status. Customers are deactivated, not deleted, so a customerRef is never released for reuse. Deactivating a customer also deactivates its ACTIVE accounts; accounts that are PENDING, FAILED or already INACTIVE are not changed. Reactivating a customer does not reactivate them, so each must be reactivated individually.

Setting the status the customer already has returns it unchanged.

Path Params

customerRef

string

required

length ≤ 128

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

The bank's own reference for the customer.

Body Params

status

string

enum

required

Status of a customer. Deactivating a customer deactivates its active accounts; reactivating it does not reactivate them.

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 customer as it now stands.

400status is missing or unrecognised, or the Idempotency-Key header is missing, blank or longer than 255 characters.

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 customer 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 Idempotency-Key was already used for a different payload.

500An unexpected error occurred while handling the request.