Close Account

Use this endpoint for closing a customer's account by passing the accountNumber and closureReason in the request body.

POST /api/postings/v1/closeaccount

You can also pass a GUID to the instrumentNumber parameter, but a generated GUID reference will be created by default if you don't provide one. This request does not deactivate a customer account. To deactivate a customer account, use the Deactivate Customer Account API.

Headers

Name
Value

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique_reference}

Body

Name
Data Type (length)
Required
Description

accountNumber

string (150)

The account number that needs to be closed

closureReason

string (150)

The reason for closing the account. Suggested Options: i. Customer's request ii. Regulatory requirement iii. Fraud related concern iv. Court order v. Duplication vi. Management discretion

instrumentNumber

string (150)

Instrument number for tranasction status associated with the account closure If empty, a globally unique identifier (GUID) is generated by default

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request
curl --location -g '{{baseurl}}/api/postings/v1/closeaccount' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--data '{
  "accountNumber": "string",
  "closureReason": "string",
  "instrumentNumber": "string"
}'

Response

{
  "status": true,
  "message": "string",
  "data": {
    "statusCode": "string",
    "referenceNumber": "string",
    "instrumentNumber": "string",
    "duration": "string"
  }
}

Last updated