IPN - Invoice

IPNs (Instant Payment Notifications) are sent to the notify_url provided by merchants when creating the invoice, when invoice status is changed to paid, confirmed and complete.

🚧

1.Notification sent by gateway is in POST Method.
2.Body is a JSON-formatted string (content-Type: application/json)

Invoice Status Change Process

Invoice is paid in full

Index	Event	Status	error_status	Description
1	invoice_created	New	None	Invoice is created
2	invoice_paidInFull	Paid	None	Buyer make the payment
3	invoice_confirmed	Confirmed	None	Payment is confirmed by some blocks
4	invoice_completed	Complete	None	Payment is completed

Invoice is expired without payment

Index	Event	Status	error_status	Description
1	invoice_created	New	None	Invoice is created
2	invoice_expired	Expired	None	Invoice is expired

Invoice is over paid

Index	Event	Status	error_status	Description
1	invoice_created	New	None	Invoice is created
2	invoice_paidInFull	Paid	PaidOver	Buyer make the payment(OverPay)
3	invoice_confirmed	Confirmed	PaidOver	Payment is confirmed by some blocks
4	invoice_completed	Complete	PaidOver	Payment is completed

Invoice is partial paid

Index	Event	Status	error_status	Description
1	invoice_created	New	None	Invoice is created
2	invoice_expired	Expired	PaidPartial	Payment expired with PaidPartial

Example

Response

{
  "ipn_type": "invoice",
  "event": "invoice_created",
  "app_id": "de5076a5-71aa-4a4a-a35f-bdb424af5658",
  "invoice_id": "XjwyQQanwVVUtJXVMGXtCe",
  "order_id": "#0001",
  "price_amount": 10,
  "price_currency": "USD",
  "network": null,
  "address": null,
  "pay_currency": "USDT",
  "pay_amount": 0,
  "exchange_rate": 0,
  "paid_amount": 0,
  "confirmed_amount": 0,
  "refunded_price_amount": 0,
  "create_time": "2023-05-05T03:54:29.5708901Z",
  "expiration_time": "2023-05-05T15:54:29.5708934Z",
  "status": "New",
  "error_status": "None",
  "ext_args": null,
  "transactions": null,
  "notify_id": "714c8f9e-b06d-49b9-9ebc-203f7cadcaa0",
  "notify_time": "2023-05-05T03:55:49.1566646Z"
}

Description

Field Name	Type	Description
ipn_type	string	The type of IPN; 'invoice' specifies it is for invoice notifications.
event	string	The specific event type associated with the invoice.
app_id	string	The unique identifier for the Merchant's Payment Application.
invoice_id	string	The unique identifier for the UniPayment Invoice.
price_amount	float	The original amount requested in the transaction, matching the request.
price_currency	string	The currency of the price_amount, identical to that specified in the request.
pay_amount	float	The actual amount in cryptocurrency that the buyer is expected to pay.
pay_currency	string	The type of cryptocurrency the buyer will use for the payment.
network	string	The blockchain network from which the payment will be sent by the buyer.
address	address	The cryptocurrency address to which the payment should be sent.
exchange_rate	float	The rate at which the pay_currency is converted to the price_currency.
paid_amount	float	The amount of cryptocurrency, as defined by pay_currency, that the buyer has paid.
confirmed_amount	float	The amount of cryptocurrency, as defined by pay_currency, confirmed by the blockchain network.
refunded_price_amount	float	The amount refunded to the customer by the merchant, if applicable.
create_time	datetime	The timestamp marking the creation of the invoice.
expiration_time	datetime	The timestamp after which the invoice will no longer be valid.
status	string	The current status of the invoice. See InvoiceStatus
error_status	string	Describes any errors related to the invoice. See InvoiceErrorStatus
notify_id	string	A unique identifier for the notification related to this invoice.
notify_time	datetime	The timestamp when the notification was sent.