1. Wallets
Artha All Module Api's
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Products
    • List Products
      GET
    • Get Product
      GET
    • Get Customer Product Status
      GET
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Submit Applicant (KYC/KYB)
      POST
    • Create Onboarding Session
      POST
  • Wallets
    • Beneficiary
      • Create Crypto Beneficiary
      • Update Crypto Beneficiary
      • List Crypto Withdraw Beneficiaries
    • Create Wallet
      POST
    • Get Wallet Address
      GET
    • Get Customer Balances
      GET
    • List Wallets
      GET
    • List Withdrawals
      GET
    • List Withdrawal Networks
      GET
    • Preview Withdrawal Summary
      POST
    • Create Crypto Withdrawal
      POST
  • Cards
    • Issuance
      • Issue Card
      • List Cards
      • List Customer Cards
      • Get Card Details
      • Get Sensitive Card Details
    • Funding
      • Top Up Card
      • Get Card Balance
      • Get Top-Up Status
      • List Top-Up History
    • Operations
      • Resend Activation Code
      • Activate Card
      • Set Card PIN
      • Change Card PIN
      • Update Card Limits
      • Freeze Card
      • Unfreeze Card
      • Replace Card
      • Cancel Card
      • Get Card Limits
      • Show Card PIN Details
      • Get PIN View Iframe URL
      • Get PIN Change Iframe URL
      • Get PIN Set Iframe URL
      • Get Card View Iframe URL
      • Show Card PIN
  • Payees
    • Create a payee for a customer.
      POST
    • List a customer's payees.
      GET
    • Update a payee.
      PUT
    • Retrieve a payee by id.
      GET
    • Look up an existing payee.
      GET
    • List the currencies a payee can be created in.
      GET
    • List the accepted payment purpose codes for a payee.
      GET
    • List the countries a payee can be created in.
      GET
    • List currency/country pairings for payees.
      GET
    • List the accepted beneficiary relationship codes.
      GET
  • Payments
    • Onboarding
      • List the customer's payout-currency configuration sections.
      • Enable a payout-currency section for the customer.
      • Get the customer's terms-of-service acceptance status.
      • Enable or disable a payout-currency section.
    • Quote
      • List the currencies a beneficiary can be paid in under a product.
      • List the payout rails available for a product and beneficiary.
      • Create an FX quote giving the rate and fee for a cross-currency payout.
    • Order
      • Submit a payout order to send money to a beneficiary.
      • Retrieve the on-chain address to fund an order.
      • Retrieve the status and settlement detail of a payout order.
    • Lookups
      • List the accepted payment purpose codes for a payout.
      • List the accepted source-of-funds codes for a payout.
      • List the document types accepted on a payout order.
  • Banks
    • Accounts
      • Create Bank Account
      • Get Account Details
      • Get Account Issuance Status
    • Withdraw
      • Create Withdrawal Quote
      • List Withdrawal Purposes
      • Get Payment Schemes
      • Execute Withdrawal
  • Exchange
    • Quote
      • Get Exchange Rate
      • Create Price Quote
    • Order
      • Place Exchange Order
  • Transactions
    • List Transactions
    • Get Transaction Details
  • Utilities
    • List Currencies
    • List Countries
    • Get Fee Schedule
    • List Product Occupations
    • List Product Industry Codes
    • Upload File
  • Webhook's
    • Wallets Webhooks
    • Banks Webhooks
    • Payments Webhooks
    • Exchange Webhooks
    • Card Webhooks
  1. Wallets

List Wallets

GET
/api/v1/wallets
Returns a paginated list of active customer wallets — one entry per customer, currency and network — with the customer's display name, the network, the on-chain wallet address, current available balance, and wallet status.
Query Parameters
FieldTypeDescription
pageintegerPage number, starting at 1. Default 1.
pageSizeintegerItems per page, 1–100. Default 50.
customerIdstring (uuid)Restricts results to one customer's wallets. Optional — see note below.
Note: customerId is optional on this endpoint and on List Transactions — every other endpoint in this API requires it and rejects the request with 422 when it's missing. Here, omitting it returns active wallets for every customer in the tenant, paginated. If a partner integration should only ever see its own customers' wallets, always pass customerId explicitly when calling this endpoint.
Response envelope
This endpoint does not use the standard data / requestId / timestamp envelope. It returns:
{
  "data": [ ],
  "pagination": { "total": 0, "limit": 50, "offset": 0, "hasMore": false }
}
The request ID is available in the X-Request-Id response header instead of the response body.
Response Fields
FieldTypeDescription
data[].customerNamestringCustomer's display name — the business name for business accounts, otherwise the customer's full name
data[].currencystringCurrency ticker of the wallet (e.g. USDT)
data[].networkstringBlockchain network of the wallet (e.g. TRC-20)
data[].walletAddressstringOn-chain wallet address for that currency and network
data[].balancenumberCurrent available balance in that currency
data[].statusstringWallet status (e.g. Active)
pagination.totalintegerTotal matching wallets across all pages
pagination.limitintegerPage size used
pagination.offsetintegerNumber of items skipped before this page
pagination.hasMorebooleanWhether a further page is available

Request

Authorization
or
Query Params

Header Params

Responses

🟢200
application/json
OK.
Bodyapplication/json

🟠401
🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/wallets?page=&pageSize=&CustomerId=' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;'
Response Response Example
{
    "data": [
        {
            "customerName": "Acme Trading Ltd",
            "currency": "USDT",
            "network": "TRC-20",
            "walletAddress": "TWFgpZGWq85xkGmUS8guHsuXQhkCqedfsj",
            "balance": 1250.75,
            "status": "Active"
        },
        {
            "customerName": "Jane Doe",
            "currency": "BTC",
            "network": "BTC",
            "walletAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
            "balance": 0.0431,
            "status": "Active"
        }
    ],
    "pagination": {
        "total": 2,
        "limit": 50,
        "offset": 0,
        "hasMore": false
    }
}
Modified at 2026-08-22 10:02:54
Previous
Get Customer Balances
Next
List Withdrawals
Built with