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

Update Crypto Beneficiary

PUT
/api/v1/beneficiary/crypto/update
Updates an existing crypto beneficiary entry. Send the complete payload — the same shape used on create — including the beneficiaryId of the record to update; the submitted values replace the stored ones.
Prerequisites
An existing crypto beneficiary — the beneficiaryId must reference a record previously created via POST /api/v1/beneficiary/crypto/create.
The X-Idempotency-Key header must be sent — reusing the same key returns the original result instead of applying the update twice.
⚠️ Required Fields
FieldTypeDescriptionConstraints
beneficiaryIdstring (uuid)ID of the crypto beneficiary to updateRequired on this endpoint
customerIdstring (uuid)The customer this beneficiary belongs to-
nicknamestringA short label for this beneficiary (e.g. "Binance USDT Wallet")Min: 1 · Max: 100
currencystringCrypto currency code (e.g. BTC, ETH, USDT)Min: 1
networkstringBlockchain network (e.g. ERC20, TRC20, BTC)Min: 1
walletAddressstringWallet address or account numberMin: 1
accountTypestringindividual or businessPattern: `^(individual
addressTypestring1st Party (customer's own wallet) or 3rd Party (someone else's wallet)Pattern: `^(1st Party
Optional Fields
FieldTypeDescriptionConstraints
walletSourcestringWallet source (e.g. Binance, Coinbase, Other)Nullable
otherWalletstringOther wallet name when walletSource is OtherNullable
recipient.firstNamestringRecipient first nameNullable
recipient.middleNamestringRecipient middle nameNullable
recipient.lastNamestringRecipient last nameNullable
recipient.businessNamestringRequired when accountType is businessNullable
recipient.emailstringRecipient email addressNullable
recipient.phoneCodestringInternational dialling code, e.g. +44, +1Nullable
recipient.phoneNumberstringPhone number without country codeNullable
address.streetstringStreet nameNullable
address.line1stringAddress line 1Nullable
address.citystringCityNullable
address.statestringState / regionNullable
address.postalCodestringPostal codeNullable
address.countrystringISO 3166-1 alpha-2 country code (e.g. GB, US)Nullable
📤 Response Fields
FieldTypeDescription
data.idstring (uuid)Unique ID of the updated 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.recipientobjectRecipient details
data.addressobjectBeneficiary address
data.statusstringBeneficiary status (e.g. active)
data.updatedAtstring (date-time)Last update timestamp (UTC)
requestIdstringUnique ID of this request
timestampstring (date-time)Server timestamp of the response (UTC)

Request

Authorization
or
Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Crypto beneficiary entry updated.
Bodyapplication/json

🟠400
🟠401
🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/api/v1/beneficiary/crypto/update' \
--header 'X-Idempotency-Key: b4d8e2f1-7a3c-4e95-8b6d-2f9a1c5e7d30' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "success": true,
    "data": {
        "id": "c7e91b2d-4f6a-4830-9d5e-8a1f3c7b2e94",
        "customerId": "ed2baa83-a988-4b4a-93ee-fad379500bbd",
        "nickname": "Binance USDT Wallet",
        "currency": "USDT",
        "network": "TRC20",
        "walletAddress": "TQrY8bkbpXKPt2LZbU8jqYt8YXqxBxdK7m",
        "walletSource": "Binance",
        "accountType": "individual",
        "addressType": "1st Party",
        "recipient": {
            "firstName": "Rahul",
            "lastName": "Sharma",
            "email": "rahul.sharma@example.com",
            "phoneCode": "+91",
            "phoneNumber": "9810012345"
        },
        "address": {
            "line1": "B-42 Green Park",
            "city": "New Delhi",
            "state": "Delhi",
            "postalCode": "110016",
            "country": "IN"
        },
        "status": "active",
        "createdAt": "2026-08-12T10:30:12Z"
    },
    "requestId": "a5d38e1c9f274b60b8e2d4f17a93c586",
    "timestamp": "2026-08-12T10:30:12.664018Z"
}'
Response Response Example
200 - Success
{
    "data": {
        "payeeId": "6cf0dac7-5b6d-45ba-a766-b4616c7b81d7",
        "status": "UPDATED",
        "message": "Crypto beneficiary updated successfully."
    },
    "requestId": "84006d79c79d4058864491aa7fa0a79e",
    "timestamp": "2026-08-25T13:17:38.1688232Z"
}
Modified at 2026-08-25 13:26:25
Previous
Create Crypto Beneficiary
Next
List Crypto Withdraw Beneficiaries
Built with