IPNs (Instant Payment Notifications) are sent to the notify_url provided by merchants when apply the withdrawal, when withdrawal status is changed.

🚧

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

Withdrawal Status

IndexEventStatusDescription
1payment_initiatedPENDINGInitial withdrawal request made by the user
2payment_cancelledCANCELEDUser canceled the request
3payment_confirmedCONFIRMEDUser confirmed; awaiting system/admin review
4payment_rejectedREJECTEDRequest declined post-review
5payment_approvedAPPROVEDRequest approved and processing
6payment_completedCOMPLETEDFunds transferred successfully
7payment_failedFAILEDTransfer failed due to errors

Example

{
	"ipn_type": "payment",
	"event": "payment_initiated",
	"payment_id": "ab379d3c-107c-407b-8c64-886ad9e80fc9",
	"network": "BANK_SWIFT",
	"asset_type": "USD",
	"amount": 1000.0,
	"fee": 32.00,
	"status": "PENDING",
	"transfer_method": "BANK",
	"transfer_destination": {
		"network": "BANK_SWIFT",
		"beneficiary": {
			"title": null,
			"name": "Jack Green",
			"address": "Test Address",
			"city": "Test City",
			"state": "Test State",
			"country": "LT",
			"zip_code": "8000"
		},
		"bank": {
			"name": "DBS Bank",
			"address": null,
			"country": null
		},
		"intermediary_bank": null,
		"account_number": "0000000000",
		"routing_number": null,
		"iban": null,
		"bic": "DBSSSGSG",
		"reference": ""
	},
	"detail": null,
	"note": null,
	"create_time": "2024-08-23T03:16:13.8022892Z",
	"update_time": "2024-08-23T03:16:13.8022893Z",
	"notify_id": "fd0fbed6-215d-4c3b-a21c-c9c8e5d6c459",
	"notify_time": "2024-08-23T03:16:13.832002Z"
}

Description

invoice_idstringUniPayment Invoice ID.
ipn_typestringIPN type, withdrawal is for invoice notification
eventstringEvent type for invoice
withdrawal_idstringThis is the amount buyer will send the crypto payment.
networkstringBlockChain from which gateway will send the fund
asset_typestringBlockChain from which buyer will send the payment
addressaddressThe address
amountfloatAmount of withdrawal
feefloatFee of withdrawal
statusstringThe status of withdrawal
create_timedatetimeCreate time of withdrawal
update_timedatetimeUpdate time of withdrawal
notify_idstringUnique notify Id
notify_timedatetimeNotify time