Skip to main content

Initiate a closure request for an account

POST /api/v1/Accounts/closure-request/initiate

Description​

This endpoint allows you to initiate a closure request for an account.

Request​

  • Headers:
  • Accept-Language: Change default response message language from English(en). Available languages fr,en
  • Request Body: InitiateAccountClosureRequest

Responses

  • 200: Success. Returns an AccountClosureResponseResponse.
  • 400: Bad Request. The request is not valid.
  • 404: Not Found. The requested account or transactions were not found.

Examples​

Request

HTTP

httpCopy codePOST /api/v{version}/Accounts/closure-request/initiate HTTP/1.1
Host: example.com
Accept-Language: en
Content-Type: application/json
{
  "id": "123",
  "action": "INITIATE"
}

Response

JSON

jsonCopy codeHTTP/1.1 200 OK
{
  "id": "123",
  "status": "INITIATED"
}

Error Response

JSON

jsonCopy codeHTTP/1.1 404 Not Found
{
  "message": "Account not found."
}

Headers​

----------------------------------Accept-Language Change default response message language from English(en). Available languages fr,en Content-Type application/json

Accept text/plain

Body raw(json) -------------------------------curlUrl: "/api/v1/Accounts/closure-request/initiate" curlMethod: POST​

{
  "accountId": `<string>`,
  "reasonForClosure": 4
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/Accounts/closure-request/initiate \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!