Skip to Content
OpenRoam Docs
Wallets

Get a wallet

Gets one wallet with its totals.

GET
/v1/wallets/{id}

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.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Path Parameters

id*string

Wallet id.

Formatuuid

Response Body

OK

  1. response

A partner wallet with totals of its completed transactions.

id*string

Wallet id.

Formatuuid
label*string

Display name.

balance*number

Available balance, in the wallet's currency.

Formatdecimal
lowBalanceThreshold?|

Low-balance threshold for the partner.balance.low webhook; null when not set.

Formatdecimal
isSelected*boolean

Whether this is the selected wallet that pays for orders.

currency*

The wallet's currency.

createdAt*string

When the wallet was created (UTC).

Formatdate-time
updatedAt*string

When the wallet last changed (UTC).

Formatdate-time
totalDebits*number

Total of completed debit transactions: funds taken from the wallet.

Formatdecimal
totalCredits*number

Total of completed credit transactions: funds added to the wallet.

Formatdecimal
percentageDifference*number

totalDebits as a percentage of totalCredits, or 0 when nothing was added.

Formatdecimal
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/wallets/01a1432e-7121-7b0e-a0a0-c35454d3b883'
Example Response
{  "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}