Sign in

v1

latestOpenAPI 3.1.02026-07-201774202.6 KB
Accounts

Close an account

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.

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'

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.