Invite wallet holders, read their balances and history, and credit or charge their wallets.
A wallet holds money for one of your payees, the holder, in one currency. You invite holders into your wallet program, credit their wallets from your ledger account, and charge their wallets back. Wallet IDs start with W-. Your account must have the wallet program enabled, and your credential needs the Wallet Management permission. See Access to wallets and payment requests.
Every movement on a wallet is an entry: card loads, your credits, your charges, withdrawals, refunds, and chargebacks. Credits and charges accept an optional referenceId, which makes a retry safe.
| Credit status | Meaning |
|---|---|
requested | The credit was recorded. |
payment-created | The payment that funds the credit was created and submitted. The 201 response usually shows this status. |
credited | The money reached the holder's wallet. |
failed | The credit failed. No money moved. |
| Charge status | Meaning |
|---|---|
requested | The charge was recorded. |
charged | The money moved from the holder's wallet back to your ledger account. |
failed | The charge failed, for example because the wallet balance was too low. No money moved. |
See Wallets Overview.