A callback will be sent to the merchant's callback_url when the send request is created or the status is changed

🚧

API Callback Documentation

Read more about common callback functionalities in the API Callbacks section.

CoinGate callback sends the data below:

NameTypeValue
idIntegerUnique identifier for the Send Request
statusStringThe current status of Send Request.
purposeStringDescription of the purpose of the Send Request.
callback_urlStringURL to receive callbacks for status changes.
created_atStringCreation time of send request.
ledger_accountHashLedger account details.
input_amountFloatThe requested amount to be sent to the recipient.
input_currencyHashCurrency of input amount currency
sending_amountFloatAmount that will be sent to recipient.
sending_currencyHashCurrency of sent amount currency details.
input_to_sending_rateStringRate of input to sending currency.
sending_to_balance_debit_rateStringRate of sending to balance debit currency.
balance_debit_amountFloatAmount that will deducted from the balance.
balance_debit_currencyHashCurrency of deducted amount currency details.
beneficiary_payout_settingHashRecipient crypto address Beneficiary Payout Settingdetails
feesHashFees that were applied. Possible fees: service_fee, conversion_fee.
blockchain_transactionsArrayArray of blockchain transactions. (txid, amount, status, network_confirmations)
actions_requiredHashPossible action URLs: confirm, cancel. These are needed on the exchange to confirm or cancel the exchange.
requires_2fa_confirmationBooleanIndicator if send request requires 2FA confirmation from the dashboard.

An example of callback in JSON:

{
  "id": 11,
  "status": "draft",
  "purpose": "Sending 100 EUR Value",
  "callback_url": "https://example.com/callback_url",
  "created_at": "2025-03-13T00:45:17.250Z",
  "ledger_account": {
    "id": "01JNQWKKJ6WXN8BZT1Y66B6G9H",
    "balance": "1.0",
    "status": "active",
    "currency": {
      "id": 1,
      "title": "Bitcoin",
      "symbol": "BTC"
    }
  },
  "input_amount": "100.0",
  "input_currency": {
    "id": 2,
    "title": "Euro",
    "kind": "fiat",
    "symbol": "EUR"
  },
  "sending_amount": "0.049422",
  "sending_currency": {
    "id": 5,
    "title": "Ethereum",
    "kind": "crypto",
    "symbol": "ETH"
  },
  "input_to_sending_rate": "0.00049422",
  "sending_to_balance_debit_rate": "40.3258",
  "balance_debit_amount": "0.00122557",
  "balance_debit_currency": {
    "id": 1,
    "title": "Bitcoin",
    "kind": "crypto",
    "symbol": "BTC"
  },
  "beneficiary_payout_setting": {
    "id": 2,
    "created_at": "2025-03-07T10:39:33.152Z",
    "beneficiary_id": 1,
    "platform": {
      "id": 2,
      "title": "Ethereum",
      "id_name": "ethereum"
    },
    "crypto_address": "tb1qcq670zweall6zz4f96flfrefhr8myfxz9ll9l2",
    "crypto_address_metadata": null,
    "currency": {
      "id": 5,
      "title": "Ethereum",
      "kind": "crypto",
      "symbol": "ETH"
    }
  },
  "fees": {
    "service_fee": {
      "amount": "0.00001226",
      "currency": {
        "id": 1,
        "title": "Bitcoin",
        "kind": "crypto",
        "symbol": "BTC"
      }
    },
    "conversion_fee": {
      "amount": "0.00001226",
      "currency": {
        "id": 1,
        "title": "Bitcoin",
        "kind": "crypto",
        "symbol": "BTC"
      }
    }
  },
  "blockchain_transactions": [],
  "actions_required": {
    "confirm": "https://api.coingate.com/api/v2/send_requests/11/confirm",
    "cancel": "https://api.coingate.com/api/v2/send_requests/11/cancel"
  },
  "requires_2fa_confirmation": true
}