Close an account

POST

/closeAccount

Accounts

Closes an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the payments are sent to your liable account.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/closeAccount' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountCode": "string"
}'

Response Example

200 - Example 1

{
  "accountCode": "string",
  "invalidFields": [
    {
      "errorCode": 0,
      "errorDescription": "string",
      "fieldType": {
        "field": "string",
        "fieldName": "accountCode",
        "shareholderCode": "string"
      }
    }
  ],
  "pspReference": "string",
  "resultCode": "string",
  "status": "Active"
}

Request

Body Params application/json

accountCode

string

required

The code of account to be closed.

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

accountCode

string

optional

The account code of the account that is closed.

invalidFields

array[object (ErrorFieldType) {3}]

optional

Contains field validation errors that would prevent requests from being processed.

errorCode

integer <int32>

optional

The validation error code.

errorDescription

string

optional

A description of the validation error.

fieldType

object (FieldType)

optional

The type of error field.

pspReference

string

optional

The reference of a request. Can be used to uniquely identify the request.

resultCode

string

optional

The result code.

status

enum<string>

optional

The new status of the account.

Permitted values: Active, Inactive, Suspended, Closed.

Allowed values:

ActiveClosedInactiveSuspended

🟢202Accepted - the request has been accepted for processing, but the processing has not been completed.

🟠400Bad Request - a problem reading or understanding the request.

🟠401Unauthorized - authentication required.

🟠403Forbidden - insufficient permissions to process the request.

🟠422Unprocessable Entity - a request validation error.

🔴500Internal Server Error - the server could not process the request.

Modified at 2023-08-15 06:33:33

Upload a document

Create an account