Wallet
The prepaid wallet reserves money for an order, charges for what is delivered, and returns the rest.
Your wallet is prepaid, in US dollars. Every amount on this page, and every wholesale cost the
wallet pays, is an integer in US cents. What you charge a customer can be in another currency:
a price list, quote, sale or invoice carries its own currency, in minor units too. See
Currency.
curl https://resellerhq.com/api/v1/wallet \
-H "Authorization: Bearer $RHQ_API_KEY"{ "available": 20500, "held": 4500, "currency": "USD" }availableis what you can spend now.heldis reserved for orders still in progress.
How an order is paid for
- Reserve. The order's total moves from
availabletoheld. If the wallet cannot cover it, the order is refused with402 insufficient_fundsand nothing changes. - Charge. Each item that is delivered is charged from the reserved amount.
- Return. Anything reserved for items that could not be delivered goes back to
available.
So a failed order costs nothing, and a partly filled order costs only the part that was filled.
History
GET /v1/wallet/transactions lists every movement, newest first:
kind | Meaning |
|---|---|
topup | Funds added |
hold | Reserved for an order |
capture | Charged from a reservation |
release | Reservation returned |
refund | Money returned after a charge, for example a cancelled number |
Every movement is recorded as a balanced double-entry journal line, so the history always adds up to the balance.
Adding funds
In the sandbox, add test funds from the Wallet page. On the live side, funds are added by invoice; card payments are not connected yet.
In the API reference
Team and roles
Invite colleagues with their own logins, each with a role that controls what they can do.
Customer pricing
Price lists set what each of your customers pays on top of the wholesale price, with volume tiers, contract prices for one customer, prices fixed on single items, and lists in other currencies.