Get a wallet
Gets one wallet with its totals.
Gets one wallet with its totals.
Adds lowBalanceThreshold, createdAt, updatedAt and totals of completed transactions to
the list fields. An unknown wallet, or one of another partner, returns 404 with code 10004.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
id*stringWallet id.
uuidOK
- response
A partner wallet with totals of its completed transactions.
id*stringWallet id.
uuidlabel*stringDisplay name.
balance*numberAvailable balance, in the wallet's currency.
decimallowBalanceThreshold?|Low-balance threshold for the partner.balance.low webhook; null
when not set.
decimalisSelected*booleanWhether this is the selected wallet that pays for orders.
currency*The wallet's currency.
createdAt*stringWhen the wallet was created (UTC).
date-timeupdatedAt*stringWhen the wallet last changed (UTC).
date-timetotalDebits*numberTotal of completed debit transactions: funds taken from the wallet.
decimaltotalCredits*numberTotal of completed credit transactions: funds added to the wallet.
decimalpercentageDifference*numbertotalDebits as a percentage of totalCredits, or 0 when nothing
was added.
decimalcurl -X GET 'https://api.sandbox.openroam.com/v1/wallets/01a1432e-7121-7b0e-a0a0-c35454d3b883'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "label": "string", "balance": 0, "lowBalanceThreshold": 0, "isSelected": true, "currency": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "code": "string", "rateToUsd": 0, "rateDate": "2019-08-24T14:15:22Z", "dailyPercentageDifference": 0 }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "totalDebits": 0, "totalCredits": 0, "percentageDifference": 0}List wallets GET
Lists all of the partner's wallets. Returns the whole list as an array, without paging. Each wallet has its `id`, `label`, `balance`, whether it `isSelected` (the wallet that pays for orders) and its `currency`.
List wallet transactions GET
Lists a wallet's transactions, newest first, with optional filters. Returns `{ transactions, pagination }`. In a transaction, `type` `debit` takes funds from the wallet and `credit` adds funds to it; `source` says why (`topUp`, `payOut`, `order`, `exchange` or `reversal`), and `orderId` names the order a payment or refund belongs to. Filters combine with AND and apply before counting and paging. Use flat `page` (default 1) and `limit` (default 10, 1 to 100) query parameters. `cursor`, `skip`, `offset`, nested paging keys and repeated paging parameters return `400` with code `10001` (`INVALID_REQUEST`). An unknown wallet returns `404` with code `10004`.