NAV Navbar
  • DOKUMENTASI API V2
  • Pengantar
  • Registration
  • Payment
  • Credit Card
  • Virtual Account
  • Convenience Store
  • ClickPay
  • E-Wallet
  • Notification
  • Order Status (Inquiry)
  • Cancel
  • Nicepay Code
  • Inquiry
  • F.A.Q
  • Test Postman
  • Changelog
  • VA Instruction Templates
  • DOKUMENTASI API V2

    Pengantar

    Selamat datang di Referensi API NICEPay.

    NICEPay Payment Solution adalah produk dari PT IONPAY NETWORKS yang menyediakan berbagai pembayaran elektronik melalui Internet dengan aman tanpa perangkat pengaman yang terpisah. NICEPay telah berintegrasi dengan Bank melalui host ke host connection untuk kinerja yang lebih baik dan cepat. Dengan menggunakan teknologi terkini, NICEPay percaya untuk menumbuhkan bisnis Anda bersama.

    Kami memiliki beberapa bahasa pemrograman seperti di java, csharp, php, python, dan ruby.

    Preparation

    API NICEPay dapat diminta melalui HTTPS Request ke endpoint URL NICEPay Base.

    Development Environment : https://qa.nicepay.co.id/
    Production Environment : https://api.nicepay.co.id/

    Integration Process

    1. Memahami SDK, Parameter, dan Flow pembayaran.
    2. Menjelajahi API Operation Calls.
    3. Integrasi
    4. Tes pelaksanaan (Development)
    5. Minta MID dan API Key untuk production.
    6. Go Live

    Prerequisites

    1. Test MID
    2. Test API Key
    3. SDK Bahasa Pemrograman NICEPay (Java,PHP,and other)
    4. Ubah Url API : api -> qa

    API Methods

    API Endpoint Method Description
    /nicepay/direct/v2/registration POST API untuk pendaftaran transaksi
    /nicepay/direct/v2/payment POST API untuk pembayaran transaksi
    /notification (example) POST API untuk notifikasi (dbProcessUrl dalam registration API)
    /nicepay/direct/v2/inquiry POST API untuk cek status transaksi
    /nicepay/direct/v2/cancel POST API untuk membatalkan transaksi

    Registration

    Contoh cartData JSON

    {
        "count": "2",  
        "item": [  
            {
                "img_url": "http://img.aaa.com/ima1.jpg",  
                "goods_name": "Item 1 Name",
                "goods_detail": "Item 1 Detail",
                "goods_amt": "700"
            },  
            {
                "img_url": "http://img.aaa.com/ima2.jpg",
                "goods_name": "Item 2 Name",
                "goods_detail": "Item 2 Detail",
                "goods_amt": "300"
            }  
            ] 
    } 
    

    Contoh JSON Request

    {
        "deliveryPhone":"62-21-0000-0000",
        "mitraCd":"ALMA",
        "fee":"0",
        "amt":"1000",
        "description":"this is test transaction!!",
        "notaxAmt":"0",
        "reqDomain":"localhost",
        "userLanguage":"ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4",
        "vacctValidDt":"",
        "billingEmail":"no-reply@ionpay.net",
        "merFixAcctId":"",
        "payMethod":"01",
        "deliveryAddr":"Jalan Jenderal Gatot Subroto Kav.57",
        "billingCountry":"ID",
        "userIP":"0:0:0:0:0:0:0:1",
        "instmntMon":"1",
        "currency":"IDR",
        "payValidDt":"",
        "deliveryCity":"Jakarta",
        "merchantToken":"b5149659e1a2f1271fb0833f8ea20e174b6fd389db26bc6ad036cc0dae6fa797",
        "goodsNm":"T-1000",
        "referenceNo":"OrdNo2017717942577",
        "vat":"0",
        "userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36",
        "billingState":"Jakarta",
        "userSessionID":"697D6922C961070967D3BA1BA5699C2C",
        "instmntType":"1",
        "deliveryNm":"HongGilDong",
        "deliveryPostCd":"12950",
        "reqClientVer":"",
        "iMid":"IONPAYTEST",
        "billingNm":"HongGilDong",
        "timeStamp":"20170822170942",
        "dbProcessUrl":"http://127.0.0.1:8080/nicepay/test3/dbProcess.do",
        "payValidTm":"",
        "cartData":"{“count”: “1”,“item”: [{“img_url”: “https://www.lecs.com/image/introduction/img_vmd020101.jpg”,“goods_name”: “Jam Tangan Army - Strap Kulit - Hitam”,“goods_detail”: “jumlah 1”,“goods_amt”: “400”}]}",
        "deliveryState":"Jakarta",
        "deliveryCountry":"ID",
        "bankCd":"",
        "billingPostCd":"12950",
        "billingAddr":"Jalan Jenderal Gatot Subroto Kav.57",
        "reqServerIP":"172.29.2.178",
        "vacctValidTm":"",
        "billingPhone":"021-579-00000",
        "billingCity":"Jakarta"
    }
    

    Contoh JSON Response

    {
        "resultCd": "0000",
        "resultMsg": "SUCCESS",
        "tXid": "IONPAYTEST01201804191154334593",
        "referenceNo": "OrdNo2017717942577",
        "payMethod": "01",
        "amt": "1000",
        "transDt": "20180419",
        "transTm": "115416",
        "description": "this is test transaction!!",
        "bankCd": null,
        "vacctNo": null,
        "mitraCd": null,
        "payNo": null,
        "currency": null,
        "goodsNm": null,
        "billingNm": null,
        "vacctValidDt": null,
        "vacctValidTm": null,
        "payValidDt": null,
        "payValidTm": null
    }
    

    API ini untuk Registrasi Transaksi.
    Detail Metode Pembayaran untuk Registrasi:

    Code PayMethod Deskripsi Status
    01 Credit Card (CC) Order will be created Available
    02 Virtual Account (VA) Virtual Account will be created Available
    03 Convenience Store (CVS) Pay number will be created Available
    04 ClickPay Order will be created Coming Soon
    05 E-Wallet Order will be created Coming Soon
       
    API url /nicepay/direct/v2/registration
    Metode POST, JSON
    Description Perform for Transaction Registration
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Request JSON Object

    Parameter Mandatory Tipe Deskripsi
    timeStamp Y N API Request Date
    iMid Y AN Merchant Id
    payMethod Y AN Payment Method
    currency Y AN currency
    amt Y N Payment Amount
    referenceNo Y ANS Merchant Order No (Key from merchant)
    goodsNm Y AN Goods Name
    billingNm Y A Buyer name
    billingPhone Y N Buyer Phone Number
    billingEmail Y AN Buyer email
    billingAddr N AN Buyer address
    billingCity Y A Buyer city
    billingState Y A Billing state
    billingPostCd Y N Billing Post number
    billingCountry Y A Billing Country
    deliveryNm N A delivery name
    deliveryPhone N N delivery phone number
    deliveryAddr N AN delivery address
    deliveryCity N A delivery city
    deliveryState N A delivery state
    deliveryPostCd N N delivery post number
    deliveryCountry N A delivery country
    dbProcessUrl Y AN Payment Notification url (Async notification)
    vat N N Vat
    fee N N service fee
    notaxAmt N N tax free amount
    description N AN Transaction description
    merchantToken Y AN merchantToken
    reqDt N N Request date (YYYYMMDD)
    reqTm N N request time (HH24MISS)
    reqDomain N AN request domain
    reqServerIP N AN request server IP
    reqClientVer N AN request client version
    userIP Y AN user IP (customer)
    userSessionID N AN user session ID
    userAgent N AN user agent information
    userLanguage N A user language
    cartData Y AN cart data
    instmntType CC N Installment Type, refer Code at Here
    instmntMon CC N Installment month
    recurrOpt CC Recurring N Recurring option
    0: Automatic Cancel
    1: Do not cancel
    2: Do not make token
    bankCd VA A bank code, refer Code at Here
    vacctValidDt VA N VA expiry date (YYYYMMDD)
    vacctValidTm VA N VA expiry time (HH24MISS)
    merFixAcctId VA AN Merchant Reserved VA ID
    mitraCd CVS A Mitra code, refer Code at Here


    cartData JSON Object

    Parameter Deskripsi
    count Total card data count
    item
    Item -> img_url good's image URL (image size 50*50)
    Item -> goods_name goods name
    Item -> goods_detail goods detail description
    Item -> goods_amt goods Payment amount


    Response JSON Object

    Parameter Tipe Deskripsi Remark
    resultCd N result code
    resultMsg AN result message
    tXid AN Transaction Id (Key from NICEPay) When success
    referenceNo ANS Merchant Order No (Key from merchant) When success VA,CVS
    payMethod N Payment Metode When success VA,CVS
    amt N Payment amount When success VA,CVS
    currency AN currency When success VA,CVS
    goodsNm AN Goods Name When success VA,CVS
    billingNm A Buyer name When success VA,CVS
    transDt N Transaction date (YYYYMMDD) When success VA,CVS
    transTm N Transaction time(HH24MISS) When success VA,CVS
    description AN Transaction Description When success VA,CVS
    bankCd A bank code When success VA, refer Code at Here
    vacctNo N Virtual Account number When success VA
    vacctValidDt N VA expiry date (YYYYMMDD) When success VA
    vacctValidTm N VA expiry time (HH24MISS) When success VA
    mitraCd AN Mitra code When success CVS, refer Code at Here
    payNo N CVS Number When success CVS
    payValidDt N CVS expiry date (YYYYMMDD) When success CVS
    payValidTm N CVS expiry time (HH24MISS) When success CVS

    Payment

    Contoh JSON Request

    timeStamp=20180302112151&tXid=TESTIDTEST01201803021122164984&merchantToken=b4171e8228be7a75d19ad29b509e76d5fc70a4c000ef87bc55cf0cda72767e72&cardNo=1234567890123456&cardExpYymm=2006&cardCvv=123&cardHolderNm=Thomas Alfa Edison&recurringToken=&preauthToken=&clickPayNo=&dataField3=&clickPayToken=&callBackUrl=https://merchant.com/callBackUrl

    Contoh Response Parameter(redirect to the callbackUrl)

    callbackUrl?resultCd=0000&resultMsg=SUCCESS&tXid=TESTIDTEST01201803021122164984&referenceNo=99997&payMethod=01&amt=10000&transDt=20180302&transTm=112216&description=Payment of referenceNo 99997&authNo=164984&issuBankCd=BMRI&issuBankNm=PT Bank Mandiri (Persero)&acquBankCd=BMRI&acquBankNm=PT Bank Mandiri (Persero)&cardNo=123456******3456&receiptCode=&mitraCd=&recurringToken=&preauthToken=&currency=IDR&goodsNm=Test Transaction Nicepay&billingNm=Customer Name&ccTransType=1&mRefNo=&instmntType=2&instmntMon=1&cardExpYymm=2006

    API ini untuk Proses Pembayaran.
    Detail Payment Method :

    Code PayMethod Deskripsi
    01 Credit Card (CC) If 3DS / MIGS authentication is required, the page will be redirect to the card issuer page.
    04 ClickPay The page will be redirect to the e-wallet payment window.
    05 E-Wallet The page will be redirect to the ClickPay payment window.
       
    API url /nicepay/direct/v2/payment
    Metode POST (Popup, Redirect, Submit, etc) [not server to server API]
    Description Perform for Transaction Registration
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Request POST Parameter

    Parameter Mandatory Tipe Deskripsi
    timeStamp Y N API Request Date
    tXid Y AN Transaction ID
    cardNo CC N Full card number
    cardExpYymm CC N card expiry(YYMM)
    cardCvv CC N card CVV
    cardHolderNm CC CIMB AN Card Holder Name
    recurringToken CC AN Recurring Token
    preauthToken CC AN Pre-Auth Token
    clickPayNo ClickPay N ClickPay number
    dataField3 ClickPay N Token input 3 for clickpay
    clickPayToken ClickPay N Code response from token
    merchantToken Y AN merchantToken
    callBackUrl Y AN Payment result forward url (on browser)


    Response POST Parameter(redirect to the callBackUrl)

    Parameter Tipe Deskripsi Remark
    resultCd N result code
    resultMsg AN Result Message
    tXid AN Transaction Id (Key from NICEPay)
    referenceNo ANS Merchant Order No (Key from merchant)
    payMethod N Payment Metode When success
    amt N Payment amount When success
    currency AN currency When success
    goodsNm AN Goods Name When success
    billingNm AN Buyer name When success
    transDt N Transaction date (YYYYMMDD) When success
    transTm N Transaction time (HH24MISS) When success
    description AN Transaction Description When success
    authNo N Approval number When success, CC
    issuBankCd A Issuer Bank Code When success, CC. Refer Code at Here
    issuBankNm A Issuer Bank Name When success, CC.
    acquBankCd A Acquire Bank Code When success, CC. Refer Code at Here
    acquBankNm A Acquire Bank Name When success, CC.
    cardNo AN Card No with masking When success, CC
    cardExpYymm N card expiry(YYMM) When success, CC
    instmntMon N Installment month When success, CC
    instmntType N Installment Type When success, Refer Code at Here
    recurringToken AN Token that using recurring payment When Success CC Recurring
    preauthToken AN Token that using Capture process When Success CC Pre-Auth
    ccTransType AN Credit Card Transaction Type When Success, CC
    1: Normal
    2: Recurring
    3: Pre-auth
    4: Capture
    vat N Vat When Success, CC
    fee N service fee When Success, CC
    notaxAmt N tax free amount When Success, CC
    mitraCd AN Mitra Code When success ClickPay, E-Wallet. Refer Code at Here
    receiptCode ANS Authrization number When success ClickPay
    mRefNo AN Bank Reference No When success ClickPay

    Credit Card

    Integration Step :

    1. Merchant meminta Registrasi Kartu Kredit to NICEPay.
    2. Merchant meminta Pembayaran Kartu Kredit to NICEPay.
    3. NICEPay redirect ke Halaman 3DS / MIGS Bank.
    4. Pelanggan input OTP di Halaman Bank.
    5. NICEPay mengirim notifikasi.
    6. Merchant Handle notifikasi.

    Registrasi Kartu Kredit

    Contoh JSON Request

    {
        "timeStamp":"20180123100505",
        "iMid":"IONPAYTEST",
        "payMethod":"01",
        "currency":"IDR",
        "amt":"10000",
        "referenceNo":"ORD12345",
        "goodsNm":"Test Transaction Nicepay",
        "billingNm":"Customer Name",
        "billingPhone":"12345678",
        "billingEmail":"email@merchant.com",
        "billingAddr":"Jalan Bukit Berbunga 22",
        "billingCity":"Jakarta",
        "billingState":"DKI Jakarta",
        "billingPostCd":"12345",
        "billingCountry":"Indonesia",
        "deliveryNm":"email@merchant.com",
        "deliveryPhone":"12345678",
        "deliveryAddr":"Jalan Bukit Berbunga 22",
        "deliveryCity":"Jakarta",
        "deliveryState":"DKI Jakarta",
        "deliveryPostCd":"12345",
        "deliveryCountry":"Indonesia",
        "dbProcessUrl":"http://ptsv2.com/t/0ftrz-1519971382/post",
        "merchantToken":"f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5",
        "reqDomain":"merchant.com",
        "reqServerIP":"127.0.0.1",
        "userIP":"127.0.0.1",
        "userSessionID":"697D6922C961070967D3BA1BA5699C2C",
        "userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36",
        "userLanguage":"ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4",
        "instmntType":"2",
        "instmntMon":"1",
        "recurrOpt":"2"
    }
    

    Contoh JSON Response

    {
        "resultCd": "0000",
        "resultMsg": "SUCCESS",
        "tXid": "IONPAYTEST01201804191157304666",
        "referenceNo": "ORD12345",
        "payMethod": "01",
        "amt": "10000",
        "transDt": "20180419",
        "transTm": "115714",
        "description": null,
        "bankCd": null,
        "vacctNo": null,
        "mitraCd": null,
        "payNo": null,
        "currency": null,
        "goodsNm": null,
        "billingNm": null,
        "vacctValidDt": null,
        "vacctValidTm": null,
        "payValidDt": null,
        "payValidTm": null
    }
    
       
    API url /nicepay/direct/v2/registration
    Metode POST, JSON
    Deskripsi API untuk registrasi transaksi
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Silahkan lihat ke sini untuk JSON parameters.
    berikut untuk extra parameter yang akan dibutuhkan untuk Registrasi Kartu Kredit:

    Parameters Mandatory Tipe Nilai Deskripsi
    PayMethod Y AN 01 Credit Card (CC)
    instmntType Y N 2 Default for full
    instmntMon Y N 1 Default for full paid
    recurrOpt Y N 2 Default for full paid


    Response JSON Object

    Paramenter Tipe Deskripsi
    resultCd N Result code
    resultMsg AN Result Message
    tXid AN Transactionn ID (Key from NICEPay)
    referenceNo ANS Merchant order N. (Key from merchant)
    payMethod N Payment Method
    amt N Payment amount
    transDt N Transaction date (YYYYMMDD)
    transTm N Transction time (HH24MISS)
    description AN Transaction description

    Pembayaran Kartu Kredit

    Contoh POST Request Parameter

    timeStamp=20180123100505&tXid=IONPAYTEST01201804191202084760&merchantToken=f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5&cardNo=4222222222222222&cardExpYymm=2006&cardCvv=123&cardHolderNm=Thomas Alfa Edison&callBackUrl=http://merchant.com/callbackUrl

    Contoh callbackUrl dengan parameter

    referenceNo: ORD12345
    authNo: 084760
    ccTransType: 1
    mRefNo:
    issuBankCd: BMRI
    issuBankNm: PT Bank Mandiri (Persero)
    tXid: IONPAYTEST01201804191202084760
    transTm: 120208
    mitraCd:
    recurringToken:
    resultCd: 0000
    transDt: 20180419
    acquBankCd: BMRI
    acquBankNm: PT Bank Mandiri (Persero)
    instmntType: 2
    instmntMon: 1
    payMethod: 01
    receiptCode:
    cardExpYymm: 2012
    cardNo: 422222******2222
    description:
    resultMsg: SUCCESS
    goodsNm: Test Transaction Nicepay
    preauthToken:
    amt: 10000
    billingNm: Customer Name
    currency: IDR

    Pembayaran Kartu Kredit akan bisa di proses jika CC Registration adalah Sukses

       
    API url /nicepay/direct/v2/payment
    Metode POST (Popup, Redirect, Submit, etc) [not server to server API]
    Deskripsi Perform for Transaction Registration
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Silahkan lihat ke sini untuk request JSON Desc and and response parameters
    Mandatory POST parameters

    Parameter Mandatory Tipe Deskripsi
    timeStamp Y N API Request Date
    tXid Y AN Transaction ID
    cardNo Y N Full card number
    cardExpYymm Y N card expiry(YYMM)
    cardCvv Y N card CVV
    cardHolderNm Y (CIMB) AN Card Holder Name
    merchantToken Y AN merchantToken
    callBackUrl Y AN Payment result forward url (on browser)


    Response POST Paramenter (redirect ke callbackUrl)

    Paramenter Tipe Deskripsi
    resultCd N Result code
    resultMsg AN Result Message
    tXid AN Transaction ID (Key from NICEPay)
    referenceNo ANS Merchant order NO. (Key from merchant)
    payMethod N Payment Method
    amt N Payment amount
    transDt N Transaction date (YYYYMMDD)
    transTm N Transaction time (HH24MISS)
    description AN Transaction description
    authNo N Approval number
    issuBankCd A Issue Bank Code. Refer Code at Here
    issuBankNm A Issue Bank Name.
    acquBankCd A Acquire Bank Code. Refer Code at Here
    acquBankNm A Acquire Bank Name.
    cardNo N Card NO. with masking
    cardExpYymm N Card Expiry (YYMM)
    currency AN Currency
    goodsNm AN Goods name
    billingNm A Billing name
    ccTransType AN Credit card transaction type
    instmntType N Installment Type. Refer Code at Here
    instmntMon N Insatllment month

    Virtual Account

    NICEPay menawarkan Virtual Account sebagai metode pembayaran. Dengan menggunakan metode ini, nasabah akan memiliki pilihan untuk melakukan pembayaran melalui ATM, SMS Banking, Internet Banking, atau Mobile Banking. Pemberitahuan Real Time akan dikirim saat pelanggan menyelesaikan pembayaran.
    Bank yang Didukung oleh NICEPay:

    1. Bank Mandiri
    2. Bank International Indonesia Maybank
    3. Bank Permata
    4. Bank Central Asia (BCA)
    5. Bank Negara Indonesia 46 (BNI)
    6. Bank KEB Hana Indonesia
    7. Bank Rakyat Indonesia (BRI)
    8. Bank CIMB Niaga
    9. Bank DANAMON

    NICEPay juga mendukung Virtual Account (VA) untuk bank lain melalui ATM BERSAMA, ALTO, LINK, and PRIMA.

    Integration Step :

    1. Merchant meminta registrasi VA ke NICEPay.
    2. Merchant menampilkan detail VA dan customer journey, kemudian mengirimkan detail VA melalui email / sms / riwayat transaksi nasabah.
    3. Pelanggan membayarkan VA di saluran pembayaran yang diinginkan.
    4. NICEPay kirim notifikasi.
    5. Merchant handle notifikasi.

    Registrasi VA

    Contoh JSON Request

    {
        "timeStamp":"20180123100505",
        "iMid":"IONPAYTEST",
        "payMethod":"02",
        "currency":"IDR",
        "amt":"10000",
        "referenceNo":"ORD12345",
        "goodsNm":"Test Transaction Nicepay",
        "billingNm":"Customer Name",
        "billingPhone":"12345678",
        "billingEmail":"email@merchant.com",
        "billingAddr":"Jalan Bukit Berbunga 22",
        "billingCity":"Jakarta",
        "billingState":"DKI Jakarta",
        "billingPostCd":"12345",
        "billingCountry":"Indonesia",
        "deliveryNm":"email@merchant.com",
        "deliveryPhone":"12345678",
        "deliveryAddr":"Jalan Bukit Berbunga 22",
        "deliveryCity":"Jakarta",
        "deliveryState":"DKI Jakarta",
        "deliveryPostCd":"12345",
        "deliveryCountry":"Indonesia",
        "description":"Transaction Description",
        "dbProcessUrl":"http://ptsv2.com/t/0ftrz-1519971382/post",
        "merchantToken":"f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5",
        "reqDomain":"merchant.com",
        "reqServerIP":"127.0.0.1",
        "userIP":"127.0.0.1",
        "userSessionID":"697D6922C961070967D3BA1BA5699C2C",
        "userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36",
        "userLanguage":"ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4",
        "cartData":"{}",
        "bankCd":"CENA",
        "vacctValidDt":"20180306",
        "vacctValidTm":"091309",
        "merFixAcctId":""
    }
    

    Contoh JSON Response

    {
        "resultCd": "0000",
        "resultMsg": "SUCCESS",
        "tXid": "IONPAYTEST02201804191326086706",
        "referenceNo": "ORD12345",
        "payMethod": "02",
        "amt": "10000",
        "transDt": "20180419",
        "transTm": "132608",
        "description": "Transaction Description",
        "bankCd": "CENA",
        "vacctNo": "1326086706",
        "mitraCd": null,
        "payNo": null,
        "currency": "IDR",
        "goodsNm": "Test Transaction Nicepay",
        "billingNm": "Customer Name",
        "vacctValidDt": "20180306",
        "vacctValidTm": "091309",
        "payValidDt": null,
        "payValidTm": null
    }
    
       
    API url /nicepay/direct/v2/registration
    Metode POST, JSON
    Deskripsi Registrasi Transaksi
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Silahkan lihat ke sini untuk JSON parameters.
    Berikut untuk parameter tambahan yang akan dibutuhkan untuk Registrasi Virtual Account (VA):

    Parameters Mandatory Tipe Value Deskripsi
    PayMethod Y AN 02 Virtual Account (VA)
    bankCd Y A 2 Bank code. refer to here
    vacctValidDt Y N 20180306 VA expiry date (YYYYMMDD)
    vacctValidTm Y N 091309 VA expiry time (HH24MISS)
    merFixAcctld Y (if Fix Type) AN Merchant reserved VA ID


    Response Json Object

    Paramenter Tipe Deskripsi
    resultCd N Result code
    resultMsg AN Result Message
    tXid AN Transactionn ID (Key from NICEPay)
    referenceNo ANS Merchant order N. (Key from merchant)
    payMethod N Payment Method
    amt N Payment amount
    transDt N Transaction date (YYYYMMDD)
    transTm N Transction time (HH24MISS)
    description AN Transaction description
    bankCd A Bank code. refer to here
    vacctNo N VA Number
    currency AN Currency
    goodsNm AN Goods name
    billingNm A Buyer name
    vacctValidDt N VA expiry date (YYYYMMDD)
    vacctValidTm N VA expiry time (HH24MISS)

    Convenience Store

    NICEPay menawarkan Convenience Store (CVS) sebagai metode pembayaran. Pemberitahuan Real Time akan dikirim saat pelanggan menyelesaikan pembayaran.
    CVS yang didukung oleh NICEPay:

    1. Alfamart
    2. Indomaret
    3. Lawson
    4. Alfamidi
    5. Dan+Dan Store

    Proses Integrasi :

    1. Merchant meminta registrasi CVS ke NICEPay.
    2. Merchant menampilkan detail CVS dan customer journey, kemudian mengirimkan detail CVS melalui email / sms / riwayat transaksi nasabah.
    3. Pelanggan membayarkan CVS di saluran pembayaran yang diinginkan.
    4. NICEPay kirim notifikasi.
    5. Merchant handle notifikasi.

    Registrasi CVS

    Contoh JSON Request

    {
        "timeStamp":"20180123100505",
        "iMid":"IONPAYTEST",
        "payMethod":"03",
        "currency":"IDR",
        "amt":"10000",
        "referenceNo":"ORD12345",
        "goodsNm":"Test Transaction Nicepay",
        "billingNm":"Customer Name",
        "billingPhone":"12345678",
        "billingEmail":"email@merchant.com",
        "billingAddr":"Jalan Bukit Berbunga 22",
        "billingCity":"Jakarta",
        "billingState":"DKI Jakarta",
        "billingPostCd":"12345",
        "billingCountry":"Indonesia",
        "deliveryNm":"email@merchant.com",
        "deliveryPhone":"12345678",
        "deliveryAddr":"Jalan Bukit Berbunga 22",
        "deliveryCity":"Jakarta",
        "deliveryState":"DKI Jakarta",
        "deliveryPostCd":"12345",
        "deliveryCountry":"Indonesia",
        "description":"Transaction Description",
        "dbProcessUrl":"http://ptsv2.com/t/0ftrz-1519971382/post",
        "merchantToken":"f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5",
        "reqDomain":"merchant.com",
        "reqServerIP":"127.0.0.1",
        "userIP":"127.0.0.1",
        "userSessionID":"697D6922C961070967D3BA1BA5699C2C",
        "userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36",
        "userLanguage":"ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4",
        "cartData":"{}",
        "mitraCd":"ALMA",
        "payValidDt":"20180308",
        "payValidTm":"095500"
    }
    

    Contoh JSON Response

    {
        "resultCd": "0000",
        "resultMsg": "SUCCESS",
        "tXid": "IONPAYTEST03201804191327346753",
        "referenceNo": "ORD12345",
        "payMethod": "03",
        "amt": "10000",
        "transDt": "20180419",
        "transTm": "132734",
        "description": "Transaction Description",
        "bankCd": null,
        "vacctNo": null,
        "mitraCd": "ALMA",
        "payNo": "191327346753",
        "currency": null,
        "goodsNm": null,
        "billingNm": null,
        "vacctValidDt": null,
        "vacctValidTm": null,
        "payValidDt": null,
        "payValidTm": null
    }
    
       
    API url /nicepay/direct/v2/registration
    Metode POST, JSON
    Deskripsi Registrasi Transaksi
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Please refer to here for JSON parameters.
    Below for extra parameter will be required for Convenience Store (CVS) Registration:

    Parameters Mandatory Tipe Value Deskripsi
    PayMethod Y AN 03 Convenience Store (CVS)
    mitraCd Y A 2 Mitra Code. refer to here
    payValidDt Y N 1 CVS expiry date (YYYYMMDD)
    payValidTm Y N 2 CVS expiry time (HH24MISS)


    Response Json Object

    Paramenter Tipe Deskripsi
    resultCd N Result code
    resultMsg AN Result Message
    tXid AN Transactionn ID (Key from NICEPay)
    referenceNo ANS Merchant order N. (Key from merchant)
    payMethod N Payment Method
    amt N Payment amount
    transDt N Transaction date (YYYYMMDD)
    transTm N Transction time (HH24MISS)
    description AN Transaction description
    mitraCd A Mitra Code. refer to here
    payNo N CVS Payment No.
    payValidDt N VA expiry date (YYYYMMDD)
    payValidTm N VA expiry time (HH24MISS)

    ClickPay

    NICEPay menawarkan ClickPay sebagai metode pembayaran. Pemberitahuan Real Time akan dikirim saat pelanggan menyelesaikan pembayaran.
    ClickPay yang didukung oleh NICEPay:

    1. Mandiri Clickpay
    2. CIMB Clicks
    3. BCA KlikPay

    Proses Integrasi :

    1. Merchant meminta Registrasi ClickPay ke NICEPay.
    2. Merchant meminta Payment ClickPay ke NICEPay.
    3. NICEPay akan redirect ke halaman Bank.
    4. Pelanggan membayarkan ClickPay.
    5. NICEPay kirim notifikasi.
    6. Merchant handle notifikasi.

    ClickPay Registration

    Contoh JSON Request

    {
        "timeStamp":"20180123100505",
        "iMid":"IONPAYTEST",
        "payMethod":"04",
        "currency":"IDR",
        "amt":"10000",
        "referenceNo":"ORD12345",
        "goodsNm":"Test Transaction Nicepay",
        "billingNm":"Customer Name",
        "billingPhone":"12345678",
        "billingEmail":"email@merchant.com",
        "billingAddr":"Jalan Bukit Berbunga 22",
        "billingCity":"Jakarta",
        "billingState":"DKI Jakarta",
        "billingPostCd":"12345",
        "billingCountry":"Indonesia",
        "deliveryNm":"email@merchant.com",
        "deliveryPhone":"12345678",
        "deliveryAddr":"Jalan Bukit Berbunga 22",
        "deliveryCity":"Jakarta",
        "deliveryState":"DKI Jakarta",
        "deliveryPostCd":"12345",
        "deliveryCountry":"Indonesia",
        "dbProcessUrl":"http://ptsv2.com/t/0ftrz-1519971382/post",
        "description":"order description",
        "merchantToken":"f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5",
        "reqDomain":"merchant.com",
        "reqServerIP":"127.0.0.1",
        "userSessionID":"697D6922C961070967D3BA1BA5699C2C",
        "userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36",
        "userLanguage":"ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4",
        "cartData":"{}",
        "mitraCd":"MDRC",
        "userIP":"127.0.0.1"
    }
    
    

    Contoh JSON Response

    {
        "resultCd": "0000",
        "resultMsg": "SUCCESS",
        "tXid": "IONPAYTEST04201804191329266801",
        "referenceNo": "ORD12345",
        "payMethod": "04",
        "amt": "10000",
        "transDt": "20180419",
        "transTm": "132910",
        "description": "order description",
        "bankCd": null,
        "vacctNo": null,
        "mitraCd": null,
        "payNo": null,
        "currency": null,
        "goodsNm": null,
        "billingNm": null,
        "vacctValidDt": null,
        "vacctValidTm": null,
        "payValidDt": null,
        "payValidTm": null
    }
    
       
    API url /nicepay/direct/v2/registration
    Metode POST, JSON
    Description Perform for Transaction Registration
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Silahkan lihat ke sini untuk JSON parameters.
    berikut untuk extra parameter yang akan dibutuhkan untuk Registrasi ClickPay:

    Parameters Mandatory Tipe Value Deskripsi
    PayMethod Y AN 04 ClickPay
    mitraCd Y A Mitra code, refer Code at Here
    mRefNo Y (CIMB) AN ClickPay CIMB reference No


    Response Json Object

    Paramenter Tipe Deskripsi
    resultCd N Result code
    resultMsg AN Result Message
    tXid AN Transactionn ID (Key from NICEPay)
    referenceNo ANS Merchant order N. (Key from merchant)
    payMethod N Payment Method
    amt N Payment amount
    transDt N Transaction date (YYYYMMDD)
    transTm N Transction time (HH24MISS)
    description AN Transaction description

    Pembayaran ClickPay

    Contoh POST Paramenter Request

    callBackUrl=http://merchant.com/callbackUrl&tXid=TESTIMIDTEST01201803020917502088&timeStamp=20180305105635&merchantToken=58161e87726ecf5cdaed5462a994d9bf05172d786c1cbfe0ad03e133c5797645&clickPayNo=1234567890123456&dataField3=123&clickPayToken=123456

    Contoh callbackUrl with parameter

    http://merchant.com/callbackUrl?resultCd=0000&resultMsg=SUCCESS&tXid=TESTIMIDTEST01201803020917502088&referenceNo=ORD12345&payMethod=04&amt=10000&transDt=20180302&transTm=151052&description=Transaction Description&receiptCode=0684G143372548&mitraCd=MDRC&currency=IDR&goodsNm=Test Transaction Nicepay&billingNm=Customer Name&mRefNo=2017514268567

    Pembayaran ClickPay akan bisa di proses jika Registrasi ClickPay adalah Sukses

       
    API url /nicepay/direct/v2/payment
    Metode POST (Popup, Redirect, Submit, etc) [not server to server API]
    Deskripsi Registrasi Transaksi
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Silahkan lihat ke sini untuk POST request and response parameters
    Mandatory POST parameters

    Parameter Mandatory Tipe Deskripsi
    timeStamp Y N API Request Date
    tXid Y AN Transaction ID
    clickPayNo Y N ClickPay number
    dataField3 Y N Token input 3 untuk clickpay
    clickPayToken Y N kode respon dari token
    merchantToken Y AN merchantToken
    callBackUrl Y AN Payment result forward url (on browser)


    Response POST Parameter(redirect ke the callBackUrl)

    Parameter Tipe Deskripsi
    resultCd N result code
    resultMsg AN Result Message
    tXid AN Transaction Id (Key from NICEPay)
    referenceNo ANS Merchant Order No (Key from merchant)
    payMethod N Payment Method
    amt N Payment amount
    currency AN currency
    goodsNm AN Goods Name
    billingNm AN Buyer name
    transDt N Transaction date (YYYYMMDD)
    transTm N Transaction time (HH24MISS)
    description AN Transaction Description
    mitraCd AN Mitra Code, refer Code at Here
    receiptCode ANS Authrization number
    mRefNo AN Bank Reference No

    E-Wallet

    NICEPay menawarkan E-Wallet sebagai metode pembayaran. Pemberitahuan Real Time akan dikirim saat pelanggan menyelesaikan pembayaran.
    E-Wallet yang didukung oleh NICEPay:

    1. Mandiri E-Cash

    Proses Integrasi :

    1. Merchant meminta Registrasi E-Wallet ke NICEPay.
    2. Merchant meminta Payment E-Wallet ke NICEPay.
    3. NICEPay akan redirect ke halaman Bank.
    4. Pelanggan membayarkan E-Wallet.
    5. NICEPay kirim notifikasi.
    6. Merchant handle notifikasi.

    Registrasi E-Wallet

    Contoh JSON Request

    {
        "timeStamp":"20180123100505",
        "iMid":"TESTIDTEST",
        "payMethod":"05",
        "currency":"IDR",
        "amt":"10000",
        "referenceNo":"ORD12345",
        "goodsNm":"Test Transaction Nicepay",
        "billingNm":"Customer Name",
        "billingPhone":"12345678",
        "billingEmail":"email@merchant.com",
        "billingAddr":"Jalan Bukit Berbunga 22",
        "billingCity":"Jakarta",
        "billingState":"DKI Jakarta",
        "billingPostCd":"12345",
        "billingCountry":"Indonesia",
        "deliveryNm":"email@merchant.com",
        "deliveryPhone":"12345678",
        "deliveryAddr":"Jalan Bukit Berbunga 22",
        "deliveryCity":"Jakarta",
        "deliveryState":"DKI Jakarta",
        "deliveryPostCd":"12345",
        "deliveryCountry":"Indonesia",
        "dbProcessUrl":"http://ptsv2.com/t/0ftrz-1519971382/post",
        "merchantToken":"f9d30f6c972e2b5718751bd087b178534673a91bbac845f8a24e60e8e4abbbc5",
        "reqDomain":"merchant.com",
        "reqServerIP":"127.0.0.1",
        "userSessionID":"697D6922C961070967D3BA1BA5699C2C",
        "userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36",
        "userLanguage":"ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4",
        "cartData":"{}",
        "mitraCd":"MDRE",
        "userIP":"127.0.0.1"
    }
    

    Contoh JSON Response

    {
        "resultCd": "0000",
        "resultMsg": "SUCCESS",
        "tXid": "TESTIDTEST05201803051150375209",
        "referenceNo": "ORD12345",
        "payMethod": "05",
        "amt": "10000",
        "transDt": "20180305",
        "transTm": "115011",
        "description": ""
    }
    
       
    API url /nicepay/direct/v2/registration
    Metode POST, JSON
    Deskripsi Registrasi Transaksi
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Please refer to here for JSON parameters.
    Below for extra parameter will be required for Credit Card Registration:

    Parameters Mandatory Tipe Value Deskripsi
    PayMethod Y AN 05 E-Wallet
    mitraCd Y A Mitra code, refer Code at Here


    Response Json Object

    Paramenter Tipe Deskripsi
    resultCd N Result code
    resultMsg AN Result Message
    tXid AN Transactionn ID (Key from NICEPay)
    referenceNo ANS Merchant order N. (Key from merchant)
    payMethod N Payment Method
    amt N Payment amount
    transDt N Transaction date (YYYYMMDD)
    transTm N Transction time (HH24MISS)
    description AN Transaction description

    E-Wallet Payment

    Contoh POST Paramenter Request

    callBackUrl=http://merchant.com/callbackUrl&tXid=TESTIDTEST04201803051057003960&timeStamp=20180305105635&merchantToken=58161e87726ecf5cdaed5462a994d9bf05172d786c1cbfe0ad03e133c5797645

    Contoh callbackUrl with parameter

    http://merchant.com/callbackUrl?resultCd=0000&resultMsg=SUCCESS&tXid=TESTIMIDTEST01201803020917502088&referenceNo=ORD12345&payMethod=04&amt=10000&transDt=20180302&transTm=151052&description=Transaction Description&mitraCd=MDRE&currency=IDR&goodsNm=Test Transaction Nicepay&billingNm=Customer Name

    Pembayaran E-Wallet akan bisa di proses jika Registrasi E-Wallet adalah Sukses

       
    API url /nicepay/direct/v2/payment
    Metode POST (Popup, Redirect, Submit, etc) [not server to server API]
    Deskripsi Registrasi Transaksi
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + merchantKey)


    Silahkan lihat ke sini untuk POST request and response parameters
    Mandatory POST parameters

    Parameter Mandatory Tipe Deskripsi
    timeStamp Y N API Request Date
    tXid Y AN Transaction ID
    merchantToken Y AN merchantToken
    callBackUrl Y AN Payment result forward url (on browser)


    Response POST Parameter(redirect to the callBackUrl)

    Parameter Tipe Deskripsi
    resultCd N result code
    resultMsg AN Result Message
    tXid AN Transaction Id (Key from NICEPay)
    referenceNo ANS Merchant Order No (Key from merchant)
    payMethod N Payment Method
    amt N Payment amount
    currency AN currency
    goodsNm AN Goods Name
    billingNm AN Buyer name
    transDt N Transaction date (YYYYMMDD)
    transTm N Transaction time (HH24MISS)
    description AN Transaction Description
    mitraCd AN Mitra Code, refer Code at Here

    Notification

    Contoh POST for Notification

    tXid={tXid}  
    referenceNo={referenceNo}  
    amt={amt}  
    merchantToken={merchantToken}  
    matchCl={matchCl}
    status={status}
    bankCd={bankCd}
    vacctNo={vacctNo}
    authNo={authNo}
    cardNo={cardNo}
    issuBankCd = {issuBankCd}
    issuBankNm = {issuBankNm}
    acquBankCd = {acquBankCd}
    acquBankNm = {acquBankNm}
    depositDt = {depositDt}
    depositTm = {depositTm}
    payNo={payNo}
    mitraCd={mitraCd}
    

    Server NICEPay akan mengirimkan pemberitahuan ke sisi Merchant dbProcessUrl untuk menginformasikan kepada Merchant mengenai Transaksi.

       
    notification url https://example.com/notificationUrl
    Metode POST
    Deskripsi Pemberitahuan hasil transaksi (bila berhasil).
    Jika sistem Anda menggunakan firewall, mohon tambahkan allow policy untuk IP NICEpay. :
    development: 103.20.51.39
    production: 103.20.51.34
    Merchant Token SHA256 (Merchant ID + Transaction ID + Amount + Merchant Key)

    Parameter untuk Notifikasi

    Parameter Tipe Deskripsi
    tXid N Transaction ID
    merchantToken AN Merchant Token
    referenceNo N Merchant Order No
    payMethod N Payment method. Refer Code at Here
    amt N Payment amount
    transDt N Transaction date
    transTm N Transaction time
    currency N Currency
    goodsNm N Goods name
    billingNm N Billing name
    matchCl N Payment amount match flag. Refer Code at Here
    status AN Deposit Status
    0: Deposit
    1: Reversal

    Parameter Tambahan untuk notifikasi Credit Card

    Parameter Tipe Deskripsi
    authNo N Approval number
    IssueBankCd A Issue bank code. Refer Code at Here
    IssueBankNm A Issue bank name.
    acquBankCd A Acquire bank code. Refer Code at Here
    acquBankNm A Acquire bank name.
    cardNo AN Card no with masking
    caadExpYymm N Card expiry (YYMM)
    InstmntMon N Installment month
    instmntType N Installment Type. Refer Code at Here
    preauthToken AN Preauth Token
    recurringToken AN Recurring token
    ccTransType AN Credit card transaction type
    1: Normal
    2: Recurring
    3: Pre-auth
    4: Captured
    vat N Vat number
    fee N service fee
    notaxAmt N tax free amount

    Parameter Tambahan untuk notifikasi Virtual Account

    Parameter Tipe Deskripsi
    bankCd N Bank Code. Refer Code at Here
    vacctNo N Bank Virtual Account number
    vacctValidDt N VA expiry date
    vacctValidTm N VA expiry time
    depositDt N Deposit date
    depositTm N Deposit time

    Parameter Tambahan untuk notifikasi metode pembayaran lainnya

    Parameter Tipe Deskripsi
    mitraCd A Mitra Code. Refer Code at Here
    payNo N Pay number to mitra
    payValidDt N CVS expiry date
    payValidTm N CVS expiry time
    receiptCode ANS Authorization number
    mRefNo AN Bank reference No
    depositDt N Deposit date
    depositTm N Deposit time

    Order Status (Inquiry)

    Contoh JSON Request

    {
        "timeStamp":"20180305115011",
        "tXid":"TESTIDTEST05201803051150375209",
        "iMid":"TESTIDTEST",
        "referenceNo":"ORD12345",
        "amt":"10000",
        "merchantToken":"a1b747ad8ce72461de6194e1fff3ef5b5022b957d9003d14b52f4d52b5b55fe8"
    }
    

    Contoh JSON Response

    {
        "tXid": "TESTIDTEST05201803051150375209",
        "iMid": "TESTIDTEST",
        "currency": "IDR",
        "amt": "10000",
        "instmntMon": null,
        "instmntType": "1",
        "referenceNo": "ORD12345",
        "goodsNm": "Test Transaction Nicepay",
        "payMethod": "05",
        "billingNm": "Customer Name",
        "reqDt": "20180305",
        "reqTm": "115037",
        "status": "9",
        "resultCd": "0000",
        "resultMsg": "init",
        "cardNo": null,
        "preauthToken": null,
        "acquBankCd": null,
        "issuBankCd": null,
        "vacctValidDt": null,
        "vacctValidTm": null,
        "vacctNo": null,
        "bankCd": null,
        "payNo": null,
        "mitraCd": null,
        "receiptCode": null,
        "cancelAmt": null,
        "transDt": null,
        "transTm": null,
        "recurringToken": null,
        "ccTransType": null,
        "payValidDt": null,
        "payValidTm": null,
        "mRefNo": null,
        "acquStatus": null,
        "cardExpYymm": null,
        "acquBankNm": null,
        "issuBankNm": null,
        "depositDt": null,
        "depositTm": null
    }
    

    API ini untuk permintaan untuk memeriksa status transaksi. Merchant dapat memeriksa status pesanan menggunakan API inquiry. Saat pedagang menerima pemberitahuan, NICEPay sangat menyarankan agar Merchant memeriksa ulang transaksi menggunakan Inquiry API.

       
    API url /nicepay/direct/v2/inquiry
    Metode POST, JSON
    Deskripsi Permintaan Status Transaksi
    Merchant Token SHA256 (timeStamp + iMid + referenceNo + amt + Merchant Key)


    Request JSON Object

    Parameter Mandatory Tipe Deskripsi
    timeStamp Y N API Request Date
    tXid Y AN Transaction Id
    iMid Y AN Merchant Id
    referenceNo Y ANS Merchant Order No
    amt Y N Transaction Amount
    merchantToken Y AN merchantToken


    Response JSON Object

    Parameter Tipe Deskripsi
    resultCd N Result Code
    resultMsg AN Result Message
    tXid AN Transaction Id(Key from NICEPay)
    iMid AN Merchant Id
    referenceNo ANS Merchant Order No(Key from merchant)
    payMethod N Payment Method
    amt N Payment amount
    cancelAmt N Cancel amount
    reqDt N Transaction request date(YYYYMMDD)
    reqTm N Transaction request time(HH24MISS)
    transDt N Transaction date(YYYYMMDD)
    transTm N Transaction time(HH24MISS)
    depositDt N Transaction deposit date(YYYYMMDD)
    depositTm N Transaction deposit time(HH24MISS)
    currency AN currency
    goodsNm AN Goods Name
    billingNm AN Buyer name
    status N Transaction status, refer Code at Here


    Additional Credit Card Response Json Object

    Parameter Type Description
    authNo N
    issuBankCd A Issue Bank Code, refer Code at Here
    acquBankCd A Acquire Bank Code, refer Code at Here
    cardNo AN Card No with masking
    cardExpYymm N card expiry(YYMM)
    instmntMon N Installment month
    instmntType N Installment Type, refer Code at Here
    preauthToken AN Pre-Auth Token (need for capture)
    recurringToken AN Recurring Token (Can use next payment)
    ccTransType AN Credit Card Transaction Type
    acquStatus AN Purchase Status
    1: Normal
    2: Recurring
    3: Pre-auth
    4: Capture
    vat N Vat
    fee N service fee
    notaxAmt N tax free amount


    Additional Virtual Account Response Json Object

    Parameter Type Description
    bankCd AN Bank Code, refer Code at Here
    vacctNo N Bank Virtual Account number
    vacctValidDt N VA expiry date (YYYYMMDD)
    vacctValidTm N VA expiry time (HH24MISS)


    Additional Others Response Json Object

    Parameter Type Description
    mitraCd A Mitra code, refer Code at Here
    (CVS, ClickPay, E-Wallet)
    payNo N CVS number (CVS)
    payValidDt N CVS expiry date (YYYYMMDD) (CVS)
    payValidTm N CVS expiry time (HH24MISS) (CVS)
    mRefNo AN Bank reference No (CVS)
    receiptCode ANS Authorization code (CVS)

    Cancel

    Contoh JSON request

    {
        "timeStamp":"20180305115011",
        "tXid":"TESTIDTEST01201803051530400331",
        "iMid":"TESTIDTEST",
        "payMethod":"01",
        "cancelType":"1",
        "cancelMsg":"Request Cancel",
        "merchantToken":"306a14c6b6effbe9979ec13dfd6cfe17ddfee2eabe7a7d8bbe55630e27e9e86e",
        "preauthToken":"",
        "amt":"10000",
        "cancelServerIp":"127.0.0.1",
        "cancelUserId":"admin",
        "cancelUserIp":"127.0.0.1",
        "cancelUserInfo":"Customer Cancel Transaction",
        "cancelRetryCnt":"",
        "worker":""
    }
    

    Contoh JSON Response

    {
        "tXid": "TESTIDTEST01201803051530400331",
        "referenceNo": "ORD12345",
        "resultCd": "0000",
        "resultMsg": "SUCCESS",
        "transDt": "20180305",
        "transTm": "153040",
        "description": "Order Description",
        "amt": "10000"
    }
    

    This API is for request to cancel of transaction.
    type of transaction can be requested :

    Code Deskripsi
    01 Credit Card
    02 Virtual Account
    03 CVS (Convenience Store)
       
    API url /nicepay/direct/v2/cancel
    Metode POST, JSON
    Description Perform cancel API for Credit Card, Virtual Account, and CVS
    Merchant Token SHA256 (timeStamp + iMid + tXid + amt + Merchant Key)


    Request Json Object

    Parameter Mandatory Tipe Deskripsi
    timeStamp Y N API Request Date
    tXid Y AN Transaction Id
    iMid Y AN Merchant Id
    payMethod Y N Payment Method
    cancelType Y N Cancel Type
    cancelMsg N AN Cancel Message
    merchantToken Y AN merchantToken
    preauthToken Y AN PreauthToken
    amt Y N Payment amount
    fee N N Fee
    vat N N Vat
    notaxAmt N N No tax Amount
    cancelServerIp N AN Server IP
    cancelUserId N AN User ID
    cancelUserIp N AN User IP
    cancelUserInfo N AN User Information
    cancelRetryCnt N N Retry Count
    worker N AN Worker


    Response Json Object

    Parameter Tipe Deskripsi Remark
    resultCd N Result Code
    resultMsg AN Result Message
    tXid AN Transaction ID When Success
    referenceNo ANS Merchant Order No When Success
    transDt N Transaction Date When Success
    transTm N Transaction Time When Success
    description AN Deskripsi When Success
    amt N Amount When Success
    canceltXid AN Cancel transaction ID When Success

    Nicepay Code

    Field Type

    Value Code Meaning
    A Alphabet
    AN Alphabet Numeric
    N Numeric
    ANS Alphabet Numeric Symbol
    AOO Array of Object

    Installment Type

    Value Code Meaning
    1 Customer charge
    2 Merchant charge

    Payment Method

    Value Code Meaning
    01 Credit Card
    02 Virtual Account
    03 CVS (Convenience Store)
    04 ClickPay
    05 E-Wallet

    Payment Status Code

    Value Code Meaning
    Credit Card  
    0 Success
    1 Failed
    2 Void/Refund
    9 Initialization / Reversal
    Virtual Account  
    0 Paid
    3 Unpaid
    4 Expired
    CVS  
    0 Paid
    3 Unpaid
    4 Expired
    5 Ready to Paid (for Alfamart)

    Notification Status Code

    Value Code Meaning
    0 Deposit
    1 Reversal

    Notification Match Amount Indicator

    Value Code Meaning
    1 Match
    2 Over
    3 Under

    Cancel Type

    Value Code Meaning
    1 Full Cancellation
    2 Partial Cancellation

    Bank Code

    Value Code Meaning
    BMRI Bank Mandiri
    IBBK Bank International Indonesia Maybank
    BBBA Bank Permata
    CENA Bank Central Asia
    BNIN Bank Negara Indonesia 46
    HNBN Bank KEB Hana Indonesia
    BRIN Bank Rakyat Indonesia
    BNIA Bank PT. BANK CIMB NIAGA, TBK.
    BDIN Bank PT. BANK DANAMON INDONESIA, TBK
    OTHR etc, unknown

    Mitra Code

    Value Code Meaning
    ALMA CVS Alfamart
    INDO CVS Indomaret
    MDRC ClickPay Mandiri
    BCAC ClickPay BCA
    CIMC ClickPay CIMB
    MDRE E-Wallet Mandiri
    BCAE E-Wallet BCA(Sakuku)

    Error Code

    Value Description
      Common
    0000 Success
    1001 Connection error
    1002 Socket error
    1003 Server error
    1004 Timeout error
    9501 Invalid transaction number.
    9502 Transaction not allowed.
    9503 It has been stopped or terminated in its stores.
    9504 No offus information.
    9505 No bank information.
    9506 No Merchant Paymethod information.
    9507 Http timeout exception.
      Order
    8001 Order registration error.
    8002 Order inquiry error.
    8003 Order registration data error.
    8004 The tXid error during the order inquiry.
    8005 OrderAuthType API Response data null.
    9001 Failed to register your order. Please check your HTTP Message.
    9002 Server is busy. Please kindly try again in few minutes.
    9003 Invalid Order.
    9004 Error on inquiry of order confirmation.
    9005 Failed to check status. Please contact NICEPay for further information.
    9006 Transaction number generated error.
    9007 Undefined: Amount. Please check your request parameter and make sure [amt] is defined.
    9008 Invalid Request Amount. Amount should only number and do not includes decimal.
    9009 Reference Number already exist. Please generate unique [referenceNo].
    9010 Invalid Merchant Token. Contact NICEPay for further information.
    9011 Invalid MID, Merchant is not registered. Contact NICEPay for further information.
    9012 This Payment method is currently not activated. Contact Nicepay for further information.
    9013 Undefined: Currency Code. Please check your request parameter and make sure [currencyCode] is defined.
    9014 Undefined: Reference No. Please check your request parameter and make sure [referenceNo] is defined.
    9015 Undefined: Goods Name. Please check your request parameter and make sure [goodsNm] is defined.
    9016 Undefined: Buyer Name. Please check your request parameter and make sure [billingNm] is defined.
    9017 Undefined: Buyer Phone Number. Please check your request parameter and make sure [billingPhone] is defined.
    9018 Undefined: Buyer Email Address. Please check your request parameter and make sure [billingEmail] is defined.
    9019 Undefined: Callback URL. Please check your request parameter and make sure [callbackUrl] is defined.
    9020 Undefined: Debit Process URL. Please check your request parameter and make sure [dbProcessUrl] is defined.
    9021 Failed in inquiring the criterion information (BO_MER_MGNT ORD_NO_DUP_CHK_FLG).
    9022 Invalid Card Data. Please check [cartData] parameter, and make sure you send valid JSON format.
    9023 Invalid Cart Data. Amount is different with Cart Data total amount. Please make sure [amt] = sum of [amt] in [cartData]
    9024 Undefined: Customer IP Address. Please check your request parameter and make sure [userIP] is defined.
    9025 Undefined: Buyer City. Please check your request parameter and make sure [billingCity] is defined.
    9026 Undefined: Buyer State. Please check your request parameter and make sure [billingState] is defined.
    9027 Undefined: Buyer Postal Code. Please check your request parameter and make sure [billingPostCd] is defined.
    9028 Undefined: Buyer Country. Please check your request parameter and make sure [billingCountry] is defined.
    9029 Installment is not available for defined month
    9030 Transaction Fail. Please check information.
    9031 Date/Time check.
      Card
    8021 Card authorization error.
    8022 The tXid error during the card authorization.
    8023 The tXid error during the card net cancel.
    8024 The MID error during the card net cancel.
    8026 Failed card VISA 3D.
    8027 Invalid Parameter (PAN or expiry or country_code)
    8028 Invalid Parameter (callbackUrl)
    8029 Invalid Parameter (onePassToken)
    8030 Not Support Keyin Payment.
    9101 Server is busy. Please kindly try again in few minutes.
    9102 Server is busy. Please kindly try again in few minutes.
    9103 Error in inquiring card ledger.
    9104 Server is busy. Please kindly try again in few minutes.
    9105 Server is busy. Please kindly try again in few minutes.
    9106 Transaction failed.
    9107 Server is busy. Please kindly try again in few minutes.
    9108 This Payment method is currently not activated. Contact Nicepay for further information.
    9109 Reference Number Maximum Length Exceed. [referenceNo] should have maximum 40 characters length.
    9110 Transaction failed. Please check card information and try again.
    9111 Transaction failed. Please check card information and try again.
    9112 Transaction failed. Please check card information and try again.
    9113 Transaction failed. Please check card information and try again.
    9114 MERCHANT_CARDINFO query error.
    9115 Invalid Amount: too low. Please increase amount.
    9116 Transaction already exist. Please make new transaction.
    9117 3D Secure Failed. Please kindly check your card data and try again.
    9118 Invalid Installment Type.
    9119 Transaction failed: Invalid Terminal ID or Merchant ID
    9120 Transaction failed: Invalid Terminal ID or Merchant ID
    9121 This Payment method is currently not activated. Contact Nicepay for further information.
    9122 Transaction failed. Please check settlement interval.
    9123 Transaction failed. Transaction limit reached.
    9124 Invalid Amount: too low. Please increase amount.
    9125 Transaction failed. Please check card information and try again.
    9126 Transaction already approved.
    9127 Transaction already exist. Please make new transaction.
    9128 Transaction failed. Please check card information and try again.
    9129 Transaction failed: Expired transaction. Please make new transaction.
    9130 Forbidden. You do not have permission to access this resource.
    9131 Invalid Token. Please check [onePassToken] parameter
    9132 Transaction failed. Please check Risk Management.
    9133 Email not sent.
    9134 Card Recurring Token Failed.
    9135 Card Recurring Auto Void Failed.
    9136 Card Recurring Token Unregistraion Failed.
    9137 Card MIGS Transaction Number not found. (queryDR, vpc_DRExists : N)
    9138 Card MIGS SecureHash not match.
    9139 Card MIGS Amount not match.
    9140 Recurring Payment Parameter CVV code is mandatary.
    9141 Recurring Payment AuthType is '1' or '2'.
    9142 Cards issued overseas can not be paymented.
    9143 Card PreAuth Token Failed.
    9144 Card PreAuth Token Unregistraion Failed.
    9145 capture amount must be less than pre-authorised amount.
    9146 Failed to card token inquiry
    9147 Invalid parameters.
    9148 Recurring Token is only available for 3DS.
    9149 Recurring Payment Use Check : Fail.
    9150 Recurring Payment CVV Check : Fail.
    9151 cardBin Information exist in blackList.
    9152 FDS Check : high risk score.
    9153 FDS Check : binCountry is not local card.
    9154 card daily transaction limit count over.
    9155 card daily transaction limit amount over.
    9156 FDS Check : server communication error.
    9157 There is no valid authentication data. Please make new transaction.
    9158 Card Holder Name is Mandatory.
    9159 Transaction failed. please contact merchant.
    9160 Invalid expired date format YYMM
    9161 Token not found
    9162 FDS Check : binCountry is not permit to payment.
    00 Successful approval/completion or that V.I.P. PIN verification is valid
    01 Refer to card issuer
    02 Refer to card issuer, special condition
    03 Invalid merchant or service provider
    04 Pickup card
    05 Do not honor
    06 General Error
    07 Pickup card, special condition (other than lost/stolen card)
    08 Honor with identification
    09 Request in progress
    10 Partial Approval
    11 V.I.P. approval
    12 Invalid transaction
    13 Invalid amount (currency conversion field overflow) or amount exceeds maximum for card program
    14 Invalid account number (no such number)
    15 No such issuer
    16 Insufficient funds
    17 Customer cancellation
    19 Re-enter transaction
    20 Invalid response
    21 No action taken (unable to back out prior transaction)
    22 Suspected Malfunction
    25 Unable to locate record in file, or account number is missing from the inquiry
    28 File is temporarily unavailable
    30 Format Error
    41 Pickup card (lost card)
    43 Pickup card (stolen card)
    51 Insufficient funds
    52 No checking account
    53 No savings account
    54 Expired card
    55 Incorrect PIN
    57 Transaction not permitted to cardholder
    58 Transaction not allowed at terminal
    59 Suspected fraud
    61 Activity amount limit exceeded
    62 Restricted card (for example, in Country Exclusion table)
    63 Security violation
    65 Activity count limit exceeded
    68 Response received too late
    75 Allowable number of PIN - entry tries exceeded
    76 Unable to locate previous message (no match on Retrieval Reference number)
    77 Previous message located for a repeat or reversal, but repeat or reversal data are inconsistent with original message
    78 ’Blocked, first used’ - The transaction is from a new cardholder, and the card has not been properly unblocked.
    80 Visa transactions: credit issuer unavailable. Private label and check acceptance: Invalid date
    81 PIN cryptographic error found (error found by VIC security module during PIN decryption)
    82 Negative CAM, dCVV, iCVV, or CVV results
    83 Unable to verify PIN
    85 No reason to decline a request for account number verification, address verification, CVV2 verification, or a credit voucher or merchandise return
    91 Issuer unavailable or switch inoperative (STIP not applicable or available for this transaction)
    92 Destination cannot be found for routing
    93 Transaction cannot be completed, violation of law
    94 Duplicate Transmission
    95 Reconcile error
    96 System malfunction, System malfunction or certain field error conditions
    B1 Surcharge amount not permitted on Visa cards (U.S. acquirers only)
    N0 Force STIP
    N3 Cash service not available
    N4 Cashback request exceeds issuer limit
    N7 Decline for CVV2 failure
    P2 Invalid biller information
    P5 PIN Change/Unblock request declined
    P6 Unsafe PIN
    Q1 Card Authentication failed
    R0 Stop Payment Order
    R1 Revocation of Authorization Order
    R3 Revocation of All Authorizations Order
    XA Forward to issuer
    XD Forward to issuer
    Z3 Unable to go online
    C101 Error setting mandatory fields, TRANSACTION_TYPE is empty!
    C102 Invalid value for TRANSACTION_TYPE! Acceptable Value : QUERY=1, SALES=2, AUTHORIZED=3, CAPTURE=4
    C103 This transaction is not authorized, cannot proceed to be captured.
    C104 Error setting mandatory fields, MERCHANT_ACC_NO is empty!
    C105 Invalid MERCHANT_ACC_NO! Unable to find merchant with provided MERCHANT_ACC_NO.
    C106 The status of this MERCHANT_ACC_NO is suspended! All transactions are not allowed temporary. Please check with administrator for the status.
    C107 The status of this MERCHANT_ACC_NO is still pending and not yet activated. Please check with administrator for the status.
    C108 The status of this MERCHANT_ACC_NO is invalid! Please check the merchant setting.
    C109 The setting of this MERCHANT_ACC_NO does not allow the requested transaction type. Please check the merchant setting.
    C110 The setting of this MERCHANT_ACC_NO do not allow transaction request from this IP address. Please checks the merchant allow IP setting.
    C111 Error setting mandatory fields, AMOUNT is empty!
    C112 Invalid value for AMOUNT
    C113 Error setting mandatory fields, CARD_NO is empty!
    C114 Error setting mandatory fields, CARD_EXP_MM is empty!
    C115 Error setting mandatory fields, CARD_EXP_YY is empty!
    C116 Error setting mandatory fields, CARD_CVC is empty!
    C117 Invalid value for CARD_NO. CARD_NO must be numeric and with valid length!
    C118 Invalid value for CARD_EXP_MM. CARD_EXP_MM must be numeric and with valid length!
    C119 Invalid value for CARD_EXP_YY. CARD_EXP_YY must be numeric and with valid length!
    C120 Invalid value for CARD_CVC. CARD_CVC must be numeric and with valid length!
    C121 Invalid payment method. Please call bank to check Merchant Settings.
    C122 Amount has been over transaction limit for today. Please call bank to check Merchant Settings.
    C123 Transaction not permitted through this merchant type. Please call bank to check Merchant Settings.
    C124 Undefined Error. Error Code:1024
    C301 Error setting mandatory fields, TRANSACTION_ID is empty! TRANSACTION_ID is required for CAPTURE transaction type
    C302 Error setting mandatory fields, RETURN_URL is empty!
    C303 Error setting mandatory fields, RESPONSE_TYPE is empty!
    C304 Error setting mandatory fields, TXN_URL is Null for RESPONSE_TYPE using HTTP!
    C305 Invalid value for RESPONSE_TYPE for non-3D transaction! Acceptable Value : HTTP, XML, PLAIN
    C306 Error setting mandatory fields, TXN_SIGNATURE is empty!
    C307 Invalid value for TXN_SIGNATURE! Computed signature does not match one included in the request.
    C308 Invalid format for TXN_SIGNATURE! TXN_SIGNATURE must be length of 32, and in hexadecimal format.
    C309 Unable to find the transaction record!
    C310 MERCHANT_ACC_NO not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the MERCHANT_ACC_NO is the same MERCHANT_ACC_NO submitted during previous transaction.
    C311 AMOUNT not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the AMOUNT is the same AMOUNT submitted during previous transaction.
    C312 CUSTOMER_ID not matched with previous submitted transaction request! To capture/query previous transaction, if this field is being used, please ensure the CUSTOMER_ID is the same CUSTOMER_ID submitted during previous transaction.
    C313 MERCHANT_TRANID not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the MERCHANT_TRANID is the same MERCHANT_TRANID submitted during previous transaction.
    C314 Insecure mode for RETURN_URL. Please specify an URL which uses HTTPS protocol!
    C315 Insecure mode for TXN_URL. Please specify an URL which uses HTTPS protocol!
    C401 Error setting mandatory fields, CARD_HOLDER_NAME is empty!
    C402 Error setting mandatory fields, MERCHANT_TRANID is empty!
    C403 Duplicate MERCHANT_TRANID detected! Please ensure the MERCHANT_TRANID is always unique.
    C404 Error setting mandatory fields, TXN_DESC is empty!
    C405 Error setting mandatory fields for 3D transaction, MPI_CODE is empty!
    C406 Error setting mandatory fields for 3D transaction, MPI_CAVV is empty!
    C407 Error setting mandatory fields for 3D transaction, MPI_CAVV_ALG is empty!
    C408 Error setting mandatory fields for 3D transaction, MPI_ECI is empty!
    C409 Error setting mandatory fields for 3D transaction, MPI_MSG is empty!
    C501 Error setting mandatory fields for fraud risk detection, FR_HIGHRISK_EMAIL is empty!
    C502 Error setting mandatory fields for fraud risk detection, FR_HIGHRISK_COUNTRY is empty!
    C503 Error setting mandatory fields for fraud risk detection, FR_BILLING_ADDRESS is empty!
    C504 Error setting mandatory fields for fraud risk detection, FR_SHIPPING_ADDRESS is empty!
    C505 Error setting mandatory fields for fraud risk detection, FR_SHIPPING_COST is empty!
    C506 Error setting mandatory fields for fraud risk detection, CUSTOMER_IP is empty!
    C507 Error setting mandatory fields for fraud risk detection, FR_PURCHASE_HOUR is empty!
    C508 Transaction was blocked due to fraud level exceeded threshold limit.
    C509 Transaction was blocked due to blacklisted card detected.
    C601 Unable to get connection to MPI Server!
    C602 Time out occurred during communication with MPI Server!
    C603 Unable to update MPI Ref. No in system. Please try again.
    C604 There was an error occurred during 3D authentication with MPI. Please check logs for details.
    C605 Invalid message or response received from MPI. Please try again.
    C606 MPI Settings are not configured correctly. Please check MPI_HOST and MPI_PORT in system configuration.
    C607 Error occurred when trying to display ACS Form in web browser for 3D authentication. Please try again.
    C608 Problem occurred on MPI side, cannot proceed to display ACS Form. Please check MPI message or try again.
    C609 Unable to locate back transaction to update system after 3-D authentication process. Please try again.
    C610 Empty response received from MPI, please try again.
    C611 MPI Code received is not allowed to proceed to process the transaction.
    C612 Transaction was aborted because 3-D authentication process is not completed.
    C613 Attempted duplicate submission of 3-D authentication result. Please try with new transaction.
    C614 MALL NAME is required for 3-D transaction. Please call bank to check Merchant Settings.
    C615 MALL URL is required for 3-D transaction. Please call bank to check Merchant Settings.
    C616 Invalid value for RESPONSE_TYPE for 3D transaction! Acceptable Value : HTTP only
    C801 This MERCHANT_ACC_NO is not authorized to proceed with this transaction via website! Please check the merchant setting.
    C802 This MERCHANT_ACC_NO is not authorized to proceed with this transaction via batch upload! Please check the merchant setting.
    C803 Exception while query Payment Server!
    C804 Exception while checking for fraud risk!
    C999 Internal Exception. Please call bank to report.
    C988 Server Time Out Exception.
    C977 Bank Connection Error!
    C966 Reply from bank is empty/incorrect!
    C967 Bank rejected transaction!
    C955 Error when trying to insert transaction table. Transaction ID is empty!
    C933 Server interruption occurred during processing. Manual checking required. Please inform Administrator.
    C935 Cancel payment by customer.
    C937 Insufficient point to redeem in cardholder's account. Please enter another card number.
    1 Transaction could not be processed
    2 Transaction Declined - Contact Issuing Bank
    3 Transaction Declined- No reply from Bank
    4 Transaction Declined - Expired Card
    5 Transaction Declined - Insufficient credit
    6 Transaction Declined - Bank system error
    7 Payment Server Processing Error - Typically caused by invalid input data such as an invalid credit card number. Processing errors can also occur. (This is only relevant for Payment Servers that enforce the uniqueness of this field) Processing errors can also occur.
    8 Transaction Declined - Transaction Type Not Supported
    9 Bank Declined Transaction (Do not contact Bank)
    A Transaction Aborted
    B Transaction Blocked - Returned
    C Transaction Cancelled
    D Deferred Transaction
    E Transaction Declined - Refer to card issuer
    F 3D Secure Authentication Failed
    I Card Security Code Failed
    L Shopping Transaction Locked (This indicates that there is another transaction taking place using the same shopping transaction number)
    N Cardholder is not enrolled in 3D Secure (Authentication Only)
    P Transaction is Pending
    R Retry Limits Exceeded, Transaction Not Processed
    T Address Verification Failed
    U Card Security Code Failed
    V Address Verification and Card Security Code Failed
      Virtual Account
    8041 Virtual account registration error.
    8042 The tXid error during the vertual account registration.
    8045 requestVacctCustomerInquiryAPI is null.
    9201 Server is busy. Please kindly try again in few minutes.
    9202 Server is busy. Please kindly try again in few minutes.
    9203 Failed to generate virtual account. Pool is empty or reached maximum.
    9204 Server is busy. Please kindly try again in few minutes.
    9205 Failed to generate virtual account. Invalid Virtual Account.
    9206 Server is busy. Please kindly try again in few minutes.
    9207 Reference Number Maximum Length Exceed. [referenceNo] should have maximum 40 characters length.
    9208 Error in non-usage of criterion information.
    9209 the payment amount is too small.
    9210 Error in expiration date of deposit, expiration time for deposit, and inclusion of letters.
    9211 Expiration date and time for deposit length is not valid.
    9212 Error of check for merchant ID, payment method.
    9213 TB_TRANS_HISTORY registration error.
    9214 Failed in inquiring settlement interval.
    9215 Order number redundancy check (TB_MOID_VERIFY) updates error.
    9216 Virtual account failure ledger (TB_VACCT_FAIL) registration error.
    9217 Order number redundancy check (TB_MOID_VERIFY) delete error.
    9218 Virtual account ledger inquiry failure.
    9219 Server is busy. Please kindly try again in few minutes.
    9220 Server is busy. Please kindly try again in few minutes.
    9221 Error in non-usage of criterion information(VACCT_SET).
    9222 Error in non-usage of criterion information(VACCT_CONT).
    9223 Invalid customer id.
    9224 Error of check for customerId.
    9225 Invalid Merchant Token. Contact NICEPay for further information.
    9226 VacctNo is exceeded limit digit.
    9227 DB insert error.
    9228 Transaction not found.
    9229 Fix account accountType error.
    9230 Not exist customerId.
    9231 Data is null error.
    9232 iMid is exist.
    9233 vacctNo is duplicate.
    9234 customerId already exist.
    9235 Invalid customer name.
    9236 Try check date.
    9237 Invalid BankCd.
      Cancel
    8061 Full canceled error.
    8062 Partial cancled error.
    8063 The MID error during the full cancel.
    8064 The tXID error during the full cancel.
    8065 The MID error during the partial cancel.
    8066 The tXID error during the partial cancel.
    8067 The amount error during the partial cancel.
    8090 Net canceled error.
    9301 Invalid Cancel Type.
    9302 Server is busy. Please kindly try again in few minutes.
    9303 Server is busy. Please kindly try again in few minutes.
    9304 TB_TRANS_HISTORY update error.
    9305 Ledger card registration error.
    9306 Ledger partial cancel registration error.
    9307 Cards query error.
    9308 Database connection error.
    9309 Bank connection error.
    9310 TB_TRANS HISTORY registration error.
    9311 Transaction number generated error.
    9312 No cancellation amount or cancellation amount includes the letter.
    9313 Partial cancellation is only possible mandiri.
    9314 Can not cancel your request transaction number.
    9315 Cancel Ledger duplicate registration error.
    9316 Bank code duplication errors.
    9317 Bank Mandiri is available once a partial canceled.
    9318 Virtual account can not request to cancel.
    9319 The amount you entered is larger than the amount you want to cancel.
    9320 Can not cancel the entire data already partially canceled.
    9321 Please fill in the requested amount greater than zero.
    9322 Merchant infomaition(CARD_BIN) query fail.
    9323 Merchant infomaition(Merchant_INFO) query fail.
    9324 MERCHANT_CARDINFO query error.
    9325 B_MID,B_TID query error.
    9326 It can not be canceled after purchase.
    9327 It can not be partial cancelation before purchase.
    9328 The information can not be canceled (Void Risk Check).
    9329 The information can not be partial cancelation (Void Risk Check).
    9330 Virtual account deposit has been completed can not be canceled.
    9331 The merchant can not be canceled.
    9332 The merchant can not be partial cancellation.
    9333 The merchant can not be cancellation. (Debt cancellation prevent restrictions)
    9334 Cancellation period exceeds(limit 90 days).
      One Pass
    8200 One Pass inquiry error.
    8201 OnePass Token Duplicate.
    8202 OnePass Invalid Amount.
      CVS
    9501 Server is busy. Please kindly try again in few minutes.
    9502 Server is busy. Please kindly try again in few minutes.
    9503 Failed to generate CVS Number. Pool is empty or reached maximum.
    9504 Server is busy. Please kindly try again in few minutes.
    9505 Failed to generate virtual account. Invalid CVS.
    9506 Server is busy. Please kindly try again in few minutes.
    9507 Reference Number Maximum Length Exceed. [referenceNo] should have maximum 40 characters length.
    9508 Error in non-usage of criterion information.
    9509 the payment amount is too small.
    9510 Error in expiration date of deposit, expiration time for deposit, and inclusion of letters.
    9511 Expiration date and time for deposit length is not valid.
    9512 Error of check for merchant ID, payment method.
    9513 TB_TRANS_HISTORY registration error.
    9514 Failed in inquiring settlement interval.
    9515 Order number redundancy check (TB_MOID_VERIFY) updates error.
    9516 CVS NUmber failure ledger (TB_CVS_FAIL) registration error.
    9517 Order number redundancy check (TB_MOID_VERIFY) delete error.
    9518 CVS ledger inquiry failure.
    9519 Server is busy. Please kindly try again in few minutes.
    9520 Server is busy. Please kindly try again in few minutes.
    9521 Error in non-usage of criterion information(CVS_SET).
    9522 Error in non-usage of criterion information(MITRA_CONT).
    9523 Invalid customer id.
    9524 Error of check for customerId.
    9525 Invalid Merchant Token. Contact NICEPay for further information.
    9526 CVS Number is exceeded limit digit.
    9527 DB insert error.
    9528 Transaction not found.
    9529 Fix account accountType error.
    9530 Not exist customerId.
    9531 Data is null error.
    9532 iMid is exist.
    9533 CVS Number is duplicate.
    9534 customerId already exist.
    9535 Invalid customer name.
    9536 Try check date.
      EWALLET
    9750 E-Wallet Generate ID Fail.
    9751 Invalid Parameter.
    9752 E-Wallet Payment Fail.
      CLICKPAY
    9801 Internal system error
    9802 Invalid parameter
    9803 User registration error
    9804 Invalid Token
    9805 Invalid Card Number
    9806 Transaction Payment Fail
    9807 Transaction Reversal Fail
    9808 TXID is duplicate
    9809 Failed in inquiring settlement interval
    9810 Other error

    CIMB Error Code

    Value Description
    0 APPROVED OR COMPLETED
    1001 Error setting mandatory fields, TRANSACTION_TYPE is empty!
    1002 Invalid value for TRANSACTION_TYPE! Acceptable Value : QUERY=1, SALES=2, AUTHORIZED=3, CAPTURE=4
    1003 This transaction is not authorized, cannot proceed to be captured.
    1004 Error setting mandatory fields, MERCHANT_ACC_NO is empty!
    1005 Invalid MERCHANT_ACC_NO! Unable to find merchant with provided MERCHANT_ACC_NO.
    1006 The status of this MERCHANT_ACC_NO is suspended! All transactions are not allowed temporary. Please check with administrator for the status.
    1007 The status of this MERCHANT_ACC_NO is still pending and not yet activated. Please check with administrator for the status.
    1008 The status of this MERCHANT_ACC_NO is invalid! Please check the merchant setting.
    1009 The setting of this MERCHANT_ACC_NO does not allow the requested transaction type. Please check the merchant setting.
    1010 The setting of this MERCHANT_ACC_NO do not allow transaction request from this IP address. Please checks the merchant allow IP setting.
    1011 Error setting mandatory fields, AMOUNT is empty!
    1012 Invalid value for AMOUNT
    1013 Error setting mandatory fields, CARD_NO is empty!
    1014 Error setting mandatory fields, CARD_EXP_MM is empty!
    1015 Error setting mandatory fields, CARD_EXP_YY is empty!
    1016 Error setting mandatory fields, CARD_CVC is empty!
    1017 Invalid value for CARD_NO. CARD_NO must be numeric and with valid length!
    1018 Invalid value for CARD_EXP_MM. CARD_EXP_MM must be numeric and with valid length!
    1019 Invalid value for CARD_EXP_YY. CARD_EXP_YY must be numeric and with valid length!
    1020 Invalid value for CARD_CVC. CARD_CVC must be numeric and with valid length!
    1021 Invalid payment method. Please call bank to check Merchant Settings.
    1022 Amount has been over transaction limit for today. Please call bank to check Merchant Settings.
    1023 Transaction not permitted through this merchant type. Please call bank to check Merchant Settings.
    1024 Undefined Error. Error Code:1024
    3001 Error setting mandatory fields, TRANSACTION_ID is empty! TRANSACTION_ID is required for CAPTURE transaction type
    3002 Error setting mandatory fields, RETURN_URL is empty!
    3003 Error setting mandatory fields, RESPONSE_TYPE is empty!
    3004 Error setting mandatory fields, TXN_URL is Null for RESPONSE_TYPE using HTTP!
    3005 Invalid value for RESPONSE_TYPE for non-3D transaction! Acceptable Value : HTTP, XML, PLAIN
    3006 Error setting mandatory fields, TXN_SIGNATURE is empty!
    3007 Invalid value for TXN_SIGNATURE! Computed signature does not match one included in the request.
    3008 Invalid format for TXN_SIGNATURE! TXN_SIGNATURE must be length of 32, and in hexadecimal format.
    3009 Unable to find the transaction record!
    3010 MERCHANT_ACC_NO not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the MERCHANT_ACC_NO is the same MERCHANT_ACC_NO submitted during previous transaction.
    3011 AMOUNT not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the AMOUNT is the same AMOUNT submitted during previous transaction.
    3012 CUSTOMER_ID not matched with previous submitted transaction request! To capture/query previous transaction, if this field is being used, please ensure the CUSTOMER_ID is the same CUSTOMER_ID submitted during previous transaction.
    3013 MERCHANT_TRANID not matched with previous submitted transaction request! To capture/query previous transaction, please ensure the MERCHANT_TRANID is the same MERCHANT_TRANID submitted during previous transaction.
    3014 Insecure mode for RETURN_URL. Please specify an URL which uses HTTPS protocol!
    3015 Insecure mode for TXN_URL. Please specify an URL which uses HTTPS protocol!
    4001 Error setting mandatory fields, CARD_HOLDER_NAME is empty!
    4002 Error setting mandatory fields, MERCHANT_TRANID is empty!
    4003 Duplicate MERCHANT_TRANID detected! Please ensure the MERCHANT_TRANID is always unique.
    4004 Error setting mandatory fields, TXN_DESC is empty!
    4005 Error setting mandatory fields for 3D transaction, MPI_CODE is empty!
    4006 Error setting mandatory fields for 3D transaction, MPI_CAVV is empty!
    4007 Error setting mandatory fields for 3D transaction, MPI_CAVV_ALG is empty!
    4008 Error setting mandatory fields for 3D transaction, MPI_ECI is empty!
    4009 Error setting mandatory fields for 3D transaction, MPI_MSG is empty!
    5001 Error setting mandatory fields for fraud risk detection, FR_HIGHRISK_EMAIL is empty!
    5002 Error setting mandatory fields for fraud risk detection, FR_HIGHRISK_COUNTRY is empty!
    5003 Error setting mandatory fields for fraud risk detection, FR_BILLING_ADDRESS is empty!
    5004 Error setting mandatory fields for fraud risk detection, FR_SHIPPING_ADDRESS is empty!
    5005 Error setting mandatory fields for fraud risk detection, FR_SHIPPING_COST is empty!
    5006 Error setting mandatory fields for fraud risk detection, CUSTOMER_IP is empty!
    5007 Error setting mandatory fields for fraud risk detection, FR_PURCHASE_HOUR is empty!
    5008 Transaction was blocked due to fraud level exceeded threshold limit.
    5009 Transaction was blocked due to blacklisted card detected.
    6001 Unable to get connection to MPI Server!
    6002 Time out occurred during communication with MPI Server!
    6003 Unable to update MPI Ref. No in system. Please try again.
    6004 There was an error occurred during 3D authentication with MPI. Please check logs for details.
    6005 Invalid message or response received from MPI. Please try again.
    6006 MPI Settings are not configured correctly. Please check MPI_HOST and MPI_PORT in system configuration.
    6007 Error occurred when trying to display ACS Form in web browser for 3D authentication. Please try again.
    6008 Problem occurred on MPI side, cannot proceed to display ACS Form. Please check MPI message or try again.
    6009 Unable to locate back transaction to update system after 3-D authentication process. Please try again.
    6010 Empty response received from MPI, please try again.
    6011 MPI Code received is not allowed to proceed to process the transaction.
    6012 Transaction was aborted because 3-D authentication process is not completed.
    6013 Attempted duplicate submission of 3-D authentication result. Please try with new transaction.
    6014 MALL NAME is required for 3-D transaction. Please call bank to check Merchant Settings.
    6015 MALL URL is required for 3-D transaction. Please call bank to check Merchant Settings.
    6016 Invalid value for RESPONSE_TYPE for 3D transaction! Acceptable Value : HTTP only
    8001 This MERCHANT_ACC_NO is not authorized to proceed with this transaction via website! Please check the merchant setting.
    8002 This MERCHANT_ACC_NO is not authorized to proceed with this transaction via batch upload! Please check the merchant setting.
    8003 Exception while query Payment Server!
    8004 Exception while checking for fraud risk!
    9999 Internal Exception. Please call bank to report.
    9988 Server Time Out Exception.
    9977 Bank Connection Error!
    9966 Reply from bank is empty/incorrect!
    9967 Bank rejected transaction!
    9955 Error when trying to insert transaction table. Transaction ID is empty!
    9933 Server interruption occurred during processing. Manual checking required. Please inform Administrator.
    9935 Cancel payment by customer.
    9937 Insufficient point to redeem in cardholder's account. Please enter another card number.

    Inquiry

    Have any inquiry ?
    Feel free contact us : it@nicepay.co.id.

    F.A.Q

    No Topik
    1. Apakah yang dimaksud dengan callback URL?
    Jawab Callback URL merupakan suatu URL yang memproses dan melakukan validasi terhadap hasil data transaksi yang di dapat.
    2. Apakah yang dimaksud dengan dbprocess URL?
    Jawab DbProcess URL merupakan suatu URL yang disediakan untuk menerima dan memproses notifikasi pembayaran.
    3. Apakah merchant dapat melakukan cek status pembayaran?
    Jawab Ya, NICEPAY menyediakan fitur untuk melakukan pengecekan status yang sudah tersedia di librari-librari yang telah disediakan.
    4. Apakah merchant bisa menggunakan Mid & Merchant Key testing di Live Environment?
    Jawab Ya, untuk Mid & Merchant Key testing bisa digunakan di Live Environtment.
    5. Jika ada pembayaran customer yang ditolak, apa yang perlu merchant lakukan?
    Jawab Merchant bisa melakukan pengecekan terlebih dahulu, apakah nomor virtual account, batas waktu pembayaran, dan nominal tagihan sesuai dengan invoice? Jika sudah benar semua namun tetap gagal, maka coba dahulu menggunakan fasilitas lain. sebagai contoh, pembayaran menggunakan ATM gagal, maka coba pembayaran menggunakan E-Banking. Jika pembayaran masih tetap mengalami masalah, silahkan hubungi Customer Service kami.
    6. Bagaimana jika customer sudah berhasil melakukan pembayaran, namun tidak mendapatkan email konfirmasi bayaran?
    Jawab Dalam kondisi normal, customer akan mendapatkan email konfirmasi dalam waktu maksimal 5 menit setelah pembayaran. Jika tetap tidak mendapatkan email konfirmasi, silahkan mengirimkan email kepada customer service kami disertai bukti pembayaran.

    Test Postman

    Changelog

    API Changelog Info

    2.15

    17 May 2018

    1. Update card error code

    2.13

    14 May 2018

    1. Add parameter payment API timeStamp, merchantToken

    2.12

    18 April 2018

    1. update error code

    2.07

    01 February 2018

    1. Add parameter CardHolderNm on Payment API

    2.06

    01 january 2018

    1. Add parameter fee on Payment, Notification, and Inquiry

    2.05

    15 December 2017

    1. Update Error Code

    2.04

    14 November 2017

    1. change Url (www to api)

    2.03

    10 October 2017

    1. Add parameter cardExpYymm on Payment, Notification, and Inquiry API

    2.02

    10 July 2017

    1. Update Registration API
    2. Update Notification API
    3. Update Inquiry API
    4. Update Credit Card Installation information API

    2.01

    10 July 2017

    1. Add parameter timestamp

    2.00

    06 July 2017

    1. Initial Release API Version 2