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 Withdrawals

GET
/api/v1/wallets/{type}
GET /api/v1/wallets/{type}?customerId={customerId}
Returns the customer's wallets and assets available for the given operation type — deposit or withdraw — including balances in USD, per-asset limits, account status, and KYC state.
Path Parameters
FieldTypeDescription
typestringOperation type — deposit or withdraw
Query Parameters
FieldTypeDescription
customerIdstring (uuid)Unique identifier of the customer whose assets you want — required
Status values
FieldValuesMeaning
accountStatusActiveAsset account is usable for withdrawals
kycStateApprovedCustomer KYC is verified for this asset
Response Fields
FieldTypeDescription
data.totalInBaseAmountnumberTotal balance across all wallets in base currency (USD)
data.wallets[].namestringWallet display name (e.g. USDT)
data.wallets[].totalBalanceInUsdnumberWallet balance in USD
data.wallets[].assets[].namestringAsset name (e.g. Tether)
data.wallets[].assets[].codestringCurrency ticker (e.g. USDT)
data.wallets[].assets[].coinCodestringCurrency + network code (e.g. USDT-TRC20)
data.wallets[].assets[].imagestringAsset icon/image URL, if set
data.wallets[].assets[].amountnumberAsset balance
data.wallets[].assets[].amountInBasenumberAsset balance in base currency
data.wallets[].assets[].minLimitnumberMinimum withdrawal amount
data.wallets[].assets[].maxLimitnumberMaximum withdrawal amount
data.wallets[].assets[].accountStatusstringAsset account status
data.wallets[].assets[].kycStatestringCustomer KYC state for this asset
data.wallets[].assets[].actionTypestringAction type this asset entry applies to
data.wallets[].assets[].notestringAdditional note, if any
data.wallets[].assets[].remarksstringAdditional remarks, if any
data.wallets[].assets[].accountCreationFeenumberFee charged to create this asset account, if applicable
data.wallets[].assets[].providerStatusstringUnderlying provider's account status, if applicable
data.wallets[].assets[].providerRemarksstringUnderlying provider's remarks, if any
data.wallets[].assets[].isCustomerCreatedbooleanWhether the customer created this asset account themselves
data.wallets[].assets[].paymentSubStatebooleanPayment sub-state flag, if applicable
data.wallets[].assets[].bankStatusstringBank account status, if this asset is bank-linked
data.wallets[].assets[].customerHolderStatusstringCustomer's holder status for this asset, if applicable
requestIdstringUnique identifier of this API request
timestampstring (date-time)Server timestamp of the response (UTC)
Note: fields other than minLimit/maxLimit/totalInBaseAmount are omitted from the JSON entirely when null (server uses Newtonsoft NullValueHandling.Ignore) — several of the asset-level fields above (e.g. bankStatus, paymentSubState, customerHolderStatus, providerStatus, providerRemarks) are shared with fiat/bank asset listings and are not expected to be populated for crypto withdrawals specifically.

Request

Authorization
or
Path Params

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/?CustomerId=' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;'
Response Response Example
{
    "data": {
        "totalInBaseAmount": 1250.75,
        "wallets": [
            {
                "name": "USDT",
                "totalBalanceInUsd": 1250.75,
                "assets": [
                    {
                        "name": "Tether USD",
                        "code": "USDT",
                        "coinCode": "USDT-TRC20",
                        "amount": 1250.75,
                        "amountInBase": 1250.75,
                        "actionType": "WITHDRAWCRYPTO",
                        "accountStatus": "Active",
                        "kycState": "Approved",
                        "minLimit": 10.0,
                        "maxLimit": 50000.0
                    }
                ]
            }
        ]
    },
    "requestId": "d4a0f7c31e8b45629af1c5e7b0d38264",
    "timestamp": "2026-08-21T10:03:11.2277409Z"
}
Modified at 2026-08-22 09:38:35
Previous
List Wallets
Next
List Withdrawal Networks
Built with