---
title: Payment - API Checkout
slug: en/nicepay-api-payment-api-checkout
description: Information about API Checkout - Payment for all payment methods provided by NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/MNNx1R78WjQXXl6v4sOlz_rdrx9d8diazpgm07xfz2test-1.png
icon: {"faIcon":"fa-solid fa-book"}
docTags: 
createdAt: 2022-09-21T02:54:45.000Z
---

# Displays Payment Page from PaymentURL

***

When you successfully registers the transaction request on the [Registration - API Checkout](docId\:pjBflBNCehkuuuqQSAiug), 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](docId\:pjBflBNCehkuuuqQSAiug) response.

Consider the following example:

```none
paymentURL: https://www.nicepay.co.id/nicepay/redirect/v2/payment
txid : IONPAYTEST00202203211640309389

NICEPAY Payment Page: https://www.nicepay.co.id/nicepay/redirect/v2/payment?tXid=IONPAYTEST00202203211640309389
```

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.

:::hint{type="warning"}
For the E-Wallet payment method with ShopeePay and OVO, we suggest your Customer open the payment method through their mobile phone devices.
:::

![](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/S5eJ83C9qS5tTJ4x4D9Ru_eng-new-secure-payment-page-payloan-3.png "Successful Payment Page")

# Parameter Format Payment Page

| **Parameter**                                             | **Type** | **Size** | **Description**       | **Remark**                                              |
| --------------------------------------------------------- | -------- | -------- | --------------------- | ------------------------------------------------------- |
| `paymentURL`  <br /><font color="#2166ae">Required</font> | ANS      | 14       | Payment URL           | https\://nicepay.co.id/nicepay/redirect/v2/payment&#xD; |
| `tXid` <br /><font color="#2166ae">Required</font>        | AN       | 30       | Transaction ID	<br /> | IONPAYTEST00202203211640309389                          |



# After Payment Handling

***

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](docId\:pjBflBNCehkuuuqQSAiug).

:::hint{type="info"}
Please visit the [Notification - API Checkout](docId\:kV4WdqbNeJrlHW1YOW6J8) page for more detailed information regarding `dbProcessURL`.
:::

## Response Parameters (CallbackUrl)&#x20;



| **Parameter**                                                               | **Type** | **Size** | **Description**                                                                                                                             | **Remark**                                                                               |
| --------------------------------------------------------------------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `resultCd`                                                                  | N        | 4        | [Result Code](docId:9eC3yH9CQqpb6cRWauWWO)                                                                                                  | 0000                                                                                     |
| `resultMsg`                                                                 | AN       | 255      | Result Message: [Error Code](docId\:FsX1GESJKxOp0T9rvUHp_)                                                                                  | SUCCESS                                                                                  |
| `tXid`                                                                      | AN       | 30       | Transaction ID	                                                                                                                             | IONPAYTEST01202212141112221428<br /><br />When success                                   |
| `referenceNo`                                                               | ANS      | 40       | Order Number                                                                                                                                | (empty)<br /><br />When success                                                          |
| `payMethod`<br /><font color="#2166ae">E-Wallet, Payloan</font>             | N        | 2        | [Payment Method Code](docId\:NQ1y7vMa25ZtvQHN5He6W)                                                                                         | 01<br /><br />When success                                                               |
| `amt`                                                                       | N        | 12       | Transaction Amount                                                                                                                          | 10000<br /><br />When success                                                            |
| `currency`<br /><font color="#2166ae">E-Wallet, Payloan</font>              | A        | 3        | Currency                                                                                                                                    | IDR<br /><br />When success                                                              |
| `payNo`<br /><font color="#2166ae">CVS</font>                               | N        | 20       | Payment Number                                                                                                                              |                                                                                          |
| `goodsNm`<br /><font color="#2166ae">E-Wallet, Payloan</font>               | AN       | 100      | Goods Name	                                                                                                                                 | Testing Transaction NICEPAY <br /><br />When success                                     |
| `billingNm`<br /><font color="#2166ae">E-Wallet, Payloan</font>             | A        | 100      | Billing Name                                                                                                                                | John Doe<br /><br />When success                                                         |
| `transDt`                                                                   | N        | 8        | Transaction Date (`YYYYMMDD`)	                                                                                                              | 20221212<br /><br />When success                                                         |
| `transTm`                                                                   | N        | 6        | Transaction Time (`HH24MISS`)	                                                                                                              | 121212<br /><br />When success                                                           |
| `description`                                                              | AN       | 100      | Transaction Description	                                                                                                                    | Testing Credit Card Transaction<br /><br />When success                                  |
| `authNo`<br /><font color="#2166ae">Only CC (Additional)</font>             | N        | 10       | Approval Number	                                                                                                                            | 080623<br /><br />When success                                                           |
| `issuBankCd`<br /><font color="#2166ae">Only CC</font>                      | A        | 4        | [Issuing Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0)                                                                                           | OTHR<br /><br />When success                                                             |
| `acquBankCd`<br /><font color="#2166ae">Only CC</font>                      | A        | 4        | [Acquiring Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0)                                                                                         | BMRI<br /><br />When success<br />&#xD;                                                  |
| `cardNo`<br /><font color="#2166ae">Only CC</font>                          | ANS      | 20       | Card Number with Masking	                                                                                                                   | 453211\*\*\*\*\*1111<br /><br />When success                                             |
| `timestamp`                                                                 | N        | 14       | API Request Timestamp                                                                                                                       | 20221212121212<br /><br />When Success                                                   |
| `merchantToken`<br /><font color="#2166ae">CC</font>                        | AN       | 255      | Merchant Token                                                                                                                              | 2035d2295d9578fffb40137186f0203474142ae3e57992d4847826c5fcaffce6<br /><br />When Success |
| `cardExpYymm`<br /><font color="#2166ae">CC</font>                          | N        | 4        | Card Expiration (`YYMM`)                                                                                                                    | 2712<br /><br />When Success                                                             |
| `instmntMon`<br /><font color="#2166ae">CC</font>                           | N        | 2        | Installment Month<br />`1`: 1 Month/Full Payment, *if* `instmntType`*:* *null/1*<br />`3`: 3 Months<br />`6`: 6 Months<br />`12`: 12 Months | 1<br /><br />When Success                                                                |
| `instmntType`<br /><font color="#2166ae">CC</font>                          | N        | 2        | [Installment Type Code](docId:_Wzur5wjwhrDR8YXI-Ppi)                                                                                        | 1<br /><br />When Success                                                                |
| `ccTransType`<br /><font color="#2166ae">CC</font>                          | AN       | 2        | Credit Card Transaction Type:<br />`1`: Normal<br />`2`: Recurring<br />`3`: Pre-Auth<br />`4`: Capture                                     | 1<br /><br />When Success                                                                |
| `recurringToken`<br /><font color="#2166ae">Only CC (Additional)</font>     | AN       | 255      | Recurring Token                                                                                                                             |                                                                                          |
| `vat`<br /><font color="#2166ae">CC</font>                                  | N        | 12       | Value Added Tax (VAT)                                                                                                                       | &#xD;                                                                                    |
| `fee`<br /><font color="#2166ae">CC</font>                                  | N        | 12       | Service Fee	                                                                                                                                | &#xD;                                                                                    |
| `notaxAmt`<br /><font color="#2166ae">CC</font>                             | N        | 12       | Tax Fee Amount	                                                                                                                             | &#xD;                                                                                    |
| `mitraCd`<br /><font color="#2166ae">Direct Debit, E-Wallet, Payloan</font> | A        | 4        | [Mitra Code](docId:0luP35KfOWksiSrzKx6yZ)                                                                                                   |                                                                                          |
| `bankVacctNo`<br /><font color="#2166ae">VA</font>                          | N        | 20       | VA Number	                                                                                                                                  |                                                                                          |

:::hint{type="info"}
Response parameter will be sent through `callBackurl` with Content-type: `application/json` and method: `POST Parameter`.
:::



## Sample JSON for CallbackUrl

***

:::CodeblockTabs
URL payment

```json
https://nicepay.co.id/nicepay/redirect/v2/payment?tXid=IONPAYTEST00202203211640309389
```

Response CallBack

```json
{
    "resultCd":"0000",
    "resultMsg":"SUCCESS",
    "tXid":"IONPAYTEST01202212141112221428",
    "referenceNo":"",
    "payMethod":"01",
    "amt":"10000",
    "transDt":"20221212",
    "transTm":"121212",
    "description":"Testing Credit Card Transaction",
    "authNo":"080623",
    "issuBankCd":"OTHR"
    "acquBankCd":"BMRI",
    "cardNo":"453211*****1111",
    "goodsNm":"Test Transaction Nicepay"
    "billingNm":"John Doe",
    "currency":"IDR",
    "timeStamp":"20221212121212",
    "merchantToken":"2035d2295d9578fffb40137186f0203474142ae3e57992d4847826c5fcaffce6",
    "cardExpYymm":"2712",
    "instmntMon":"1",
    "instmntType":"1",
    "ccTransType":"1"
}
```
:::



CallBack Handling API Checkout&#x20;
------------------------------------

***

::Image[]{src="https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/eMkBILN_IdNLFXTXs64K9_nicepay-api-checkout-api-callback-handling-flowdrawio-2.png" size="50" width="370" height="361" caption="Callback Handling Flow" position="center" darkWidth="370" darkHeight="361" showCaption="true"}

:::hint{type="info"}
- 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](docId\:RhH7PmISd6IHN99yWVJHm).
- `CallBack Handling` is very helpful to minimalize Fraud actions, we strongly recommend the Merchant to verify the `callBack Handling`.
:::

