Direct Debit - API Checkout
This API uses by Merchant to requests payment to NICEPAY for Direct Debit payment method using Checkout API.
![Direct Debit Payment Flow Direct Debit Payment Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/8nOh24is8MCYhCLTIXqYV_nicepay-archbee-payment-clickpay-new-clickpay-redirect.png?format=webp)
Steps description:
- The Customer requests checkout to the Merchant.
- The Merchant will register checkout by using Registration API to NICEPAY.
- NICEPAY save Regist order.
- NICEPAY redirect Merchant to the NICEPAY page.
- The Merchant displays NICEPAY's payment page to the Customer.
- The Customer chooses the payment method.
- The Customer input the payment data (Jenius: Cashtag).
- The Customer sends the selected payment method to NICEPAY.
- NICEPAY requests payment to Bank.
- Bank proceeds with the authentication process.
- Bank sends notification authentication to the Customer.
- The Customer performs authentication.
- The Customer requests the charge to Bank.
- Bank does the payment process.
- Bank sends the payment result to the Customer.
- Bank sends push notification to NICEPAY.
- NICEPAY validates the notification.
- NICEPAY updates the status.
- NICEPAY sends a notification to the Merchant.
- The Merchant requests status checking by using Status API to the NICEPAY.
- NICEPAY sends the response status to the Merchant.
- The Merchant receives the final status.
- The Merchant sends the confirmation status update to the Customer.
![Secure Payment Page Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/yLpR4t6nw4qifhSZ9Q8Pl_eng-new-secure-payment-page-gpn.png?format=webp)
The image above is a payment sample with Direct Debit method using NICEPAY Secure Payment Page.
![Direct Debit - Secure Payment Page Direct Debit - Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/zkccnmD9OwehJhEyF2b4C_eng-new-secure-payment-page-clickpay-2-1.png?format=webp)
After selecting the method with Direct Debit, you will be redirected to the page to select the desired Direct Debit service. Next, you will be redirected to the form page to enter your identity. In the example above, if you choose Jenius service, you will be asked to enter your Cashtag data in the form provided. After completing the form, you can continue the payment process. Then, you can proceed until the order payment is successful.
![Success - Secure Payment Page Success - Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/VuSpcStEq1K15j97FFTbt_eng-new-secure-payment-page-clickpay-3.png?format=webp)
The process of payment registration request has been completed. You can continue the transaction process until settlement by following the guidelines in the Direct Debit Payment Guide.
API URL | /nicepay/redirect/v2/payment |
Request Method | Redirect-GET |
Header | Content-Type: application/Form-UrlEncoded |
Parameter | Type | Size | Description | Remark |
paymentURL Required | ANS | 14 | Payment URL | https://dev.nicepay.co.id/nicepay/redirect/v2/payment |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST00202203211640309389 |
Parameter | Type | Size | Description | Remark |
status | N | 1 | 0 | |
merchantToken | AN | 255 | Merchant Token | 46ca2f8a7b0b24ad57e49f879764718e40839f67d00c22b3f79ba328f2a0a8aa When Success |
goodsNm Direct Debit, E-Wallet, Payloan | AN | 100 | Goods Name | Jhon+Doe When Success |
billingNm Direct Debit, E-Wallet, Payloan | A | 100 | Billing Name | Jhon+Doe When Success |
referenceNo | ANS | 40 | Order Number | ORD20230525090536 When Success |
mitraCd Direct Debit, E-Wallet, Payloan | A | 4 | Mitra Code | JENC When Success |
tXid | AN | 30 | Transaction ID | TNICECP04100202305250918306465 When Success |
amt | N | 12 | Transaction Amount | 5000 When Success |
receiptCode | ANS | 20 | Authorization Number | 951527524097 When Success |
instmntType | N | 2 | 2 When Success | |
instmntMon | N | 2 | Installment Month 1: 1 Month/Full Payment, if instmntType : null/1 3: 3 Months 6: 6 Months 12: 12 Months | 1 When Success |
matchCl | N | 1 | 0 When Success | |
mRefNo | AN | 18 | Reference Number | 202305250918303 When Success |
payMethod | N | 2 | 04 When Success | |
currency | A | 3 | Currency | IDR When Success |
Note: Response parameter will be sent through callBackurl with Content-type: application/json and method: POST Parameter.
On the payment when Checkout, the response from the request that got hit is a callback URL.
When Your callback already received callbackUrl, we recommended the Merchant to do the status verification using the Status Inquiry - API Checkout.
CallBack Handling is necessary to minimize Fraud actions. We strongly recommend Merchant to verify using callBack parameter.
![Callback Handling Flow Callback Handling Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/Y81RdVCmzpTYM1_5uyFqT_nicepay-api-checkout-api-callback-handling-flow-1.png?format=webp)