Full Payment & Installment - Payment API Credit Card
This API uses after finishing the API Full Payment & Installment - Registration API Credit Card. API used in this stage is similar to the API for the Recurring Token and Pre-Auth & Capture payment type. However, there are several differences in the sent request parameter.
API Endpoint | /nicepay/direct/v2/payment |
Request Method | POST |
Description | Full Payment & Installment - Payment API Credit Card |
Merchant Token | SHA256(timeStamp+iMid+referenceNo+amt+merchantKey) |
Request Format | application/x-www-form-urlencoded |
On the Credit Card payment, if 3Ds authentication is needed, your Customer will direct to the 3Ds card Issuer Bank page to input the OTP (One Time Password) code to finish the transaction process.
The following is the list of request parameters to process the payment transaction on the credit card Full Payment & Installment payment method. Request Parameter proceeds through Form-Url with the following detailed parameter:
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20221202141217 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST01202212021455054652 |
referenceNo | N | 40 | Reference number for payment | ordNo20221202141217 |
cardNo Required for CC | N | 20 | Credit Card Number | 4434260000000008 |
cardExpYymm Required for CC | A | 4 | Card Expiry (YYMM) | 3901 |
cardCvv Required for CC | N | 4 | Card CVV | 101 |
cardHolderNm Required | AN | 45 | Card Holder Name | John Doe |
cardHolderEmail Required | ANS | 100 | Card Holder Email | |
merchantToken Required | AN | 255 | Merchant Token | c91e6531f6c84869439bc5ebe5389bd71e7752c054fc9dbfe193d087a1b797ae |
callBackUrl Required | ANS | 255 | Payment Result URL | https://merchant.com/callBackUrl |
Parameter needed in the transaction process is the Your Customer credit/debit card data such as cardNo, cardExpYymm, cardCvv, cardHolderNm & cardHolderEmail.
So, to do the transaction process, we suggest You get the card data from Your Customer beforehand before doing the Payment API process.
Include cardCVV on every transaction depending on the MID type of cvv or non-cvv.
After you request, you will get a response from URL Callback with the following detailed response parameter:
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 14 | Result Code | |
resultMsg | AN | 255 | Result message: Error Code | |
tXid | AN | 30 | Transaction ID | When success |
referenceNo | ANS | 40 | Merchant Order No | When success |
payMethod | N | 2 | When success | |
amt | N | 12 | Payment Amount | When success |
currency | AN | 3 | Currency | When success |
goodsNm | A | 100 | Goods Name | When success |
billingNm | A | 100 | Buyer Name | When success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | When success |
transTm | N | 6 | Transaction Time (HH24MISS) | When success |
description | AN | 100 | Transaction Description | When success |
authNo | N | 10 | Approval Number | When success, CC |
issuBankCd | A | 4 | When success, CC | |
acquBankCd | A | 4 | When success, CC | |
cardNo | ANS | 20 | Masked Card No | When success, CC |
cardExpYymm | N | 4 | Card Expiry (YYMM) | When success, CC |
instmntMon | N | 2 | Installment Month | When success, CC |
instmntType | N | 2 | When success, CC | |
ccTransType | N | 2 | 1: Normal 2: Recurring 3: Pre-auth 4: Capture | When Success, CC |
After the transaction occurs, You will get a notification from us based on the inputted Callback URL in the request parameter on Payment - API Credit Card.
When Your callback already received callbackUrl, we recommended the Merchant to do the status verification using the Status Inquiry - API Credit Card.
CallBack Handling is very important to minimize the Fraud act, we highly recommend the Merchant to do the verification using callBack Handling .