Webhook payload

Webhook payload example

{
  "requestId": "bf9348b7-2c14-46d7-868c-b597852da319",
  "id": 1,
  "createdDate": "2022-03-15T12:13:05.909616",
  "level": "SUCCESS",
  "service": "INVOICE",
  "eventType": "INVOICE_CREATE_INVOICE",
  "data": {
    "parentExternalId": 3,
    "amount": 0.01,
    "currency": "ETH",
    "message": "Invoice example",
    "createdDate": "2022-03-15T12:13:03.157015",
    "type": "INVOICE_CREATE_INVOICE",
    "idempotencyKey": "5b0ca8da-6af4-4a1c-9efd-5cbfc19ace09"
  }
}

Webhooks deliver the responses to your service in JSON format. The parameters that webhook payload inludes are listed in the table below.

ParameterTypeMandatoryDescription
requestIdstringYesid of the request that created webhook subscription.
idnumberYesid of the event.
createdDatestringYescreation date of the event.
levelstringYeslevel of the notification for the event. [SUCCESS, INFO, WARNING]
servicestringYesgroup of events which the event belongs to.
dataobjectYesset of data depending on the event type. See list of field for each event type below.

Data object depending on event type

INVOICE_CREATE_INVOICE
ParameterTypeDescription
typestringevent type: INVOICE_CREATE_INVOICE
amountnumbermoney amount of the created invoice.
messagestringtext of the invoice.
currencystringcurrency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ]
parentExternalIdnumbersystem id of the invoice.
createdDatestringdate and time of invoice creation
idempotencyKeystringthe external id that was generated while invoice creating through api.
externalIdstringmerchant ID of invoice
INVOICE_CREATE_UNLIMITED_INVOICE
ParameterTypeDescription
typestringevent type: INVOICE_CREATE_UNLIMITED_INVOICE
messagestringtext of the invoice.
currencystringcurrency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ]
parentExternalIdnumbersystem id of the invoice.
createdDatestringdate and time of invoice creation
idempotencyKeystringthe external id that was generated while invoice creating through api.
externalIdstringmerchant ID of invoice
INVOICE_FUNDS_RECEIVED_FOR_INVOICE
ParameterTypeDescription
typestringevent type: INVOICE_FUNDS_RECEIVED_FOR_INVOICE
amountnumberamount of recieved money to invoice wallet.
messagestringtext of the invoice.
currencystringcurrency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ]
parentExternalIdnumbersystem id of the invoice.
createdDatestringdate and time of invoice creation.
senderAddressstringwallet address from where funds were sent.
idempotencyKeystringthe external id that was generated while invoice creating through api.
externalIdstringmerchant ID of invoice
INVOICE_TRANSLATION_TO_WALLET_COMPLETED
ParameterTypeDescription
typestringevent type: INVOICE_TRANSLATION_TO_WALLET_COMPLETED
amountnumbermoney amount of the invoice.
realAmountnumberreal amount of money received on the merchant wallet.
messagestringtext of the invoice.
currencystringcurrency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ]
parentExternalIdnumbersystem id of the invoice.
createdDatestringdate and time of invoice creation.
senderAddressstringinvoice wallet address from where funds were sent.
walletParameterstringhot wallet Parameter where funds were sent.
walletAddressstringhot wallet address where funds were sent.
idempotencyKeystringthe external id that was generated while invoice creating through api.
externalIdstringmerchant ID of invoice
INVOICE_PENDING_INTERVENTION
ParameterTypeDescription
typestringEvent type: INVOICE_PENDING_INTERVENTION
messagestringtext of the invoice.
parentExternalIdnumbersystem id of the invoice.
idempotencyKeystringthe external id that was generated while invoice creating through api.
externalIdstringmerchant ID of invoice
INVOICE_FAILED
ParameterTypeDescription
typestringevent type: INVOICE_FAILED
parentExternalIdnumbersystem id of the invoice.
idempotencyKeystringthe external id that was generated while invoice creating through api.
amountnumbermoney amount of the invoice.
currencystringcurrency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ]
messagestringdescription of the invoice.
createdDatestringdate and time of invoice creation.
transactionHashstringhash of the incoming transaction to the invoice wallet.
notEnoughFundsForTokenFeeAmountnumberamount of money that is unsufficient on your main wallet for transaction fee
feeCurrencystringcurrency of the transaction fee for operation. [ BNB, BTC, ETH, MATIC, TRX, XDG ]
externalIdstringmerchant ID of invoice
INVOICE_EXPIRED
ParameterTypeDescription
typestringEvent type: INVOICE_EXPIRED
parentExternalIdnumbersystem id of the invoice.
idempotencyKeystringthe external id that was generated while invoice creating through api.
amountnumbermoney amount of the invoice.
currencystringcurrency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ]
messagestringdescription of the invoice.
createdDatestringdate and time of invoice creation.
expirationDatestringdate and time of invoice expiration.
externalIdstringmerchant ID of invoice
INVOICE_PAID
ParameterTypeDescription
amountnumbermoney amount of the invoice.
currencystringcurrency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ]
descriptionstringdescription of the invoice.
externalIdstringmerchant ID of invoice
fiatAmountnumberamount in fiat currency if it was set in fiat.
fiatCurrencystringfiat currency of the invoice if it was set in fiat. [ USDT, EUR ]
idempotencyKeystringthe external id that was generated while invoice creating through api.
parentExternalIdnumbersystem id of the invoice.
payAmountnumberamount to pay for invoice completing.
realAmountnumberamount of money that clien really paid for the invoice.
typestringEvent type: INVOICE_PAID.
INVOICE_MEMPOOL_FOUND
ParameterTypeDescription
amountnumbermoney amount of the invoice.
currencystringcurrency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ]
descriptionstringdescription of the invoice.
externalIdstringmerchant ID of invoice
fiatAmountnumberamount in fiat currency if it was set in fiat.
fiatCurrencystringfiat currency of the invoice if it was set in fiat. [ USDT, EUR ]
idempotencyKeystringthe external id that was generated while invoice creating through api.
parentExternalIdnumbersystem id of the invoice.
payAmountnumberamount to pay for invoice completing.
realAmountnumberamount of money that clien really paid for the invoice.
typestringEvent type: INVOICE_MEMPOOL_FOUND.
createdDatestringdate and time of invoice creation.
transactionHashstringhash of the incoming transaction to the invoice wallet.
PAYOUT_CHANGE_STATUS
ParameterTypeDescription
hashstringtransaction hash.
typestringevent type: PAYOUT_CHANGE_STATUS.
parentExternalIdnumbersystem id of the payout.
createdDatestringdate and time of payout creation.
payoutStatusstringcurrent state of the payout.
idempotencyKeystringthe external id that was generated while payout creating through api.
currencystringcurrency of the payout.
PAYOUT_CONFIRMED
ParameterTypeDescription
typestringevent type: PAYOUT_CONFIRMED.
parentExternalIdnumbersystem id of the payout.
createdDatestringdate and time of payout creation.
approvedarraylist of users who approved the payout.
idempotencyKeystringthe external id that was generated while payout creating through api.
currencystringcurrency of the payout.
PAYOUT_SPEEDED_UP
ParameterTypeDescription
typestringEvent type: PAYOUT_SPEEDED_UP.
parentExternalIdnumbersystem id of the payout.
createdDatestringdate and time of payout creation.
speededUpParameterstringuser who speeded up the payout transaction.
idempotencyKeystringthe external id that was generated while payout creating through api.
currencystringcurrency of the payout.
PAYOUT_VALIDATION_ERROR
ParameterTypeDescription
typestringevent type: PAYOUT_VALIDATION_ERROR.
parentExternalIdnumbersystem id of the payout.
messagestringvalidation error message.
createdDatestringdate and time of payout creation.
dealWithdrawalIdnumbersystem id of withdrawal where validation error occured.
validationStatusstringthe reason of validation error.
idempotencyKeystringthe external id that was generated while payout creating through api.
currencystringcurrency of the payout.
PAYOUT_WITHDRAWALS_CREATING_VALIDATION_ERROR
ParameterTypeDescription
parentExternalIdnumbersystem id of the payout.
idempotencyKeystringthe external id that was generated while payout creating through api.
messagestringvalidation error message.
currencystringcurrency of the payout.