Block Account and Customer

post

http://localhost:8080/v0/accounts/{accountId}/block

Blocks the account (and by default its owning customer(s)). When the account has child accounts linked (e.g. the FX accounts of a multi-currency wallet), every child is blocked in the same request. The request succeeds when every account in scope ends blocked or closed. The operation is idempotent and can be safely retried.

Path Params

accountId

uuid

required

Unique identifier (UUID) of the Account

Body Params

Body of a request to block an account. (Deprecation Notice: this functionality will be modified in the future releases, check schema for more details).

accountBlockStyle

string

enum

Deprecation Notice: ACCOUNT_AND_CUSTOMER value to be removed.

Deprecation Notice: ACCOUNT_AND_CUSTOMER default value to be removed.

Controls which entities will have block applied.

Use of ACCOUNT_ONLY is encouraged.

Possible values:

ACCOUNT_ONLY (Preferred): Only the account will be blocked.
ACCOUNT_AND_CUSTOMER (Default if no value provided): Both the account and customer(s) owning it will be blocked. It returns SUCCESS in case of partial success (Account blocked, but customer not blocked due to permission issues).

Allowed:

note

string

required

length ≥ 1

Note or explanation for reason block is applied

Responses

Language

Loading…

Response

Choose an example:

application/json

200Success

400Bad Request

403Forbidden

422One or more accounts in scope could not be blocked

500Internal Server Error

501Not Implemented