Embedded Payments

Close an account for your client

You can request to close a client's limited account(s). Before making this request, you should move the funds out of the account. To close a client account:

You send a closure request with closure reason. Upon receiving the request, it moves the account to PENDING_CLOSE. A general restriction is automatically applied to the account to prevent new transactions while the closure is in progress. The type of restriction depends on the account balance at the time of the request. You will receive a webhook notification for account restriction placed on the account.

Balance greater than zero: CREDITS restriction (blocks incoming funds so the balance can be drawn down).
Balance less than zero: DEBITS restriction (blocks outgoing funds so the balance can be brought to zero).
Balance equal to zero: DEBIT_CREDIT restriction (blocks all transactions).

Once the funds are moved and the account state is changed to closed; you will receive an ACCOUNT_CLOSED webhook notification (and a corresponding ACCOUNT_RESTRICTION notification for the restriction applied during closure.)

Account states

OPEN: Account is active and operational.
PENDING_CLOSE: Account closure has been initiated; manual steps are pending.
CLOSED: Account is fully closed; no further transactions allowed.

Account closure reasons

When requesting account closure, you must specify a reason:

Account closure reason
Reason	Definition
Elective	The account holder has requested the closure of the account for business or personal reasons.
Subjected to Fraud	The account is closed due to suspected or confirmed fraudulent activity.
Overdraft	The account is closed due to unresolved overdraft status
Dormancy	The account is closed due to inactivity.

Sample request:

Json

{
  "state": "CLOSED",
  "closureReason": "ELECTIVE"
}

Sample response:

Json

{
  "id": "dc2eda9084bf40b7a1d8baa8c5e0ea0ax",
  "state": "PENDING_CLOSE",
  "closureReason": "ELECTIVE"
}

Request fields

state: Desired account state. Set to CLOSED to initiate closure.
closureReason: Reason for account closure.
- Possible values: Elective, Subjected to Fraud, Overdraft, Dormancy and Other.

Note

Both fields are required and must match allowed values.

Response fields

id: Unique identifier for the account.
state: Current account state after the closure request (typically PENDING_CLOSE).
closureReason: Reason for account closure.

Note

The response confirms the closure process has started. The account state is set to PENDING_CLOSE.

Error responses

ACCOUNT_HAS_NON_ZERO_BALANCE: Account cannot be closed due to an outstanding balance. The account balance must be zero to allow closure.
ACCOUNT_ALREADY_CLOSED: Account is already closed.
OPERATION_NOT_SUPPORTED: This operation is only supported for accounts with either of these categories:
- LIMITED_DDA
- LIMITED_DDA_PAYMENTS