Charges a holder's wallet: moves money from the wallet to your ledger account.
Use it when the holder spends wallet money with you. The charge completes in the same call: the 201 response is
charged. The amount is taken from the wallet's balances in this order: depositSettled, then depositUnsettled, then
customerCredited. A wallet balance never goes below zero. The holder can dispute a charge (see Wallet Disputes).
Requires the Wallet Management permission (see Invite Wallet Holder). No webhook is sent for charges.
Retries. Send a referenceId. A repeat with the same referenceId, amount and memo returns the existing charge
with 200 and never charges twice. A referenceId is used up by a charge that failed: the repeat returns the failed
charge. Use a new referenceId to try again.
Errors
400 VALIDATION_ERROR: a field is missing or invalid, or a field is not part of the request400 CHARGE_INVALID_AMOUNT:amounthas more decimals than the wallet's currency allows404 NOT_FOUND: the wallet does not exist, orholderIdis not its holder409 CHARGE_ALREADY_EXISTS: a charge with thisreferenceIdexists with a differentamountormemo409 WALLET_INSUFFICIENT_FUNDS: the wallet'sbalanceis less thanamount. The charge is recorded asfailed409 CHARGE_INVALID_MEMO:memois longer than 1009 characters. The charge is recorded asfailed409 CUSTOMER_FROZEN: your wallet program is frozen. Contact Payment Labs support. If the message says the charge is
stillrequested, retry with the samereferenceIdonce the freeze lifts- Any other
409: the charge was refused and recorded asfailed, with the same code infailureCode
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
