Partner API
test
  • latest
  • test
  1. User Operations
Partner API
test
  • latest
  • test
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Partner Operations
      • Balances & Transaction History
        • Get Balances
        • Get Transaction History
        • Create Wallet
        • Create transfer master balance
      • Exchange Operations
        • Retrieve Exchange Rate
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
        • Retrieve Exchange Rate and Create a Lock
      • SEPA Transfers
      • Crypto Deposits
        • Update Travel Rule
      • Crypto Withdrawal
        • Get Crypto Withdrawal Details
        • Create Crypto Withdrawal
      • Orders
        • Retrieve Order Rate and Create a Lock
        • Create and Finalize an Order
        • Get Order Details
        • Get Rates
      • Payment link
        • Generate Payment Link
        • Get Payment Link Details
    • User Operations
      • Onboarding & KYC Flow
        • Create User Account
        • Method A: Add KYC File
        • Method B: Creating KYC Verification
        • Method B: Redirect to Verification
        • Method B: Get KYC Status
        • Add User Verification
        • Add POA File
      • Account Management
        • Update Existing User
        • Delete User
        • Suspend User
        • Unsuspend User
      • Balances & Transaction History
        • Get User Balances
        • Get User Transaction History
      • Currency Exchange
        • Retrieve Exchange Rate
        • Retrieve Exchange Rate and Create a Lock
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
      • Internal Transfers
        • Create a Transfer
        • Get Transfer Details
      • Virtual Cards
        • Create Virtual Card
        • Get All User Cards
        • Get Card Details
        • Update Card PIN
        • Block Card
        • Unblock Card
        • Get Card Limits
        • Update Card Limits
        • Delete Card
      • Crypto Deposits
        • Update Travel Rule
      • Crypto Withdrawals
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • SEPA Transfers Copy
  • Integration
    • SDKs & Integration Guides
    • Transaction Processing
    • Error Handling
    • Rate Limiting
    • Webhooks
      • User & KYC Webhooks
        • User Balance Generation Webhook
        • KYC File Added Webhook
        • POA Verification Status Webhook
        • KYC Verification Status Webhook
        • Create Wallet Webhook
      • Transfers & Payments Webhooks
        • P2P Transfer Webhook
        • SEPA Transfer Webhook
        • SEPA Deposit Webhook
        • Crypto Withdrawal Webhook
        • Crypto Deposit Webhook
        • Exchange Webhook
        • Card Transaction Webhook
        • Order status Webhook
        • Payment Link Webhook
      • Card Webhooks
        • Card 3DS Code Webhook
        • Card Activation Code Webhook
  • Reference
    • Supported Countries
    • Supported Currencies
    • Fees
    • FAQ
    • Changelog
    • Support
  1. User Operations

Crypto Deposits

User Crypto Deposits#

This module handles the compliance process for incoming cryptocurrency deposits to user wallets. Specifically, it addresses Travel Rule requirements for transactions that exceed regulatory thresholds.

Core Endpoints#

Update Travel Rule
Update or add the required Travel Rule information (Sender details) for a specific deposit.

Typical Workflow#

The following outlines the process for handling a deposit that requires Travel Rule compliance:
1.
Deposit Registered: A cryptocurrency deposit is detected on the blockchain. The funds are credited to the user's wallet but are held (locked) pending compliance checks.
2.
Webhook Notification: If the deposit is subject to Travel Rule regulations (based on amount or jurisdiction), you will receive a Crypto Deposit Webhook with the status WAITING_FOR_TR_DATA.
Example webhook payload:
{
  "externalUserId": "8bdd8c8a-e9b7-475e-9690-8a34e8b78dab",
  "cryptoDepositId": "facc5951-bdc8-46bc-a01c-9b36f25be6af",
  "amount": 1005.50,
  "currency": "USDT",
  "status": "WAITING_FOR_TR_DATA",
  "transactionHash": "0x10d5bd4367fd6623a16f56889abb3bb2352b8ea7df7b21537f1fc56fc2d07a87",
  "createdAt": "2025-03-20T11:34:37.646Z"
}
3.
Data Submission: Upon receiving this status, your system must call Update Travel Rule to provide the required Originator (Sender) information for the specified cryptoDepositId.
4.
Verification & Unlocking: After submission, the compliance data is verified.
Success: The deposit status changes to COMPLETED and funds become available.
Failure: The deposit may remain locked or require manual intervention.
Previous
Delete Card
Next
Update Travel Rule
Built with