Refund Callback

A refund callback will be sent to the merchant's callback_url when the order status is changed to rejected or completed.

🚧

API Callback Documentation

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

CoinGate callback sends the data below:

NameTypeValue
idIntegerCoinGate merchant refund ID
statusStringCurrent order status
request_amountStringAmount requested to refund
request_currencyHashCurrency id and symbol
addressStringCustomer’s wallet address where the refund will be sent
additional_address_fieldStringAddress memo or destination tag
refund_amountStringAmount to refund a customer
refund_currencyHashCurrency id, symbol, platform id, and title
emailStringCustomer’s email address
reasonStringReason for refund
ledger_accountHashLedger id, currency id, and symbol

An example of callback in JSON:

{
  "id": 123,
  "status": "completed",
  "request_amount": "123.0",
  "request_currency": {
    "id": 2,
    "symbol": "EUR"
  },
  "address": "mvKFTr6M8NtKrD659qBCpT9hfM1LTwnQV3",
  "additional_address_field": null,
  "refund_amount": "0.00012345",
  "refund_currency": {
    "id": 1,
    "symbol": "BTC",
    "platform": {
      "id": 6,
      "title": "Bitcoin"
    }
  },
  "email": "[email protected]",
  "reason": "Callbacks Testing Reason",
  "ledger_account": {
    "id": "01HBDE32A9FKNJT5S8MYFFYY6JJ",
    "currency": {
      "id": 1,
      "symbol": "BTC"
    }
  }
}