NICEPAY API
...
Payment API - SNAP
API QRIS SNAP
Registration - API QRIS SNAP
8 min
about registration api qris snap this api with snap standards uses to request order registration before proceeding with payment using the qris payment method registration api qris snap please request the access token firsthand before doing the authentication through the request access token api snap docid 92feymrqs iebhxrfgxuq section service code 47 api endpoint /api/v1 0/qr/qr mpm generate http method post description merchant request registration api qris content type application/json registration header parameter parameter type required description example content type string (127) mandatory type of the content application/json x timestamp string (25) mandatory using iso 8601 as timestamp format transaction date time, in format yyyymmddthh\ mm\ ss+07 00 time must be in gmt+7 (jakarta time) 2022 03 21t10 11 40+07 00 authorization string (variable) mandatory "bearer" + { access token } x signature string (variable) mandatory signature will be generated by merchant snap api testing x partner id string (20) mandatory nicepay client id ( mid ) ionpaytest x external id string (40) mandatory unique messaging reference id generated by merchant numeric string reference number that should be unique in every transaction in one day channel id string (5) mandatory unique channel merchant credential id number client id + "01" = channel id "ionpaytest" + "01" = "ionpaytest01" ionpaytest01 registration body parameter parameter parameter type required nicepay parameter description example partnerreferenceno string (40) mandatory referenceno unique transaction id from merchant ordno20230303001 amount object mandatory "amount" { "value" "100", "currency" "idr" } value string (12) mandatory amt transaction amount note amount format, currently only supported idr (indonesian currency rupiah) then value includes 2 decimal digits which are seperated by a dot ( ) 10000 00 currency string (3) mandatory currency default value idr idr merchantid string (10) mandatory imid merchant identifier storeid string (32) mandatory storecd / shopid merchant id from acquirer pay side validityperiod string (25) mandatory paymentexpdt paymentexptm set default 5 minutes maximum 20 minutes using iso 8601 timestamp format additionalinfo object mandatory "additionalinfo" { , "cartdata" "{ }", "mitracd" "qshp" } goodsnm string (200) mandatory goods name billingnm string (100) mandatory buyer name billingphone string (20) mandatory buyer phone number billingemail string (100) mandatory buyer email billingcity string (50) mandatory buyer city billingstate string (50) mandatory buyer state billingpostcd string (10) mandatory buyer post number billingcountry string (10) mandatory buyer country callbackurl string (500) conditional dbprocessurl string (500) mandatory payment notification url (async notification) userip string (64) mandatory user ip (customer) cartdata string (4000) mandatory json string mitracd string (4) mandatory mitra code api snap docid 6go07owr b22bafuetehl msid string (20) optional merchant seller id msfee string (7) optional merchant seller fee msfeetype string (2) optional merchant seller fee type mbfee string (7) optional merchant balance fee mbfeetype string (2) optional merchant balance fee type registration cart data parameter description example count total cart data count 1 item img url goods image url (image size 50px 50px) https //merchant com/goodsimg png goods name goods name merchant goods goods detail goods detail description goods type 001 goods amt goods payment amount 100 goods quantity goods quantity 1 response registration parameter parameter parameter type required nicepay parameter description example responsecode string (7) mandatory responsecode error code to specify the error returned general response code and message api snap docid\ bjr4kjamzcknln 5zrnvw 2004700 responsemessage string (150) mandatory responsemsg debug message to provide more information successful referenceno string (40) mandatory txid nicepay transaction id or identifier ionpaytest08202106091121206416 partnerreferenceno string (40) mandatory referenceno transaction identifier on merchant side ncpy20221017161458 qrcontent string (360) mandatory qrcontent qr string in plain text "000201010212265400161d co shopee wwwo11893600918002024585002082024585052041234530 336054041 0058021d5911test6007bandung61054016362200516 1 july 20 126304d0a9 qrurl string (360) mandatory qrurl url to download qr image, url is valid for 5 minutes https //xxx co id/v3/merchant host/qr/download? 4arlcjaqjxyxifavfxz0eprx5c£g4nnzgeauyn1rl" additionalinfo object mandatory "additionalinfo" { } goodsnm string (200) mandatory goods name merchant goods 1 billingnm string (100) mandatory buyer name john doe validityperiod string (25) mandatory paymentexpdt , paymentexptm transaction date iso 8601 2023 03 08t07 15 00+07 00 mitracd string (4) mandatory mitra code api snap docid 6go07owr b22bafuetehl qshp msid string (20) optional merchant seller id 123 msfee string (7) optional merchant seller fee 2000 msfeetype string (2) optional merchant seller fee type 2 mbfee string (7) optional merchant balance fee 2000 mbfeetype string (2) optional merchant balance fee type 2 sample request //header section content type application/json authorization bearer eyj0exaioijkv1qilcjhbgcioijiuzi1nij9 eyjzdwiioijutkldrvfsmdgxiiwiaxnzijoitkldrvbbwsisim5hbwuioijosunfuefziiwizxhwijoimjaync0wnc0xofqwmjozmtoyovoifq== 5f1rppweobc eqjyw64w87f3m1 tls5dzfzfhjxpzss= x timestamp 2022 04 18t09 00 40+07 00 x signature sbvrkrqxrzvjtr/7rwtherteyyds5nguotyfdcegt1novzuhf/uy25rvggvzmzqdkx6tivn9cmytrvxhwlgfzq== x partner id \ tniceqr081 x external id 09041220240418 channel id tniceqr08101 { "partnerreferenceno" "ordno2022120215134035", "amount" { "value" "100 00", "currency" "idr" }, "merchantid" "tniceqr081", "storeid" "nicepaystoreid1", "validityperiod" "2024 04 18t10 31 33+07 00", "additionalinfo" { "goodsnm" "test snap transaction nicepay", "billingnm" "john doe", "billingphone" "082213561712", "billingemail" "email\@merchant com", "billingcity" "jakarta", "billingaddr" "jalan bukit berbunga 22", "billingstate" "dki jakarta", "billingpostcd" "12345", "billingcountry" "indonesia", "callbackurl" "https //ptsv2 com/t/jhon/post", "dbprocessurl" "https //ptsv2 com/t/jhon/post", "userip" "127 0 0 1", "cartdata" "{\\"count\\" 1,\\"item\\" \[{\\"img url\\" \\"https //d3nevzfk7ii3be cloudfront net/igi/vorghxlovuka566a medium\\",\\"goods name\\" \\"nokia 3360\\",\\"goods detail\\" \\"old nokia 3360\\",\\"goods amt\\" \\"100\\",\\"goods quantity\\" \\"1\\"}]}", "mitracd" "qshp" } } sample response { "responsecode" "2004700", "responsemessage" "successful", "referenceno" "tniceqr08108202404181012168473", "partnerreferenceno" "ordno2022120215134035", "qrcontent" "00020101021226610016id co shopee www01189360091800202508660208202508660303umi5204123453033605406100 005802id5913nicepaystore16015kab aceh barat61052365962360520082024041810121600660708t00000026304c6f6", "qrurl" "https //mapi gw\ uat airpay co id/v3/merchant host/qr/download?qr=ps03qyb4zmuqmpdhsil1jir2wmpx3ergj3vjbavfwc", "additionalinfo" { "goodsnm" "test snap transaction nicepay", "billingnm" "john doe", "mitracd" "qshp", "validityperiod" "2024 04 18t10 31 33+07 00" } }