Close a Ledger


Close a Ledger

A Ledger can be closed using the "Close a Ledger" endpoint.

Closing a Ledger is definitive and it can't be opened again.

A Ledger can only be closed if all the balance fields are equal to zero (totalAmount, availableAmount and reservedAmount)and there is no pending transactions.
A closing reason can be indicated in the reason field.
Request Body schema: application/json
operator
required
string (Operator)
Default: "END_USER"

Description of reason if 'OTHER' was chosen.

Enum: "END_USER" "PARTNER" "LINKCY"
reason
string [ 0 .. 511 ] characters

Description of reason if 'OTHER' was chosen.

application/json
{
  • "operator": "END_USER",
  • "reason": "string"
}
Once closed, the Ledger is not deleted, but have its status set to CLOSED.
Any later incoming transaction (Sepa credit transfer or inter-ledgers) will be declined.

Ledger's transactions history can still be retrieve as usual with the "List transaction" endpoint

Linked Cards Closing

When Closing a Ledger, all the linked Cards will automatically be closed too and become unusable.
Cards status will change to CLOSED with reason LEDGER_CLOSED.

This is not a reversible status, and Cards can't be unblocked.

Suspend/Unsuspend a Ledger

A Ledger can be suspended using the "suspend a Ledger" endpoint.
This can be done for different reason (fraud and security, unpayed subscription, ...). Reason has to be provided when suspending a Ledger When suspended, no Outgoing transaction can be done on this Ledger : transaction to a beneficiary will be Declined and Cards will be blocked.

This does not prevent Incoming transactions. Money can still be received with Incoming transfers for example.

This is a reversible state, and a Ledger can be unsuspended with the "Unsuspend a ledger" endpoint.