Sign in

Close an existing account under an account holder.

This endpoint is used to close an existing account under an account holder. If an account is closed, it may not process transactions or have its funds paid out,and it may not be reopened. Any payments made to a closed account will be directed to the merchant's liable account.

post/closeAccount

Request body

accountCodestring required

The code of account to be closed.

Response

OK - the request has succeeded.

pspReferencestring

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

resultCodestring

The result code.

status'Active' | 'Closed' | 'Inactive' | 'Suspended' required

The new status of the account.

Permitted values: Active, Inactive, Suspended, Closed.

submittedAsyncboolean

Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

  • true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
  • false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.

Changes