IPN - Invoice

IPNs (Instant Payment Notifications) are sent to the notify_url provided by merchants when creating the invoice, when order 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

Name	Type	Description
ipn_type	string	IPN type, invoice is for invoice notification.
event	string	Event type for invoice.
app_id	string	Merchant Payment App ID.
invoice_id	string	UniPayment Invoice ID.
price_amount	float	Same as request.
price_currency	string	Same as request.
pay_amount	float	This is the amount buyer will send the crypto payment.
pay_currency	string	Crypto currency buyer will send the payment
network	string	BlockChain from which buyer will send the payment
address	address	The address
exchange_rate	float	The exchange rate from pay_currency to price_currency.
paid_amount	float	The amount of cryptocurrency (defined by pay_currency) paid by the buyer.
confirmed_amount	float	The amount of cryptocurrency (defined by pay_currency) confirmed by the blockchain network.
refunded_price_amount	float	This is the amount merchant refunded.
create_time	datetime	Invoice creation time.
expiration_time	datetime	Invoice expiration time.
status	string	Invoice status.See InvoiceStatus
error_status	string	Invoice error status.See InvoiceErrorStatus
transactions	object array
notify_id	string	Notification unique Id.
notify_time	datetime	Notification send time.