Get Sandbox Keys
API Reference

Block / Unblock Account

post
https://api.cloud.mbanq.com/v1/savingsaccounts/?command=block

Use this API to block or unblock an active savings account for a client, either fully or only for credits (incoming money) or debits (outgoing money).

All actions use the same endpoint and are selected with the command query parameter.

CommandDescriptionRequest Body
blockBlocks all activity on the account.blockReasonCodeId (optional), note (optional)
unblockRemoves a full account block.reason (optional)
blockcreditBlocks credits (deposits / incoming transfers) to the account.None
unblockcreditRemoves a credit block from the account.None
blockdebitBlocks debits (withdrawals / outgoing transfers) from the account.None
unblockdebitRemoves a debit block from the account.None

The command value is case-insensitive (e.g. BLOCK and block are equivalent).

Prerequisites

  • The account must be in Active status.
  • The account must not be a sub-account.
  • The client owning the account must be active.
  • blockcredit and blockdebit fail if the account is already fully blocked (sub-status BLOCK).
  • unblockcredit requires credits to be blocked (sub-status BLOCK_CREDIT or BLOCK); unblockdebit requires debits to be blocked (sub-status BLOCK_DEBIT or BLOCK).

Sub-Status Transitions

CommandCurrent Sub-StatusNew Sub-Status
blockAnyBLOCK
unblockBLOCKNONE
blockcreditNONEBLOCK_CREDIT
unblockcreditBLOCK_CREDITNONE
blockdebitNONEBLOCK_DEBIT
unblockdebitBLOCK_DEBITNONE

Example Requests

  • POST /v1/savingsaccounts/{accountId}?command=block
  • POST /v1/savingsaccounts/{accountId}?command=unblock
  • POST /v1/savingsaccounts/{accountId}?command=blockcredit
  • POST /v1/savingsaccounts/{accountId}?command=unblockcredit
  • POST /v1/savingsaccounts/{accountId}?command=blockdebit
  • POST /v1/savingsaccounts/{accountId}?command=unblockdebit

Effects of Blocking

  • block: The account sub-status changes to BLOCK. All cards linked to the account are suspended and their status changes to SUSPENDED.
  • unblock: The account sub-status is cleared. Cards that were suspended because of the account block are re-activated. If a reason is provided, it is saved as an account note.

For the supported values for Account Status, see: Account Status

For detailed account features, see: Accounts Features

FunctionWebhook
Block AccountBlock Account
Path Params
integer
required
Defaults to 1

The Id associated with the account
Example : 123

Query Params
string
enum
required
Defaults to block

The action to perform on the account. Supported values: block, unblock, blockcredit, unblockcredit, blockdebit, unblockdebit (case-insensitive).
Example : block

Allowed:
Body Params

The request body depends on the command:

  • block: blockReasonCodeId and note (both optional).
  • unblock: reason (optional).
  • blockcredit, unblockcredit, blockdebit, unblockdebit: no body is required (send {} or omit it).
Headers
string
required

The ID of your banking instance visible in the MBANQ Console.

Responses

Updated 6 months ago

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

Updated 6 months ago

Did this page help you?