Invoicing Webhook

We offer webhook callbacks for clients that want to be updated when a deposit is detected on-chain or finalized.

Webhook payload examples

Aquanow invoice guarantees at-least-once delivery of our webhook messages, and to avoid duplicates, you can utilize txHash and adminApproval as deduplication IDs.

Invoice Closed / Fully Paid

{
  invoiceId: 'e7a12656-107d-414d-b48b-fdbe5e1711ac',
  username: 'AqPay',
  createdAt: '2025-02-06T05:38:36.993Z',
  invoiceStatus: 'CLOSED',
  paymentStatus: 'PAID',
  customerPaysFee: true,
  invoiceSymbol: 'USD',
  amountDue: 50,
  invoiceAmount: 50.4,
  invoicingFee: 0.4,
  processingFee: 0.39999999744,
  invoiceReceivedAmount: 50.39999967744,
  expirationTime: 1739079520534,
  activatedAt: '2025-02-06T05:38:40.534Z',
  accountId: 'CA1001112C'
}

Callback parameter values

Parameter	Type	Description
invoiceId	string	Invoice Id provided by Aquanow, can be used for query an invoice status
username	string	Your username
createdAt	string	Time of invoice creation in epoch
invoiceStatus	"CREATED" | "OPEN" | "CLOSED"	Status of the invoice. NOTE: Closed means that the invoice has been finalized; look at payment Status for whether or not the invoice was fully paid off
paymentStatus	"PAID" | "NOT PAID" | "PARTIALLY_PAID" | "OVERPAID" | "UNDERPAID"	Status of payment for the invoice
customerPaysFee	string	If the customer pays the fee → The invoiced amount includes both the amount due and the fee. If the customer does NOT pay the fee → The invoiced amount includes only the amount due, and your business covers the fee after conversion.
invoiceSymbol	string	Symbol for the invoice
amountDue	number	Total value of the invoice (in fiat)
invoiceAmount	number	Total amount of the invoice after fees (in fiat)
invoicingFee	number	Fee of the invoice (in fiat)
processingFee	string	Fee (in fiat) applied after crypto conversion
invoiceReceivedAmount	number	Amount received from the client in crypto
expirationTime	number	Time of expiration in epoch
activatedAt	string	Time of activation in epoch
accountId	string	accountId for your Aquanow account