Recurring - Registration API Credit Card
Tentang Recurring - Registration API Credit Card
Pembayaran tipe Recurring adalah pilihan tipe pembayaran menggunakan Kartu Kredit yang melakukan pembayaran suatu tagihan secara berkala dengan nominal yang sama seperti yang ditagihkan pada awal pembayaran.
API yang digunakan pada tahap pendaftaran sama dengan API untuk mendaftarkan tipe Full Payment & Installment, namun terdapat perbedaan pada request parameter yang dikirimkan.
Pelajari mengenai fitur Credit Card Payment dengan Recurring di Fitur Kartu Kredit.
Silakan mengunjungi halaman Kartu Kredit untuk mempelajari informasi umum seputar Kartu Kredit.
Recurring - Registration API Credit Card
API URL | /nicepay/direct/v2/registration |
|---|---|
Request Method | POST |
Description | Recurring |
Merchant Token | SHA256(timeStamp+iMid+referenceNo+amt+merchantKey) |
Request Format | application/json |
Request Parameter for Recurring - Registration API Credit Card
Berikut ini adalah daftar parameter untuk melakukan proses integrasi Recurring untuk metode pembayaran Kartu Kredit.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20221202141217 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 01 (Credit Card) | |
currency Required | A | 3 | Currency | IDR |
amt Required | N | 12 | Amount (number not in float format) | 10000 (Jumlah total amount goods dari cartData) |
referenceNo Required | ANS | 40 | Merchant's Reference Number | ordNo20221202141217 |
goodsNm Required | AN | 100 | Goods Name | Testing Transaction |
billingNm Required | A | 100 | Buyer Name | John Doe |
billingPhone Required | N | 15 | Buyer Phone No. | 2112345678 |
billingEmail Required | ANS | 40 | Buyer E-mail | |
billingAddr Required | AN | 100 | Buyer Address | Jln. Raya Kasablanka Kav.88 |
billingCity Required | A | 50 | Buyer City | South Jakarta |
billingState Required | A | 50 | Billing State | DKI Jakarta |
billingPostCd Required | N | 10 | Billing Post Number | 14350 |
billingCountry Required | A | 10 | Billing Country | Indonesia |
cartData Optional | JSONstring | 4000 | Cart Data | {} |
instmntType Required | N | 2 | 1 (Untuk PreAuth & Recurring default 1) | |
instmntMon Required | N | 2 | Installment Month 1: 1 Month/Full Payment, jika instmntType: null/1 | 1 (Untuk PreAuth & Recurring default 1) |
recurrOpt Required | N | 2 | 0: Automatic Cancel 1: Do not cancel 2: Do not make token | 2 |
dbProcessUrl Required | ANS | 255 | Notification URL | https://merchant.com/dbProcessUrl |
userIP Required for CC, E-Wallet, Payloan, QRIS | AN | 15 | User IP | 127.0.0.1 |
merchantToken Required | AN | 255 | Merchant Token | c91e6531f6c84869439bc5ebe5389bd71e7752c054fc9dbfe193d087a1b797ae |
description | AN | 100 | Transaction Description | Test Transaction |
userSessionID | AN | 100 | User Session ID | userSessionID |
userAgent | ANS | 100 | User Agent | Mozilla |
userLanguage | A | 2 | User Language | en-US |
Cart Data for Recurring - Registration API Credit Card
cartData pada request parameter di Registrasi Kartu Kredit berguna untuk meliputi barang atau item apa saja yang akan dibayarkan oleh Pelanggan Anda berserta rincian dan harga per item.
Parameter | Deskripsi | Contoh |
|---|---|---|
Count | Total jumlah dari keseluruhan cart data | 2 |
Item | Terbagi menjadi 5 macam parameter, yaitu img_url, goods_id, goods_name, goods_detail, dan goods_amt | - |
Penjelasan detil pada parameter Item.
Parameter | Deskripsi | Contoh |
|---|---|---|
img_url | URL Gambar Barang (Ukuran 50px x 50px) | htttps://www.merchant.com/image_goods1.jpg |
goods_id | ID Barang | NICEPRDID1 |
goods_name | Nama Barang | Nama Item-1 |
goods_detail | Deskripsi Detail Barang | Detail Item-1 |
goods_amt | Harga Barang | 1000 |
Sample JSON Cart Data
{
"count": "2",
"item": [
{
"img_url": "http://www.merchant.com/image_goods1.jpg",
"goods_id": "NICEPRDID1",
"goods_name": "Item 1 Name",
"goods_detail": "Item 1 Detail",
"goods_amt": "1000"
},
{
"img_url": "http://www.merchant.com/image_goods2.jpg",
"goods_id": "NICEPRDID1",
"goods_name": "Item 2 Name",
"goods_detail": "Item 2 Detail",
"goods_amt": "1000"
}
]
}
Response Parameter for Recurring - Registration API Credit Card
Berikut adalah response parameter dari hasil request parameter untuk proses integrasi Recurring pada Kartu Kredit:
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST01202212151029182023 |
referenceNo | ANS | 40 | Merchant Reference Number | ordNo20221215101254 |
payMethod | N | 2 | 01 | |
amt | N | 12 | Payment Amount | 10000 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221212 |
transTm | N | 6 | Transaction Time (HH24MISS) | 121212 |
description | AN | 100 | Transaction Description | Testing Transaction Credit Card |
bankCd | A | 4 | null | |
vacctNo | N | 20 | Virtual Account | null |
mitraCd | A | 4 | null | |
payNo | N | 12 | CVS Payment Number | null |
currency | A | 3 | Currency | IDR |
goodsNm | AN | 100 | Goods Name | Goods For Testing Transaction |
billingNm | A | 100 | Buyer Name | John Doe |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) | null |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) | null |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) | null |
payValidTm | N | 6 | Expiry Time (HH24MISS) | null |
requestURL | ANS | 360 | Request URL | null |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) | null |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) | null |
qrContent | ANS | 360 | QR String in Plain Text | null |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes | null |
Sample Parameter for Recurring - Registration API Credit Card
Request Parameter
const nicepayClient = require("nodejs-nicepay");
let secondVersion = new nicepayClient.SecondApiVersion({
isProduction: false,
isCloudServer: false,
merchantKey: "YOUR_MERCHANT_KEY"
});
const parameter = {
timeStamp: "20221213101276",
iMid: "RECURRTEST",
payMethod: "01",
currency: "IDR",
amt: "5000",
referenceNo: "ordNo20221213101276",
goodsNm: "Goods For Testing",
billingNm: "John Doe",
billingPhone: "081288998899",
billingEmail: "[email protected]",
billingAddr: "Jln. Raya Kasablanka Kav.88",
billingCity: "South Jakarta",
billingState: "DKI Jakarta",
billingPostCd: "12800",
billingCountry: "Indonesia",
cartData: "{\"count\":\"1\",\"item\":[{\"goods_id\":\"NICEPRDID1\",\"img_url\":\"http://www.merchant.com/image_goods1.jpg\",\"goods_name\":\"Goods For Testing\",\"goods_detail\":\"Goods For Testing Details\",\"goods_amt\":\"5000\",\"goods_quantity\":\"1\"}]}",
dbProcessUrl: "http://ptsv2.com/t/merchant/post",
userIP: "127.0.0.1",
instmntType: "1",
instmntMon: "1",
recurrOpt: "1",
userLanguage: "en",
userAgent:
"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0",
};
let endPoint = "/direct/v2/registration";
secondVersion.requestAPI(parameter, endPoint);
Response Parameter
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"tXid": "RECURRTEST01202510081035159576",
"referenceNo": "ordNo20221213101276",
"payMethod": "01",
"amt": "5000",
"transDt": "20251008",
"transTm": "103515",
"description": null,
"bankCd": null,
"vacctNo": null,
"mitraCd": null,
"payNo": null,
"currency": null,
"goodsNm": null,
"billingNm": null,
"vacctValidDt": null,
"vacctValidTm": null,
"payValidDt": null,
"payValidTm": null,
"requestURL": null,
"paymentExpDt": null,
"paymentExpTm": null,
"qrContent": null,
"qrUrl": null
}