Block Account

Blocks an account completely: no credits and no debits are accepted until it is unblocked with POST /core/account/unblock.

POST /core/account/block

Request Body

Field Name	Type	Required	Description
nuban	string	true	The account number (NUBAN) of the account.
reasonForBlock	string	true	Why the account is being restricted. Maximum 100 characters.

Response

The response is the result of the operation.

Field Name	Type	Description
savingsId	integer	Unique identifier of the savings account that was changed.
clientId	integer	Unique identifier of the account holder.
officeId	integer	Office the account belongs to.
resourceId	integer	Same as `savingsId`.

Blocking an account that is already fully blocked succeeds without change. Use /core/account/block-credit to stop credits only.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Body Params application/json

Example

{
  "nuban": "0123456789",
  "reasonForBlock": "Suspected fraud - customer request"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "officeId": 1,
  "clientId": 101,
  "savingsId": 54,
  "resourceId": 54
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Block Account

Block Account#

Request Body#

Response#

Request

Request Code Samples

Responses

Block Account

Request Body

Response