NICEPAY API
...
Checkout API
Payment - API Checkout
Credit Card - API Checkout
33min
about credit card api checkout there are several things that you must know when using {{checkoutproduct}} {{api}} for {{cc}} method so that your {{integration}} {{process}} will run smoothly with us flow 3ds/non 3ds process full {{paymentproduct}} feature installment feature recurring token feature pre auth token feature process flow {{please}} visit {{the}} credit card feature {{page}} to check {{the}} explanation about 3ds 3ds description steps of redirect {{cc}} {{payment}} flow with 3ds the {{customer}} does {{checkout}} the {{customer}} sends {{checkout}} data to {{the}} {{merchant}} the {{merchant}} requests {{checkout}} using registration {{api}} to {{nicepay}} {{nicepay}} registers {{the}} {{checkout}} data {{nicepay}} redirects {{merchant}} to {{the}} {{nicepay}} 's {{payment}} {{page}} the {{merchant}} sends {{the}} {{nicepay}} 's {{payment}} {{page}} to {{the}} {{customer}} the {{customer}} selects {{the}} {{paymethod}} the {{customer}} inputs {{the}} card data the {{customer}} sends {{the}} {{information}} of card data to {{nicepay}} {{nicepay}} {{proceed}} s with {{the}} fds calculation {{nicepay}} requests 3ds to {{bank}} {{bank}} validates {{the}} 3ds {{bank}} sends 3ds url response to {{nicepay}} {{nicepay}} receives {{the}} verification response {{nicepay}} redirects {{the}} {{customer}} to acs authentication {{page}} {{bank}} creates otp response {{bank}} sends otp to {{the}} {{customer}} the {{customer}} receives otp the {{customer}} inputs otp the {{customer}} sends otp to {{bank}} {{bank}} verifies the otp {{bank}} sends 3ds result to {{nicepay}} {{nicepay}} receives {{the}} checking result {{nicepay}} requests {{the}} {{payment}} to {{bank}} {{bank}} {{proceed}} s {{the}} {{payment}} {{bank}} sends {{payment}} {{notification}} to {{nicepay}} {{nicepay}} performs callbackurl redirect to {{the}} {{merchant}} the {{merchant}} displays {{the}} callbackurl result to {{the}} {{customer}} {{nicepay}} sends {{payment}} {{notification}} to {{the}} {{merchant}} the {{merchant}} receives {{the}} {{notification}} the {{merchant}} requests inquiry {{status}} to {{nicepay}} {{nicepay}} receives {{the}} request {{nicepay}} automatically sends {{status}} inquiry response to {{the}} {{merchant}} the {{merchant}} receives {{the}} final {{status}} the {{merchant}} sends {{the}} {{transaction}} result {{page}} to {{the}} {{customer}} non 3ds description steps of redirect {{cc}} {{payment}} flow with non 3ds the {{customer}} performs {{checkout}} the {{customer}} requests {{checkout}} to {{the}} {{merchant}} the {{merchant}} registers {{the}} {{checkout}} data the {{merchant}} sends {{the}} response in {{the}} form of card data form the {{customer}} requests {{checkout}} to {{the}} {{merchant}} the {{merchant}} registers {{the}} {{order}} using registration {{api}} to {{nicepay}} {{nicepay}} stores {{the}} {{order}} registration {{nicepay}} redirects {{merchant}} s to {{the}} {{nicepay}} 's {{page}} the {{merchant}} sends {{nicepay}} 's {{page}} to {{the}} {{customer}} the {{customer}} selects {{the}} {{paymethod}} the {{customer}} inputs card detail the {{customer}} requests {{payment}} using {{paymentproduct}} {{api}} to {{nicepay}} {{nicepay}} {{proceed}} s with {{the}} fds calculation {{nicepay}} requests {{the}} {{payment}} to {{bank}} {{bank}} verifies {{the}} request {{bank}} sends {{payment}} confirmation request to {{the}} {{customer}} the {{customer}} requests {{payment}} /charge to {{bank}} {{bank}} {{proceed}} s {{the}} {{payment}} {{bank}} sends {{the}} response of {{payment}} to {{nicepay}} {{nicepay}} sends {{payment}} notification using callbackurl and dbprocessurl to {{the}} {{merchant}} the {{merchant}} receives {{the}} {{notification}} the {{merchant}} requests {{status}} checking to {{nicepay}} {{nicepay}} sends {{the}} response of {{status}} checking the {{merchant}} receives {{the}} final {{status}} the {{merchant}} sends {{the}} {{order}} result to {{the}} {{customer}} nicepay secure payment page {{please}} open {{the}} credit card payment guide {{page}} to provide your {{customer}} with {{payment}} guide on {{the}} {{cc}} method the image above is a {{payment}} sample with a {{cc}} using {{nicepay}} secure {{paymentproduct}} page after {{the}} {{customer}} selects {{the}} {{cc}} method, {{the}} {{customer}} will ask to input their card data {{nicepay}} {{system}} will automatically recognize {{the}} type of {{customer}} 's bin card like in {{the}} picture below, such as visa or mastercard, american express, etc, later {{the}} cards will be different according to {{the}} card types being used after completing {{the}} card data input, your {{customer}} can continue {{the}} {{payment}} {{process}} then, {{the}} {{transaction}} will run once {{the}} {{transaction}} is successful, then {{the}} display of {{the}} {{nicepay}} {{payment}} {{page}} will appear as {{the}} image as follows {{please}} visit {{the}} payment api checkout {{page}} to know {{the}} next step regarding payment handling full payment credit card on {{the}} full {{paymentproduct}} {{cc}} , {{the}} {{customer}} paid fully {{the}} nominal billed at once the following is {{the}} details {{api}} used on {{cc}} {{payment}} request parameter full payment credit card parameter type size description remark paymenturl required required ans 14 {{paymentproduct}} url https //dev nicepay co id/nicepay/redirect/v2/payment txid required required an 30 transaction id ionpaytest00202203211640309389 for {{checkoutproduct}} {{paymentproduct}} {{api}} , {{cc}} {{paymethod}} with full {{paymentproduct}} and installment got {{the}} same response response parameters full payment credit card (callbackurl) payment parameter type size description remark status n 1 payment status code 0 txid an 30 transaction id ionpaytest00202212201540174369 when success referenceno an 40 {{merchant}} order number ordno20221220151243 when success paymethod n 2 payment method code 01 when success amt n 12 transaction amount 1000 when success notaxamt n 12 tax fee amount 0 when success vat n 12 value added tax ( {{vat}} ) 0 when success fee n 12 service fee 0 when success currency a 3 currency idr when success goodsnm an 100 goods name goods+for+testing+credit+card when success billingnm a 100 billing name john+doe when success transdt n 8 transaction date ( yyyymmdd ) 20221220 when success transtm n 6 transaction time ( hh24miss ) 154017 when success authno n 10 approval number 174300 when success (additional) issubankcd a 4 bank code bmri when success acqubankcd a 4 bank code bmri when success issubanknm a 255 issuing {{bank}} name mandiri when success acqubanknm a 255 acquiring {{bank}} name mandiri when success cctranstype an 2 {{cc}} transaction type 1 normal 2 recurring 3 pre auth 4 capture 1 when success cardno ans 20 card number with masking 46161111 1111 when success cardexpyymm n 4 card expiration ( yymm ) 2707 when success instmnttype n 2 installment type code 1 when success instmntmon n 2 installment month 1 1 month/full {{paymentproduct}} , if instmnttype null/1 3 3 months 6 6 months 12 12 months 1 when success recurringtoken an 255 recurring token null when success preauthtoken an 255 pre auth token null when success matchcl n 1 notification match amount indicator 1 when success merchanttoken an 255 {{merchant}} token 8f5b330a549c167b53b4b9fd5f2d2eba897a64235c1610524074ec59f8884e8a sample parameter for callbackurl api checkout payment url request https //dev nicepay co id/nicepay/redirect/v2/payment?txid=ionpaytest00202203211640309389 url callback https //www merchant com/callbackurl?cctranstype=1\&fee=0\&txid=ionpaytest00202212201540174369\&amt=1000\¬axamt=0\&cardno=46161111 1111\&issubankcd=bmri\&matchcl=1\&preauthtoken=null\&cardexpyymm=2603\&acqubanknm=mandiri\&paymethod=01\¤cy=idr\&instmntmon=1\&cc trans type=1\&issubanknm=mandiri\&merchanttoken=dc1dd9e57ff6c4db341654ae31e623cab4d4d8057b2d0b58bef43ccb0da3b494\&goodsnm=goods+for+testing+credit+card\&referenceno=ordno20221220151243\&authno=174300\&transtm=154017\&cpguaranteeablestatus=null\&recurringtoken=null\&vat=0\&instmnttype=1\&billingnm=john+doe\&acqubankcd=bmri\&transdt=20221220\&status=0 response callback status=0 txid=ionpaytest00202212201540174369 referenceno=ordno20221220151243 paymethod=01 amt=1000 notaxamt=0 vat=0 fee=0 currency=idr goodsnm=goods+for+testing+credit+card billingnm=john+doe transdt=20221220 transtm=154017 authno=174300 issubankcd=bmri acqubankcd=bmri issubanknm=mandiri acqubanknm=mandiri cctranstype=1 cardno=46161111 1111 cardexpyymm=2707 instmnttype=1 instmntmon=1 recurringtoken=null preauthtoken=null matchcl=1 merchanttoken=8f5b330a549c167b53b4b9fd5f2d2eba897a64235c1610524074ec59f8884e8a note response {{parameter}} will be sent through callbackurl with content type application/json and method post parameter for {{the}} {{paymentproduct}} {{integration}} {{process}} on {{checkoutproduct}} {{api}} , {{the}} response from request received after performing call request {{api}} is a callback url api checkout transaction payment api url /nicepay/redirect/v2/payment request method redirect get header content type application/form urlencoded the endpoint above can use for {{cc}} {{paymethod}} s with full {{paymentproduct}} , recurring, and pac (pre auth capture) types recurring token after {{the}} {{merchant}} completes registration api checkout and payment api checkout , then {{nicepay}} will provide recurringtoken for {{the}} gain payment api checkout response on {{the}} next {{transaction}} with {{the}} same {{customer}} , {{merchant}} can use that recurringtoken by using on {{the}} recurring payment api credit card request parameter recurring token parameter type size description remark paymenturl required required ans 14 {{paymentproduct}} url https //dev nicepay co id/nicepay/redirect/v2/payment txid required required an 30 transaction id recurrtest00202212221422115631 response parameter recurring token parameter type size description remark status n 1 payment status code 0 txid an 30 transaction id recurrtest00202212221422115631 when success referenceno an 40 {{merchant}} order number ordno20221222141245 when success paymethod n 2 payment method code 01 when success amt n 12 transaction amount 1000 when success notaxamt n 12 tax fee amount 0 when success vat n 12 value added tax ( {{vat}} ) 0 when success fee n 12 service fee 0 when success currency a 3 currency idr when success goodsnm an 100 goods name goods+for+testing+recurring+token when success billingnm a 100 billing name john+doe when success transdt n 8 transaction date ( yyyymmdd ) 20221220 when success transtm n 6 transaction time ( hh24miss ) 142211 when success authno n 10 approval number 115631 when success (additional) issubankcd a 4 bank code othr when success acqubankcd a 4 bank code bmri when success issubanknm a 255 issuing {{bank}} name (empty) when success acqubanknm a 255 acquiring {{bank}} name mandiri when success cctranstype an 2 {{cc}} transaction type 1 normal 2 recurring 3 pre auth 4 capture 1 when success cardno ans 20 card number with masking 45321111 1111 when success cardexpyymm n 4 card expiry ( yymm ) 2712 when success instmnttype n 2 installment type code 1 when success instmntmon n 2 installment month 1 1 month/full {{paymentproduct}} , if instmnttype null/1 3 3 months 6 6 months 12 12 months 1 when success recurringtoken an 255 recurring token 083333e129dea0535119b71813b1dc67b565e2704958411d2ee2ec2f430d745 when success preauthtoken an 255 pre auth token null when success matchcl n 1 {{paymentproduct}} amount match flag notification status code 1 when success merchanttoken an 255 {{merchant}} token f083333e129dea0535119b71813b1dc67b565e2704958411d2ee2ec2f430d745 sample parameter recurring token payment url request https //dev nicepay co id/nicepay/redirect/v2/payment?txid=recurrtest00202212221422115631 url callback https //www merchant com/callbackurl?cctranstype=1\&fee=0\&txid=recurrtest00202212221422115631\&amt=1000\¬axamt=0\&cardno=45321111 1111\&issubankcd=othr\&matchcl=1\&preauthtoken=null\&cardexpyymm=2712\&acqubanknm=mandiri\&paymethod=01\¤cy=idr\&instmntmon=1\&cc trans type=1\&issubanknm=\&merchanttoken=ebc5fa0c3739fa45d386a005458bd6d81027a729d3c43e77b43adab609244069\&goodsnm=goods+for+testing+recurring+token\&referenceno=ordno20221222141245\&authno=115631\&transtm=142211\&cpguaranteeablestatus=null\&recurringtoken=f083333e129dea0535119b71813b1dc67b565e2704958411d2ee2ec2f430d745\&vat=0\&instmnttype=1\&billingnm=john+doe\&acqubankcd=bmri\&transdt=20221222\&status=0 response callback status=0 txid=recurrtest00202212221422115631 referenceno=ordno20221222141245 paymethod=01 amt=1000 notaxamt=0 vat=0 fee=0 currency=idr goodsnm=goods+for+testing+recurring+token billingnm=john+doe transdt=20221220 transtm=142211 authno=115631 issubankcd=othr acqubankcd=bmri issubanknm=(empty) acqubanknm=mandiri cctranstype=1 cardno=45321111 1111 cardexpyymm=2712 instmnttype=1 instmntmon=1 recurringtoken=083333e129dea0535119b71813b1dc67b565e2704958411d2ee2ec2f430d745 preauthtoken=null matchcl=1 merchanttoken=f083333e129dea0535119b71813b1dc67b565e2704958411d2ee2ec2f430d745 after {{proceed}} ing with {{api}} registration ( registration api checkout ) and {{paymentproduct}} {{api}} {{integration}} ( payment api checkout ) using {{checkoutproduct}} {{api}} , if you want to {{proceed}} with {{paymentproduct}} {{cc}} recurring using {{the}} same recurring token, please do {{the}} registration again on {{the}} registration api checkout then {{proceed}} s {{payment}} by adding {{the}} recurring token also cvv on {{the}} recurringtoken {{parameter}} pre auth token when {{merchant}} s sign a contract as pac {{merchant}} (pre auth/capture), {{nicepay}} provides a preauthtoken for payment api checkout response that token will later use on capture amount {{process}} to complete {{the}} {{transaction}} on pre auth & capture payment api credit card request parameter pre auth token the following are {{parameter}} lists to perform requests with {{the}} pre auth token {{cc}} this {{parameter}} uses in {{the}} {{api}} {{testing}} platform as one of {{the}} steps to connect {{the}} {{merchant}} 's {{system}} s with {{nicepay}} {{service}} s parameter type size description remark paymenturl required required ans 14 {{paymentproduct}} url https //dev nicepay co id/nicepay/redirect/v2/payment txid required required an 30 transaction id pactest00100202212221548525731 response parameter pre auth token parameter type size description remark status n 1 payment status code 5 txid an 30 transaction id pactest00100202212221548525731 when success referenceno an 40 {{merchant}} order number ordno20221222151220 when success paymethod n 2 payment method code 01 when success amt n 12 transaction amount 1000 when success notaxamt n 12 tax fee amount 0 when success vat n 12 value added tax ( {{vat}} ) 0 when success fee n 12 service fee 0 when success currency a 3 currency idr when success goodsnm an 100 goods name goods+for+testing+pre+ +auth+token when success billingnm a 100 billing name john+doe when success transdt n 8 transaction date ( yyyymmdd ) 20221222 when success transtm n 6 transaction time ( hh24miss ) 154852 when success authno n 10 approval number 525731 when success (additional) issubankcd a 4 bank code cena when success acqubankcd a 44 bank code bmri when success issubanknm a 255 issuing {{bank}} name bca when success acqubanknm a 255 acquiring {{bank}} name mandiri when success cctranstype an 2 {{cc}} transaction type 1 normal 2 recurring 3 pre auth 4 capture 1 when success cardno ans 20 card number with masking 53079511 1111 when success cardexpyymm n 4 card expiry ( yymm ) 2712 when success instmnttype n 2 installment type code 1 when success instmntmon n 2 installment month 1 1 month/full {{paymentproduct}} , if instmnttype null/1 3 3 months 6 6 months 12 12 months 1 when success recurringtoken an 255 recurring token null when success preauthtoken an 255 pre auth token edc46eb30a81ac9753e34003d2d1e910d5aaf0dea620889dffcfcc18621864eb when success matchcl n 1 {{paymentproduct}} amount match flag notification match amount indicator 1 when success merchanttoken an 255 {{merchant}} token 1bee4b7c84cfb4e04d9d26cd47285bf49a77f252f39a48370094f5e3250b9524 sample parameter for pre auth token payment url request https //dev nicepay co id/nicepay/redirect/v2/payment?txid= url callback https //www merchant com/callbackurl?cctranstype=3\&fee=0\&txid=pactest00100202212221548525731\&amt=1000\¬axamt=0\&cardno=53079511 1111\&issubankcd=cena\&matchcl=1\&preauthtoken=edc46eb30a81ac9753e34003d2d1e910d5aaf0dea620889dffcfcc18621864eb\&cardexpyymm=2712\&acqubanknm=mandiri\&paymethod=01\¤cy=idr\&instmntmon=1\&cc trans type=3\&issubanknm=bca\&merchanttoken=1bee4b7c84cfb4e04d9d26cd47285bf49a77f252f39a48370094f5e3250b9524\&goodsnm=goods+for+testing+pre+ +auth+token\&referenceno=ordno20221222151220\&authno=525731\&transtm=154852\&cpguaranteeablestatus=null\&recurringtoken=null\&vat=0\&instmnttype=1\&billingnm=john+doe\&acqubankcd=bmri\&transdt=20221222\&status=5 response callback status=5 txid=pactest00100202212221548525731 referenceno=ordno20221222151220 paymethod=01 amt=1000 notaxamt=0 vat=0 fee=0 currency=idr goodsnm=goods+for+testing+pre+ +auth+token billingnm=john+doe transdt=20221222 transtm=154852 authno=525731 issubankcd=cena acqubankcd=bmri issubanknm=bca acqubanknm=mandiri cctranstype=1 cardno=53079511 1111 cardexpyymm=2712 instmnttype=1 instmntmon=1 recurringtoken=null preauthtoken=edc46eb30a81ac9753e34003d2d1e910d5aaf0dea620889dffcfcc18621864eb matchcl=1 merchanttoken=1bee4b7c84cfb4e04d9d26cd47285bf49a77f252f39a48370094f5e3250b9524 after {{proceed}} s registration and {{payment}} using {{checkoutproduct}} {{api}} , if you wants to {{proceed}} with multiple capture by using {{the}} same pre auth token, please do {{the}} registration again then captures on {{the}} payment v2 credit card by adding {{the}} pre auth token also {{the}} cvv on {{the}} preauthtoken {{parameter}} callback handling api checkout payment the txid won't be {{the}} same as {{the}} request hold the capture {{process}} will reassure that {{the}} captured amount value doesn't exceed {{the}} funds owned when your callback already received callbackurl , we recommended {{the}} {{merchant}} to do {{the}} {{status}} verification using {{the}} status inquiry api checkout docid 7thqvphz6emwezw5 d4an callback handling is very important to minimize {{the}} fraud act, we highly recommend {{the}} {{merchant}} to do {{the}} verification using callback parameter url callback "callbackurl" "https //www merchant com/callbackurl/" response callback { "resultcd" "0000", "resultmsg" "success", "txid" "ionpaytest01202212141112221428", "referenceno" "", "paymethod" "01", "amt" "10000", "transdt" "20221212", "transtm" "121212", "description" "testing credit card transaction", "authno" "080623", "issubankcd" "othr" "acqubankcd" "bmri", "cardno" "453211 1111", "goodsnm" "test transaction nicepay" "billingnm" "john doe", "currency" "idr", "timestamp" "20221212121212", "merchanttoken" "2035d2295d9578fffb40137186f0203474142ae3e57992d4847826c5fcaffce6", "cardexpyymm" "2712", "instmntmon" "1", "instmnttype" "1", "cctranstype" "1" }