Payout Integration & Testing
Integration Steps Including API Used On It
- Perform Request Payout API integration ( Registration - API Payout (Disbursement) SNAP).
- Perform Approve Payout API integration ( Approve Transaction - API Payout (Disbursement) SNAP) and prepare Disbursement to the destination account.
- Receive callback and push notifications from NICEPAY.
- Perform Inquiry Payout integration (Inquiry - API Payout (Disbursement) SNAP) so Merchant can check order status using Inquiry API.
- Additional: perform Cancel Payout API ( Cancel Transaction - API Payout (Disbursement) SNAP) integration to abort transaction.
Assure your Payout balance is sufficient before creating a Payout transaction. Please check the Balance Deposits page for further information about the Payout deposit fund.
Credentials To Test Payout
Environment | Description |
|---|---|
Development | Bank Account
|
Payout Test Guide
Test Steps | Payout Method Options |
|---|---|
| Set parameter value payoutMethod:
|
Failed Transaction Possible Reasons
- Timeout from the Bank side.
- Invalid Bank account.
- Insufficient fund.
Integration Checklist and Test Case
Implement inquiry status after receiving callback.
Implement inquiry status after receiving notification if it is setting on Merchant url notification.
Review payment log.
Review firewall settings (eg. Cloudflare to setting URL notif)
Check merchantToken implementation.
Running test scenario on Development Environment.
Running test scenario on Production Environment. Get Sample Scenario
Review Error Handling (Timeout, Failed, Negative Case).
Best Practice
- For testing on the Merchant side can use IMID IONPAYTEST and transfer option set payoutMethod parameter.
- reserved_dt reserved_tm for scheduling.
- Request with or not with reserved_dt reserved_tm can Approve & Reject.
- After Approve, it can’t cancel if there is reserved_dt reserved_tm or can cancel if there is reserved_dt reserved_tm (while it has not pass reserved_dt reserved_tm yet ).
- When notification receives on URL Merchant notification, NICEPAY highly recommends Merchant to verify the notification using Inquiry API.
- Notification Handling is used to minimalize Fraud actions, NICEPAY highly recommends Merchants perform Notification Handling verification.
See also
Visit the Payout Fund Transfer Flow page to find out the process on Payout system.
Visit the Payout Method page to find out the fund sending method available on Payout.