Partner API
  1. API References
Partner API
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Partner Operations
      • Get Balances
      • Create Wallet
      • Get Transaction History
      • Retrieve Exchange Rate and Create a Lock
      • Create and Finalize an Exchange
      • Retrieve Detailed Exchange Information
      • Create Crypto Withdrawal
      • Get Crypto Withdrawal Details
      • Create a SEPA Transfer
      • Get SEPA Transfer Details
    • User Accounts
      • Create User Account
      • Add KYC File
      • Add POA File
      • Add User Verification
      • Extend user
      • Update Existing User
      • Delete User
      • Suspend User
      • Unsuspend User
      • Get User Balances
      • Get User Transaction History
    • KYC by P100
      • Creating KYC Verification
      • Redirect to Verification
      • Get KYC Status
    • Currency Exchange
      • Retrieve Exchange Rate
      • Retrieve Exchange Rate and Create a Lock
      • Create and Finalize an Exchange
      • Retrieve Detailed Exchange Information
    • Crypto Deposits
      • Update Travel Rule
    • Crypto Withdrawals
      • Get Network Fee
      • Create Crypto Withdrawal
      • Get Crypto Withdrawal Details
    • 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
    • Custom Fiat Operations
      • SEPA Deposit & Withdrawal
    • Orders
      • Get Rates
      • Retrieve Order Rate and Create a Lock
      • Create and Finalize an Order
      • Get Order Details
    • Payment link
      • Generate Payment Link
      • Get Payment Link Details
  • 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. API References

Crypto Deposits

This module contains endpoints for managing cryptocurrency deposits, including updating Travel Rule information.

Core Endpoints#

Update Travel Rule
Update or add the required Travel Rule information 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 registered for a user on the platform (funds are held pending compliance).
2.
Webhook Notification: If the deposit is subject to Travel Rule, you receive Crypto Deposit Webhook with status WAITING_FOR_TR_DATA. This indicates that additional compliance information is required. See Crypto Deposit Webhook for full details.
Example webhook payload:
{
  "externalUserId": "8bdd8c8a-e9b7-475e-9690-8a34e8b78dab",
  "cryptoDepositId": "facc5951-bdc8-46bc-a01c-9b36f25be6af",
  "amount": 0.001,
  "currency": "ETH",
  "status": "WAITING_FOR_TR_DATA",
  "transactionHash": "0x10d5bd4367fd6623a16f56889abb3bb2352b8ea7df7b21537f1fc56fc2d07a87",
  "createdAt": "2025-03-20T11:34:37.646Z"
}
3.
Data Submission: Call Update Travel Rule to submit the required compliance data for the specified deposit (cryptoDepositId).
4.
Verification and Final Processing: After submission, the deposit is verified. Depending on the outcome, the deposit is credited to the user's account or rejected (see webhook for status changes).

Technical summary:#

1.
A crypto deposit is registered.
2.
If required, update Travel Rule information using Update Travel Rule.
3.
Track the deposit state via Crypto Deposit Webhook or by checking status as needed.
Previous
Retrieve Detailed Exchange Information
Next
Update Travel Rule
Built with