List wallets

GET/partner/v1/wallets

Auth Bearer tokenScope partner.read

Lists your own wallets and the wallets of every customer under your partner account, with the details a payer needs to deposit. Balances are not included; read them with Get wallet.

Your own wallets come first, then your customers' wallets by customer name. Each owner's wallets are sorted by currency.

Closed wallets are not listed. You can still read a closed wallet by id with Get wallet.

Query

customerIduuidquery

Return only this customer's wallets. Use a customer you onboarded, or your partner ID for your own wallets. Omit it to list every wallet you can see.

A customer that does not exist or is not under your partner account is 404 partner.sub_customer_not_found.

pageintegerquerydefault: 1

Values below 1 are treated as 1.

pageSizeintegerquerydefault: 20

Clamped to 1 to 100.

Response

itemsobject[]

One entry per wallet.

Show propertiesHide properties

walletIduuid

Ryno's id for the wallet. Use it with Get wallet.

currencystring

The wallet's currency, for example USDT or NGN.

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

pageinteger

pageSizeinteger

totalCountinteger

The number of wallets across all pages.

Errors

Code	HTTP	Meaning
Request.Invalid	400	customerId, page or pageSize has the wrong type, for example a customerId that 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.sub_customer_not_found	404	customerId does not exist or is not under your partner account.

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?page=1&pageSize=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response

200

{
  "value": {
    "items": [
      {
        "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": []
      },
      {
        "walletId": "5e9a7c21-0d3b-4f86-a1c4-2b8e6f9d0a37",
        "currency": "NGN",
        "status": "Active",
        "owner": {
          "customerId": "b3f1c2d4-8a5e-4d2b-9c71-6e0f3a2b1c58",
          "type": "Business",
          "name": "Lagos Freight Ltd"
        },
        "kind": "Fiat",
        "fundingMethod": "Bank",
        "cryptoAddresses": [],
        "bankAccounts": [
          {
            "bankName": "Wema Bank",
            "accountNumber": "8123456789",
            "accountName": "Lagos Freight Ltd",
            "bankCode": "035",
            "sortCode": null,
            "iban": null
          }
        ]
      }
    ],
    "page": 1,
    "pageSize": 20,
    "totalCount": 2
  },
  "isSuccess": true,
  "isFailure": false,
  "error": { "code": "", "name": "" },
  "title": null,
  "traceId": "0HN..."
}

404

{
  "value": null,
  "isSuccess": false,
  "isFailure": true,
  "error": {
    "code": "partner.sub_customer_not_found",
    "name": "No sub-customer with that id is associated with this partner"
  },
  "title": "Resource not found",
  "traceId": "0HN..."
}