Partner API
test
  • latest
  • test
  1. Transfers & Payments Webhooks
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. Transfers & Payments Webhooks

Order status Webhook

Webhook
POST
/order-webhook
This event is dispatched whenever the status of a placed order changes.
For a new order, a webhook is sent once the payment wallet is generated. This event corresponds to the order's status changing to WAITING_FOR_DEPOSIT. The payload for this event and subsequent status changes will contain the order's current details, including the walletAddress and expiresAt fields after they have been populated.

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://your-api-server.com' \
--header 'Content-Type: application/json' \
--data-raw '{
  "orderId": "d4a8e63a-8b8a-4b6f-8c1c-72c8473f1b2a",
  "lockId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "WAITING_FOR_CONFIRMATION",
  "createdAt": "2025-09-24T12:45:10.123Z",
  "expiresAt": "2025-09-24T13:15:10.123Z",
  "confirmations": 2,
  "requiredConfirmations": 3,
  "receivedAmount": 0.0015,
  "totalAmountRequired": 0.0015,
  "cryptocurrency": "btc",
  "walletAddress": "tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
  "transactionHash": "a1075db55d416d3ca4202f78bde033b3a6e3d2e0e0a5a3a1a6e3d2e0e0a5a3a1"
}'
Response Response Example
{}
Previous
Card Transaction Webhook
Next
Payment Link Webhook
Built with