# Invoice webhooks

**Webhook Events**

| Event type                                   | Description                                                                                                                              |
| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| INVOICE\_CREATE\_INVOICE                     | New single invoice has been created                                                                                                      |
| INVOICE\_CREATE\_UNLIMITED\_INVOICE          | New unlimited invoice has been created                                                                                                   |
| INVOICE\_FUNDS\_RECEIVED\_FOR\_INVOICE       | Funds have been received to invoice wallet                                                                                               |
| INVOICE\_TRANSLATION\_TO\_ACCOUNT\_COMPLETED | Funds have been received from invoice wallet to the merchant balance.                                                                    |
| INVOICE\_PENDING\_INTERVENTION               | Invoice has changed state to INVOICE\_PENDING\_INTERVENTION. Either more or less funds was received to the invoice wallet than required. |
| INVOICE\_EXPIRED                             | Invoice expiration date has expired.                                                                                                     |
| INVOICE\_PAID                                | Invoice successfully paid. All required amount has been received to invoice wallet.                                                      |
| INVOICE\_MEMPOOL\_FOUND                      | Invoice transaction has been found in mempool but still not confirmed in blockchain.                                                     |
| INVOICE\_PENDING\_COMPLIANCE                 | Invoice transaction is being reviewed by our compliance service                                                                          |
| INVOICE\_COMPLIANCE\_DECLINED                | Invoice has been suspended due to our compliance polic                                                                                   |

**Payload description**

**INVOICE\_CREATE\_INVOICE**

| 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 | crypto currency of the invoice. \[BNB, BTC, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT\_MATIC, USDT\_TRX, USDC\_TRX, XDG, USDT\_BSC]                                                                                                                                                         |
| fiatCurrency     | string | fiat currency of the invoice. \[USD, EUR, RUB, AED, ARS, AUD, AZN, BOB, BRL, BYN, CAD, CLP, COP, CRC, CZK, EGP, GHS, GTQ, HKD, HNL, IDR, INR, JPY, KES, KHR, KRW, KZT, MMK, MXN, MYR, NGN, NOK, NZD, PEN, PHP, PLN, RON, SAR, SEK, SGD, THB, TRY, TWD, UAH, UGX, UZS, VES, VND, XAF, XOF, ZAR] |
| 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                                                                                                                                                                                                                                                                         |

**INVOICE\_CREATE\_UNLIMITED\_INVOICE**

| Parameter        | Type   | Description                                                                                                                              |
| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| type             | string | event type: INVOICE\_CREATE\_UNLIMITED\_INVOICE                                                                                          |
| message          | string | text of the invoice.                                                                                                                     |
| currency         | string | crypto currency of the invoice. \[ BNB, BTC, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT\_MATIC, USDT\_TRX, USDC\_TRX, XDG, 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                                                                                                                   |

**INVOICE\_FUNDS\_RECEIVED\_FOR\_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 | crypto currency of the invoice. \[ BNB, BTC, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT\_MATIC, USDT\_TRX, USDC\_TRX, XDG, USDT\_BSC ] |
| parentExternalId | number | system id of the invoice.                                                                                                                |
| idempotencyKey   | string | the external id that was generated while invoice creating through api.                                                                   |
| createdDate      | string | date and time of invoice creation.                                                                                                       |
| senderAddress    | string | wallet address from where funds were sent.                                                                                               |
| invoiceAddress   | string | invoice address to which funds were received.                                                                                            |
| 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.                                                                                                         |

**INVOICE\_PENDING\_INTERVENTION**

| 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                                                 |

**INVOICE\_TRANSLATION\_TO\_ACCOUNT\_COMPLETED**

| 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 | crypto currency of the invoice. \[ BNB, BTC, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT\_MATIC, USDT\_TRX, USDC\_TRX, XDG, 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. |

**INVOICE\_EXPIRED**

| 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 | crypto currency of the invoice. \[ BNB, BTC, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT\_MATIC, USDT\_TRX, USDC\_TRX, XDG, USDT\_BSC ]                                                                                                                                                       |
| fiatCurrency     | string | fiat currency of the invoice. \[USD, EUR, RUB, AED, ARS, AUD, AZN, BOB, BRL, BYN, CAD, CLP, COP, CRC, CZK, EGP, GHS, GTQ, HKD, HNL, IDR, INR, JPY, KES, KHR, KRW, KZT, MMK, MXN, MYR, NGN, NOK, NZD, PEN, PHP, PLN, RON, SAR, SEK, SGD, THB, TRY, TWD, UAH, UGX, UZS, VES, VND, XAF, XOF, ZAR] |
| 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.                                                                                                                                                                                                                                                               |

**INVOICE\_PAID**

| Parameter        | Type   | Description                                                                                                                              |
| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| amount           | number | money amount of the invoice.                                                                                                             |
| currency         | string | crypto currency of the invoice. \[ BNB, BTC, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT\_MATIC, USDT\_TRX, USDC\_TRX, XDG, 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.                                                                                                               |

**INVOICE\_MEMPOOL\_FOUND**

| Parameter        | Type   | Description                                                                                                                              |
| ---------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| amount           | number | money amount of the invoice.                                                                                                             |
| currency         | string | crypto currency of the invoice. \[ BNB, BTC, DAI, ETH, FRAX, MATIC, TRX, USDC, USDT, USDT\_MATIC, USDT\_TRX, USDC\_TRX, XDG, 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.                                                                                  |

**INVOICE\_COMPLIANCE\_CHECK**

| Parameter        | Type   | Description                                                            |
| ---------------- | ------ | ---------------------------------------------------------------------- |
| type             | string | event type: INVOICE\_COMPLIANCE\_CHECK                                 |
| 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.                                               |
| 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.                                       |

**INVOICE\_COMPLIANCE\_DECLINED**

| Parameter        | Type   | Description                                                            |
| ---------------- | ------ | ---------------------------------------------------------------------- |
| type             | string | event type: INVOICE\_COMPLIANCE\_DECLINED                              |
| 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.                                               |
| 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.                                       |
