JSON
{
"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.
Parameter Type Mandatory Description requestId string Yes id of the request that created webhook subscription. id number Yes id of the event. createdDate string Yes creation date of the event. level string Yes level of the notification for the event. [SUCCESS, INFO, WARNING] service string Yes group of events which the event belongs to. data object Yes set of data depending on the event type. See list of field for each event type below.
Parameter Type Description type string event type: INVOICE_CREATE_INVOICE amount number money amount of the created invoice. message string text of the invoice. currency string currency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ] parentExternalId number system id of the invoice. createdDate string date and time of invoice creation idempotencyKey string the external id that was generated while invoice creating through api. externalId string merchant ID of invoice
Parameter Type Description type string event type: INVOICE_CREATE_UNLIMITED_INVOICE message string text of the invoice. currency string currency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ] parentExternalId number system id of the invoice. createdDate string date and time of invoice creation idempotencyKey string the external id that was generated while invoice creating through api. externalId string merchant ID of invoice
Parameter Type Description type string event type: INVOICE_FUNDS_RECEIVED_FOR_INVOICE amount number amount of received money to invoice wallet. transactionId array System ID of the invoice deposits. message string text of the invoice. currency string currency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ] parentExternalId number system id of the invoice. createdDate string date and time of invoice creation. senderAddress string wallet address from where funds were sent. idempotencyKey string the external id that was generated while invoice creating through api. externalId string merchant ID of invoice paymentDate string date of deposit transaction creation. transactionHash string hash of the deposit transaction. fiatAmount object invoice amount in fiat currency.
Parameter Type Description type string Event type: INVOICE_PENDING_INTERVENTION message string text of the invoice. parentExternalId number system id of the invoice. idempotencyKey string the external id that was generated while invoice creating through api. externalId string merchant ID of invoice
Parameter Type Description type string event type: INVOICE_TRANSLATION_TO_ACCOUNT_COMPLETED amount number money amount of the invoice. message string text of the invoice. currency string currency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ] parentExternalId number system id of the invoice. createdDate string date and time of invoice creation. idempotencyKey string the external id that was generated while invoice creating through api. serviceFee number service fee for invoice deposit. fiatAmount object invoice amount in fiat currency. transactionIds array system IDs of deposits for invoice. Always one ID in unlimited invoices, usually one ID in single invoices, but may be more IDs if intervention occurred.
Parameter Type Description type string Event type: INVOICE_EXPIRED parentExternalId number system id of the invoice. idempotencyKey string the external id that was generated while invoice creating through api. amount number money amount of the invoice. currency string currency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ] message string description of the invoice. createdDate string date and time of invoice creation. expirationDate string date and time of invoice expiration. externalId string merchant ID of invoice fiatAmount object invoice amount in fiat currency.
Parameter Type Description amount number money amount of the invoice. currency string currency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ] description string description of the invoice. externalId string merchant ID of invoice fiatAmount number amount in fiat currency if it was set in fiat. fiatCurrency string fiat currency of the invoice if it was set in fiat. [ USDT, EUR ] idempotencyKey string the external id that was generated while invoice creating through api. parentExternalId number system id of the invoice. realAmount number amount of money that client really paid for the invoice. type string Event type: INVOICE_PAID.
Parameter Type Description amount number money amount of the invoice. currency string currency of the invoice. [ BNB, BTC, BUSD, BUSD_ETH, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT_MATIC, USDT_TRX, XDG, BTC_LNG, USDT_BSC ] description string description of the invoice. externalId string merchant ID of invoice fiatAmount number amount in fiat currency if it was set in fiat. fiatCurrency string fiat currency of the invoice if it was set in fiat. [ USDT, EUR ] idempotencyKey string the external id that was generated while invoice creating through api. parentExternalId number system id of the invoice. realAmount number amount of money that client really paid for the invoice. type string Event type: INVOICE_MEMPOOL_FOUND. createdDate string date and time of invoice creation. transactionHash string hash of the incoming transaction to the invoice wallet.
Parameter Type Description hash string transaction hash. type string event type: PAYOUT_CHANGE_STATUS. parentExternalId number system id of the payout. createdDate string date and time of payout creation. payoutStatus string current state of the payout. idempotencyKey string the external id that was generated while payout creating through api. currency string currency of the payout.
Parameter Type Description type string event type: PAYOUT_CONFIRMED. parentExternalId number system id of the payout. createdDate string date and time of payout creation. approved array list of users who approved the payout. idempotencyKey string the external id that was generated while payout creating through api. currency string currency of the payout.
Parameter Type Description type string Event type: PAYOUT_SPEEDED_UP. parentExternalId number system id of the payout. createdDate string date and time of payout creation. speededUpParameter string user who speeded up the payout transaction. idempotencyKey string the external id that was generated while payout creating through api. currency string currency of the payout.
Parameter Type Description type string event type: PAYOUT_VALIDATION_ERROR. parentExternalId number system id of the payout. message string validation error message. createdDate string date and time of payout creation. dealWithdrawalId number system id of withdrawal where validation error occured. validationStatus string the reason of validation error. idempotencyKey string the external id that was generated while payout creating through api. currency string currency of the payout.
Parameter Type Description parentExternalId number system id of the payout. idempotencyKey string the external id that was generated while payout creating through api. message string validation error message. currency string currency of the payout.
