1. Beneficiary
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
        POST
      • Update Crypto Beneficiary
        PUT
      • List Crypto Withdraw Beneficiaries
        GET
    • 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.
    • List a customer's payees.
    • Update a payee.
    • Retrieve a payee by id.
    • Look up an existing payee.
    • List the currencies a payee can be created in.
    • List the accepted payment purpose codes for a payee.
    • List the countries a payee can be created in.
    • List currency/country pairings for payees.
    • List the accepted beneficiary relationship codes.
  • 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. Beneficiary

List Crypto Withdraw Beneficiaries

GET
/api/v1/beneficiary/crypto/withdraw
Returns a customer's crypto beneficiary entries that are available as destinations for a crypto withdrawal. Optionally filter by blockchain network so you only show wallets compatible with the asset being withdrawn.
Prerequisites
A valid customerId for the customer whose crypto beneficiaries you want to list.
📤 Response Fields
FieldTypeDescription
dataarrayList of crypto beneficiary objects
data[].idstring (uuid)Unique ID of the crypto beneficiary
data[].customerIdstring (uuid)The customer this beneficiary belongs to
data[].nicknamestringLabel for this beneficiary
data[].currencystringCrypto currency code
data[].networkstringBlockchain network
data[].walletAddressstringWallet address
data[].walletSourcestringWallet source
data[].accountTypestringindividual or business
data[].addressTypestring1st Party or 3rd Party
data[].statusstringBeneficiary status (e.g. active)
data[].createdAtstring (date-time)Creation timestamp (UTC)
requestIdstringUnique ID of this request
timestampstring (date-time)Server timestamp of the response (UTC)

Request

Authorization
or
Query Params

Header Params

Responses

🟢200
application/json
Crypto beneficiary entries retrieved successfully.
Bodyapplication/json

🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/beneficiary/crypto/withdraw?customerId=ed2baa83-a988-4b4a-93ee-fad379500bbd&network=TRC-20' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;'
Response Response Example
200 - Success
{
    "success": true,
    "data": [
        {
            "id": "c7e91b2d-4f6a-4830-9d5e-8a1f3c7b2e94",
            "customerId": "ed2baa83-a988-4b4a-93ee-fad379500bbd",
            "nickname": "Binance USDT Wallet",
            "currency": "USDT",
            "network": "TRC-20",
            "walletAddress": "TQrY8bkbpXKPt2LZbU8jqYt8YXqxBxdK7m",
            "walletSource": "Binance",
            "accountType": "individual",
            "addressType": "1st Party",
            "status": "active",
            "createdAt": "2026-08-12T10:30:12Z"
        },
        {
            "id": "f4b82d1e-6c93-4a07-b5e8-2d7f9a1c3e60",
            "customerId": "ed2baa83-a988-4b4a-93ee-fad379500bbd",
            "nickname": "Acme Treasury ETH",
            "currency": "ETH",
            "network": "ERC-20",
            "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
            "walletSource": "Other",
            "accountType": "business",
            "addressType": "3rd Party",
            "status": "active",
            "createdAt": "2026-07-28T11:47:09Z"
        }
    ],
    "requestId": "6b9d24e1f8c74a35b0e2d5f19a83c470",
    "timestamp": "2026-08-12T10:45:56.120833Z"
}
Modified at 2026-08-22 05:31:04
Previous
Update Crypto Beneficiary
Next
Create Wallet
Built with