Collect a balance's open fee debts
Settles the balance’s open fee debts oldest first from its available funds, up to maxAmount and never more than it owes, in one transaction. It charges no new fee. Without an error, it collects nothing when the balance has no available funds or is blocked, cannot send, is closing or closed, deleted, debit-direction or external, and it stops at the first debt whose fee account is blocked, cannot receive, is closing or closed, deleted, debit-direction, external, in overdraft or of another asset. When nothing is settled the response is collected 0 and no transaction is created. With X-Idempotency a retry returns the first collection; an answer that settled nothing is not kept. Without it every call is a new collection. A collection transaction cannot be reverted.
Autorizações
JWT bearer token issued by the identity provider.
Cabeçalhos
Idempotency key to safely retry the collection; a retry returns the first collection (an answer that settled nothing is not kept), another request under the same key answers 409 (0084). Without it every call is a new collection.
Idempotency slot TTL in seconds (default 300)
Parâmetros de caminho
Organization ID (UUID)
Ledger ID (UUID)
Corpo
Alias of the debtor account.
100"@customer"
Key of the debtor balance; absent means the default balance.
100"default"
Most the collection may settle, greater than zero; absent means everything the balance owes.
"150.00"