Credit Card - API Checkout
There are several things that you must know when using for method so that your will run smoothly with us:
- Flow 3Ds/Non-3Ds Process.
- Installment Feature.
- Recurring Token Feature.
- Pre-Auth Token Feature.
visit Credit Card Feature to check explanation about 3Ds.
open Credit Card Payment Guide to provide your with guide on method.
After selects method, will ask to input their card data. will automatically recognize type of 's BIN card like in picture below, such as VISA or Mastercard, American Express, etc, later cards will be different according to card types being used.
Then, will run. Once is successful, then display of will appear as image as follows.
visit Payment - API Checkout to know next step regarding payment handling.
Parameter | Type | Size | Description | Remark |
---|---|---|---|---|
status | N | 1 | 0 | |
tXid | AN | 30 | Transaction ID | IONPAYTEST00202212201540174369 When Success |
referenceNo | AN | 40 | ordNo20221220151243 When Success | |
payMethod | N | 2 | 01 When Success | |
amt | N | 12 | Transaction Amount | 1000 When Success |
notaxAmt | N | 12 | Tax Fee Amount | 0 When Success |
vat | N | 12 | 0 When Success | |
fee | N | 12 | Service Fee | 0 When Success |
currency | A | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Goods+For+Testing+Credit+Card When Success |
billingNm | A | 100 | Billing Name | John+Doe When Success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221220 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 154017 When Success |
authNo | N | 10 | Approval Number | 174300 When Success (Additional) |
issuBankCd | A | 4 | BMRI When Success | |
acquBankCd | A | 4 | BMRI When Success | |
issuBankNm | A | 255 | Mandiri When Success | |
acquBankNm | A | 255 | Mandiri When Success | |
ccTransType | AN | 2 | 1 When Success | |
cardNo | ANS | 20 | Card Number with Masking | 46161111****1111 When Success |
cardExpYymm | N | 4 | Card Expiration (YYMM) | 2707 When Success |
instmntType | N | 2 | 1 When Success | |
instmntMon | N | 2 | 1 When Success | |
recurringToken | AN | 255 | Recurring Token | null When Success |
preauthToken | AN | 255 | Pre-Auth Token | null When Success |
matchCl | N | 1 | 1 When Success | |
merchantToken | AN | 255 | 8f5b330a549c167b53b4b9fd5f2d2eba897a64235c1610524074ec59f8884e8a |
API URL | /nicepay/redirect/v2/payment |
---|---|
Request Method | Redirect-GET |
Header | Content-Type: application/Form-UrlEncoded |
After completes Registration - API Checkout and Payment - API Checkout, then will provide recurringToken for gain Payment - API Checkout response.
On next with same , can use that recurringToken by using on Recurring - Payment API Credit Card.
Parameter | Type | Size | Description | Remark |
---|---|---|---|---|
status | N | 1 | 0 | |
tXid | AN | 30 | Transaction ID | RECURRTEST00202212221422115631 When Success |
referenceNo | AN | 40 | ordNo20221222141245 When Success | |
payMethod | N | 2 | 01 When Success | |
amt | N | 12 | Transaction Amount | 1000 When Success |
notaxAmt | N | 12 | Tax Fee Amount | 0 When Success |
vat | N | 12 | 0 When Success | |
fee | N | 12 | Service Fee | 0 When Success |
currency | A | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Goods+For+Testing+Recurring+Token When Success |
billingNm | A | 100 | Billing Name | John+Doe When Success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221220 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 142211 When Success |
authNo | N | 10 | Approval Number | 115631 When Success (Additional) |
issuBankCd | A | 4 | OTHR When Success | |
acquBankCd | A | 4 | BMRI When Success | |
issuBankNm | A | 255 | (empty) When Success | |
acquBankNm | A | 255 | Mandiri When Success | |
ccTransType | AN | 2 | 1 When Success | |
cardNo | ANS | 20 | Card Number with Masking | 45321111****1111 When Success |
cardExpYymm | N | 4 | Card Expiry (YYMM) | 2712 When Success |
instmntType | N | 2 | 1 When Success | |
instmntMon | N | 2 | 1 When Success | |
recurringToken | AN | 255 | Recurring Token | 083333e129dea0535119b71813b1dc67b565e2704958411d2ee2ec2f430d745 When Success |
preauthToken | AN | 255 | Pre-Auth Token | null When Success |
matchCl | N | 1 | Amount Match Flag: Notification Status Code | 1 When Success |
merchantToken | AN | 255 | f083333e129dea0535119b71813b1dc67b565e2704958411d2ee2ec2f430d745 |
After ing with registration (Registration - API Checkout) and (Payment - API Checkout) using ,
- If you want to with Recurring using same Recurring Token, please do registration again on Registration - API Checkout.
When s sign a contract as PAC (Pre-Auth/Capture), provides a preauthToken for Payment - API Checkout response. That token will later use on capture amount to complete on Pre-Auth & Capture - Payment API Credit Card.
The following are lists to perform requests with Pre-Auth Token . This uses in platform as one of steps to connect 's s with s.
Parameter | Type | Size | Description | Remark |
---|---|---|---|---|
status | N | 1 | 5 | |
tXid | AN | 30 | Transaction ID | PACTEST00100202212221548525731 When Success |
referenceNo | AN | 40 | ordNo20221222151220 When Success | |
payMethod | N | 2 | 01 When Success | |
amt | N | 12 | Transaction Amount | 1000 When Success |
notaxAmt | N | 12 | Tax Fee Amount | 0 When Success |
vat | N | 12 | 0 When Success | |
fee | N | 12 | Service Fee | 0 When Success |
currency | A | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Goods+For+Testing+Pre+-+Auth+Token When Success |
billingNm | A | 100 | Billing Name | John+Doe When Success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221222 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 154852 When Success |
authNo | N | 10 | Approval Number | 525731 When Success (Additional) |
issuBankCd | A | 4 | CENA When Success | |
acquBankCd | A | 44 | BMRI When Success | |
issuBankNm | A | 255 | BCA When Success | |
acquBankNm | A | 255 | Mandiri When Success | |
ccTransType | AN | 2 | 1 When Success | |
cardNo | ANS | 20 | Card Number with Masking | 53079511****1111 When Success |
cardExpYymm | N | 4 | Card Expiry (YYMM) | 2712 When Success |
instmntType | N | 2 | 1 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 |
recurringToken | AN | 255 | Recurring Token | null When Success |
preauthToken | AN | 255 | Pre-Auth Token | edc46eb30a81ac9753e34003d2d1e910d5aaf0dea620889dffcfcc18621864eb When Success |
matchCl | N | 1 | Amount Match Flag: Notification Match Amount Indicator | 1 When Success |
merchantToken | AN | 255 | 1bee4b7c84cfb4e04d9d26cd47285bf49a77f252f39a48370094f5e3250b9524 |
When Your callback already received callbackUrl, we recommended to do verification using Status Inquiry - API Checkout.