GPN - API Checkout
This API uses by Merchant to requests a payment to the NICEPAY for GPN payment method using Checkout API.
![GPN Process Flow GPN Process Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/blfWNLifmcX_5PECmbMvh_nicepay-archbee-payment-gpn-redirect.png?format=webp)
Steps description:
- The Customer performs checkout.
- The Customer sends the checkout data to the Merchant.
- The Merchant sends checkout requests by using Registration API to NICEPAY.
- NICEPAY proceeding the checkout registration process.
- NICEPAY redirects Merchant to NICEPAY's payment page.
- The Merchant displays NICEPAY's page to the Customer.
- The Customer chooses the payment method.
- The Customer inputs the card data.
- The Customer sends the card data by using Payment API to NICEPAY.
- NICEPAY requests token from Bank/Issuing GPN.
- The Bank/Issuing GPN receives the request.
- The Bank/Issuing GPN sends the token to NICEPAY
- NICEPAY receives the verification response.
- At the same time:
- NICEPAY redirects the Customer to the DAS authentication page.
- NICEPAY requests OTP from Bank/Issuing GPN,
- The Bank/Issuing GPN sends OTP to the Customer.
- The Customer receives the OTP.
- The Customer inputs and sends OTP to the Bank/Issuing GPN.
- The Bank/Issuing GPN validates the OTP.
- The Bank/Issuing GPN sends the response validation to NICEPAY.
- NICEPAY requests a charge to the Bank/Issuing GPN.
- The Bank/Issuing GPN performs the charge amount.
- The Bank/Issuing GPN sends the payment notification to NICEPAY.
- NICEPAY redirects Merchant to callbackUrl.
- The Merchant displays callbackUrl to the Customer.
- NICEPAY sends the payment notification to the Merchant.
- The Merchant receives the notification.
- The Merchant requests inquiry status to NICEPAY.
- NICEPAY receives the request.
- NICEPAY sends the inquiry status response to the Merchant.
- The Merchant receives the final status.
- The Merchant sends the transaction result page to the Customer.
Before making an API calls for Transaction Payment, execute the Transaction Registration first.
![Secure Payment Page Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/MA0NV2gpPBT36kG7itP4g_eng-new-secure-payment-page-gpn.png?format=webp)
The image above is a sample of checkout payment procedures with the GPN method using the NICEPAY Secure Payment Page.
After choosing the Bank Transfer method, you will be provided by Bank lists that can be used to continue the payment process.
The process of submitting a payment registration request has been completed. You can continue the transaction process until settlement by following the guidelines on the GPN Payment Guide.
API URL | /nicepay/redirect/v2/payment |
Request Method | Redirect-GET |
Header | Content-Type: application/Form-UrlEncoded |
Parameter | Type | Size | Description | Remark |
paymentURL | ANS | 14 | Payment URL Required | https://dev.nicepay.co.id/nicepay/redirect/v2/payment |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST00202212201342456336 |
Note: The response parameter will be sent through callBackurl with Content-type: application/json and method: POST Parameter.
On the payment in Checkout, the response from the request that gets hit is the 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 very important to minimize the Fraud act, we highly recommend the Merchant to do the verification using callBack parameter.
![Callback Handling Flow Callback Handling Flow](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/OUMptNJjJPMmefkBqRpQS_nicepay-api-checkout-api-callback-handling-flow-1.png?format=webp)