Get Sandbox Keys
API Reference

Close Customer

post
https://api.cloud.mbanq.com/v1/v1/clients/

Formally terminate a customer relationship while maintaining full audit integrity. This endpoint allows for the secure closure of a customer record, provided that all financial obligations—including active loans and accounts—have been resolved. By providing a structured offboarding path, it ensures that your customer database remains accurate and compliant with data lifecycle policies.

FunctionWebhook Reference
Close CustomerClose Customer Webhook

Note: Valid reason identifiers for closure can be retrieved via the GET /v1/codes/{codeId}/codevalues endpoint.

Path Params
integer
required
Defaults to 123

The associated customer Id.

Query Params
const
enum
required
Defaults to close

In this case the command value should always be 'close'.

Allowed:
Body Params
string
required
Defaults to 23

The closure reason identifier. Mbanq will provide closure reason details.
To retrieve list of closure reason values,
please use the Get Code Value with code name ClientClosureReason
The accepted values for closure reason Id are:

  1. 23 - BLACKLISTED
  2. 24- DECEASED
  3. 25 - TRANSFERRED
  4. 26 - LEFT
  5. 27 - OTHER

Example: 23

string

The client's closure date.

The date format should be as per the format mentioned in the dateFormat parameter.
Example: '25 June 2023'

string
Defaults to dd MMMM yyyy

If the field 'closureDate' is passed, then this parameter is mandatory. It specifies the dataformat, that's being used.
Example: 'dd MMMM yyyy'

string
Defaults to en

The locale of the client. 'en' will be passed as default.
Example: 'en'

Headers
string
required

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

Responses

Updated 16 days 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 16 days ago

Did this page help you?