Get wallet

GET/partner/v1/wallets/{walletId}

Auth Bearer tokenScope partner.read

Returns one wallet with its deposit details and its balance. The wallet must be yours or belong to a customer under your partner account.

Any status can be read, Closed included.

Path

walletIduuidpathrequired

The walletId from List wallets.

Response

walletIduuid

currencystring

The wallet's currency, for example USDT or NGN. Every amount in balance is in this currency.

statusstring

One of Pending, Active, Suspended, Frozen, Closed. Show deposit details only for Active.

ownerobject

Who holds the wallet.

Show propertiesHide properties

customerIduuid

The owner's customer id. For your own wallets, this is your partner ID.

typestring

One of Partner (your own wallet), Business, Individual.

namestring

The owner's name.

kindstring

Crypto or Fiat.

fundingMethodstring

OnChain for a Crypto wallet, Bank for a Fiat wallet.

cryptoAddressesobject[]

Where to send crypto, one entry per address and network. The same address can appear for several networks. Empty for a Fiat wallet.

Show propertiesHide properties

addressstring

The deposit address.

networkstring

The network name to show with the address, for example Ethereum. A transfer on a network that is not listed is not credited.

chainIdstring

The network's CAIP-2 id, for example eip155:1.

bankAccountsobject[]

Bank accounts a payer can transfer to. Empty for a Crypto wallet, and for a Fiat wallet that has no account yet.

Show propertiesHide properties

bankNamestring | null

accountNumberstring | null

accountNamestring | null

bankCodestring | null

sortCodestring | null

ibanstring | null

balanceobject

The wallet's balance, in currency. There is no total; add the three amounts if you need one.

Show propertiesHide properties

availablenumber

Money the owner can use now.

pendingnumber

Money on its way in that is not usable yet.

reservednumber

Money set aside for an operation in progress, such as a payout.

balanceVersioninteger

Increases on every balance change. Keep the highest value you have seen; a response with a lower value is stale.

Errors

Code	HTTP	Meaning
Request.Invalid	400	walletId is not a uuid.
Auth.Unauthorized	401	The token is missing or invalid.
Auth.Forbidden	403	The token is not a partner credential, or lacks partner.read.
partner.profile_not_active	403	Your partner account is not active. Contact support.
partner.profile_not_found	404	Your partner account could not be found. Contact support.
partner.wallet_not_found	404	No wallet you can see has this id. Also returned for another partner's wallet.

The 401, 429 and 503 responses from the API gateway use a different body. See Errors.

Request

curl https://gateway.sandbox.rynopay.io/api/partner/v1/wallets/0b6f2d3e-41a7-4c58-9f0e-7a2c1d4e5b61 \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response

200

{
  "value": {
    "walletId": "0b6f2d3e-41a7-4c58-9f0e-7a2c1d4e5b61",
    "currency": "USDT",
    "status": "Active",
    "owner": {
      "customerId": "d82dc280-d103-40ec-a66a-d11bc2c3295e",
      "type": "Partner",
      "name": "Acme Payments Ltd"
    },
    "kind": "Crypto",
    "fundingMethod": "OnChain",
    "cryptoAddresses": [
      {
        "address": "0x4f3a9c1b7e2d8a6f05c4b3e2d1a0f9e8c7b6a5d4",
        "network": "Ethereum",
        "chainId": "eip155:1"
      },
      {
        "address": "0x4f3a9c1b7e2d8a6f05c4b3e2d1a0f9e8c7b6a5d4",
        "network": "Base",
        "chainId": "eip155:8453"
      }
    ],
    "bankAccounts": [],
    "balance": {
      "available": 1250.5,
      "pending": 300,
      "reserved": 100,
      "balanceVersion": 42
    }
  },
  "isSuccess": true,
  "isFailure": false,
  "error": { "code": "", "name": "" },
  "title": null,
  "traceId": "0HN..."
}

404

{
  "value": null,
  "isSuccess": false,
  "isFailure": true,
  "error": {
    "code": "partner.wallet_not_found",
    "name": "No wallet with that id is associated with this partner or its customers"
  },
  "title": "Resource not found",
  "traceId": "0HN..."
}