Payment - API Checkout
When you successfully registers the transaction request on the Registration - API Checkout, you will get response in the form of paymentURL. To displays payment page on the Front-end's side, you are required to does paymentURL mapping at first with an additional parameters on the URL, which is ?tXid= and completed by txid obtained in the Registration - API Checkout response.
Consider the following example:
When the Payment Page is already appropriate, then your requested transaction is ready to be paid by the Customer. You only needed to display the link or embedded link on your website.
For the E-Wallet payment method with ShopeePay and OVO, we suggest your Customer open the payment page through their mobile phone devices.
![Successful Payment Page Successful Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/S5eJ83C9qS5tTJ4x4D9Ru_eng-new-secure-payment-page-payloan-3.png?format=webp)
Parameter | Type | Size | Description | Remark |
paymentURL Required | ANS | 14 | Payment URL | https://nicepay.co.id/nicepay/redirect/v2/payment |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST00202203211640309389 |
After the transaction is successfully done by your Customer, a notification related to the status transaction, either successful or failed, will be sent automatically to your system through the inputted callbackURL and dbProcessURL parameters during request through Registration - API Checkout.
Please visit the Notification - API Checkout page for more detailed information regarding dbProcessURL.
Parameter | Type | Size | Description | Remark |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST01202212141112221428 When success |
referenceNo | ANS | 40 | Order Number | (empty) When success |
payMethod E-Wallet, Payloan | N | 2 | 01 When success | |
amt | N | 12 | Transaction Amount | 10000 When success |
currency E-Wallet, Payloan | A | 3 | Currency | IDR When success |
payNo CVS | N | 20 | Payment Number | |
goodsNm E-Wallet, Payloan | AN | 100 | Goods Name | Testing Transaction Nicepay When success |
billingNm E-Wallet, Payloan | A | 100 | Billing Name | John Doe When success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221212 When success |
transTm | N | 6 | Transaction Time (HH24MISS) | 121212 When success |
description | AN | 100 | Transaction Description | Testing Credit Card Transaction When success |
authNo Only CC (Additional) | N | 10 | Approval Number | 080623 When success |
issuBankCd Only CC | A | 4 | OTHR When success | |
acquBankCd Only CC | A | 4 | BMRI When success
| |
cardNo Only CC | ANS | 20 | Card Number With Masking | 453211*****1111 When success |
timestamp | N | 14 | API Request Timestamp | 20221212121212 When Success |
merchantToken CC | AN | 255 | Merchant Token | 2035d2295d9578fffb40137186f0203474142ae3e57992d4847826c5fcaffce6 When Success |
cardExpYymm CC | N | 4 | Card Expiration (YYMM) | 2712 When Success |
instmntMon CC | N | 2 | Installment Month 1: 1 Month/Full Payment, jika instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months | 1 When Success |
instmntType CC | N | 2 | 1 When Success | |
ccTransType CC | AN | 2 | 1 When Success | |
recurringToken Only CC (Additional) | AN | 255 | Recurring Token | |
vat CC | N | 12 | Value Added Tax (VAT) |
|
fee CC | N | 12 | Service Fee |
|
notaxAmt CC | N | 12 | Tax Fee Amount |
|
mitraCd Direct Debit, E-Wallet, Payloan | A | 4 | | |
bankVacctNo VA | N | 20 | VA Number | |
Response parameter will be sent through callBackurl with Content-type: application/json and method: POST Parameter.
![Callback Handling Flow Callback Handling Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/eMkBILN_IdNLFXTXs64K9_nicepay-api-checkout-api-callback-handling-flowdrawio-2.png?format=webp)
- The tXid won't be the same as the request hold. The capture process will make sure that the amount value being captured doesn't exceed the funds owned.
- When Callback received to your callbackUrl, we strongly recommend the Merchant to verify the Status using Status Inquiry - API Checkout.
- CallBack Handling is very helpful to minimalize Fraud actions, we strongly recommend the Merchant to verify the callBack Handling.