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
Index | Event | Status | Description |
---|---|---|---|
1 | payment_initiated | PENDING | Initial withdrawal request made by the user |
2 | payment_cancelled | CANCELED | User canceled the request |
3 | payment_confirmed | CONFIRMED | User confirmed; awaiting system/admin review |
4 | payment_rejected | REJECTED | Request declined post-review |
5 | payment_approved | APPROVED | Request approved and processing |
6 | payment_completed | COMPLETED | Funds transferred successfully |
7 | payment_failed | FAILED | Transfer 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_id | string | UniPayment Invoice ID. |
---|---|---|
ipn_type | string | IPN type, withdrawal is for invoice notification |
event | string | Event type for invoice |
withdrawal_id | string | This is the amount buyer will send the crypto payment. |
network | string | BlockChain from which gateway will send the fund |
asset_type | string | BlockChain from which buyer will send the payment |
address | address | The address |
amount | float | Amount of withdrawal |
fee | float | Fee of withdrawal |
status | string | The status of withdrawal |
create_time | datetime | Create time of withdrawal |
update_time | datetime | Update time of withdrawal |
notify_id | string | Unique notify Id |
notify_time | datetime | Notify time |