Skip to Content
OpenRoam Docs
Wallets

Select a wallet

Makes a wallet the partner's selected wallet, which pays for new orders.

PATCH
/v1/wallets/select/{id}

Makes a wallet the partner's selected wallet, which pays for new orders.

Exactly one wallet is selected at a time; the previously selected wallet is deselected. An unknown wallet returns 404 with code 10004 and leaves the current selection unchanged.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Path Parameters

id*string

Wallet id to select.

Formatuuid

Response Body

No Content

Example Request
curl -X PATCH 'https://api.sandbox.openroam.com/v1/wallets/select/01a1432e-7121-7b0e-a0a0-c35454d3b883'
Example Response
Empty

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`.

Transfer between wallets POST

Moves funds from one of the partner's wallets to another, converting between their currencies. `amount` is in the source wallet's currency and has at most that currency's ISO 4217 decimals (none in `KRW` or `JPY`, three in `KWD`, two in most); more decimals return `400` with code `10001` and `INVALID_VALUE` at `amount`, whose `message` names the decimals allowed, such as `An amount in JPY cannot have decimals.` The destination receives the amount converted at the current rate, rounded to its own currency's decimals. Returns the `transferId`, the sent and received amounts and currencies, the `conversionRate` and the `transferDate`. Both wallets record an `exchange` transaction. The two wallets must differ, and the amount must be above zero; otherwise the call returns `400` with code `10001`. An unknown wallet returns `404` with code `10004`. A source wallet that cannot pay the amount now returns `409` with code `10005` (`CONFLICT`) and `details[0] = { path: "fromWalletId", reason }`: `INSUFFICIENT_BALANCE` when its balance is too low, `WALLET_BLOCKED` while its spending is blocked. The same request can succeed once that changes. Requires an `Idempotency-Key` header (a UUID). Repeating a completed transfer with the same key and body returns `200` with that transfer, the same `transferId` and amounts, and moves no money again. One still running returns `409` with code `12002` (`IDEMPOTENCY_KEY_IN_PROGRESS`) and a `Retry-After` header, and a different body with the same key `409` with code `12001`. A request that ended in an error can be sent again with the same key and body.