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:
Name | Type | Value |
---|---|---|
id | Integer | Unique identifier for the Send Request |
status | String | The current status of Send Request. |
purpose | String | Description of the purpose of the Send Request. |
pay_amount | Float | Amount requested. |
ledger_account | Hash | Ledger account details. |
ledger_account.status | String | Status of the ledger account. |
pay_currency | Hash | Payment currency details. |
quote_currency | Hash | Quoted currency details. |
quote_amount | Float | Amount in quote currency. |
beneficiary_payout_setting | Hash | Beneficiarydetails |
ledger_exchange_transaction | Hash | Details of exchange transaction. |
ledger_exchange_transaction.from_ledger_account | String | source ledger account. |
ledger_exchange_transaction.to_ledger_account | String | destination ledger account. |
An example of callback in JSON:
{
"id": 1234,
"status": "draft",
"purpose": "purpose",
"pay_amount": 123.45,
"ledger_account": {
"id": "01JK5TY1111111BBJDBT1Q",
"status": "active",
"currency": {
"id": 21,
"symbol": "USDT"
}
},
"pay_currency": {
"id": 21,
"symbol": "USDT"
},
"quote_currency": {
"id": 1,
"symbol": "BTC"
},
"quote_amount": 0.001,
"beneficiary_payout_setting": {
"id": 398,
"platform": {
"id": 5,
"title": "Bitcoin"
},
"crypto_address": "mq1wNeaAWSDQWERTUBePSVBv2g6naFH3BtG",
"crypto_address_metadata": {},
"currency": {
"id": 1,
"symbol": "BTC"
}
},
"ledger_exchange_transaction": {
"id": "01JK5TAAABBBCCCW193J0CA",
"status": "pending",
"conversion_rate": 1.0,
"from_ledger_account": {
"id": "01JK5TAAABBBCCCW193J0CA",
"currency": {
"id": 21,
"symbol": "USDT"
}
},
"to_ledger_account": {
"id": "01JK5TYCCCDDDFFF123T2PF93H7",
"currency": {
"id": 21,
"symbol": "USDT"
}
}
}
}