NICEPAY API
...
Payment API - SNAP
API E-Wallet (Direct Debit) SN...
Refund Transaction - API E-Wallet (Direct Debit) SNAP
7 min
about refund transaction api e wallet (direct debit) snap this api uses to request the refund process from a transaction on the e wallet payment method with direct debit host to host feature based on the snap bi standard refund transaction api e wallet (direct debit) snap please request the access token firsthand before performing the authentication through the request access token api snap docid 92feymrqs iebhxrfgxuq section service code 58 api endpoint /api/v1 0/debit/refund https //dev nicepay co id/nicepay/api/v1 0/debit/refund http method post description request refund transaction for authentication content type application/json request refund header parameter parameter type length required description example content type string 127 mandatory application/json authorization string variable mandatory bearer “ accesstoken ” 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 x signature string variable mandatory signature will be generated by merchant snap api testing x partner id string 20 mandatory x partner id = client id x external id string 40 mandatory unique reference number ( 41807553358950093184 ) channel id string 5 mandatory unique channel merchant credential id number client id + "01" = channel id "ionpaytest" + "01" = "ionpaytest01" ionpaytest01 request refund body parameter parameter type length required description merchantid string 10 mandatory merchant identifier that is unique per each merchant submerchantid string 32 optional sub merchant id originalreferenceno string 40 mandatory original transaction identifier on service provider system originalpartnerreferenceno string 40 mandatory original transaction identifier on consumer system partnerrefundno string 40 mandatory reference number from merchant for the refund refundamount array of json object variable mandatory amount of refund "refundamount" { "value" "10000 00", "currency" "idr" } value string 12 mandatory value currency string 3 mandatory currency externalstoreid string 32 optional unique identifier of shop id in client system reason string 256 optional refund reason additionalinfo json object variable optional additional information "additionalinfo" { "refundtype" "1" } refundtype string 2 mandatory refund type 1 full refund 2 partial refund response refund parameter parameter type length required description responsecode string 7 mandatory refer to general response code and message api snap docid\ bjr4kjamzcknln 5zrnvw list responsemessage string 150 mandatory refer to general response code and message api snap docid\ bjr4kjamzcknln 5zrnvw list originalreferenceno string 40 mandatory original transaction identifier on service provider system originalpartnerreferenceno string 40 mandatory original transaction identifier on service provider system must be filled upon successful transaction refundno string 40 mandatory refund number identifier on service provider system reference number partnerrefundno string 40 mandatory reference number from merchant for the refund refundamount array of json object variable mandatory amount of refund "refundamount" { "value" "10000 00", "currency" "idr" } value string 12 mandatory value currency string 3 mandatory currency refundtime string 25 mandatory refund time iso 8601, in format yyyymmddthh\ mm\ ss+07 00 time must be in gmt+7 (jakarta time) additionalinfo json object variable mandatory additional information "additionalinfo" { "refundtype" "1" } refundtype string 2 mandatory refund type 1 full refund 2 partial refund sample parameter sample request //header section content type application/json authorization bearer eyj0exaioijkv1qilcjhbgcioijiuzi1nij9 eyjzdwiioijjt05qqvlurvnuiiwiaxnzijoitkldrvbbwsisim5hbwuioijcukloiiwizxhwijoimjaync0wmi0xmvqwodowotoznvoifq== aiyblx36dywffvw7dcoenxkoe2eawiyq84ztpuif3k8= x timestamp 2024 12 31t10 11 40+07 00 x signature ufbw7r8rhw79ioiv/hlv607m60qzaybv8uzmbsryb6/thlo/fhqvp4xryeluehoss9o+qs6vwtkb/ygtucc+tq== x partner id tniceew05 x external id txid202402111402271707638101 channel id tniceew05 { "merchantid" "00007100010926", "submerchantid" "310928924949487", "originalpartnerreferenceno" "2020102900000000000001", "originalreferenceno" "tniceew05105202210141451109841", "partnerrefundno" "239850918204981205970", "refundamount" { "value" "10000 00", "currency" "idr" }, "externalstoreid" "124928924949487", "reason" "customer complain", "additionalinfo" { "refundtype" "1" } } sample response { "responsecode" "2005800", "responsemessage" "successful", "originalpartnerreferenceno" "2020102900000000000001", "originalreferenceno" "tniceew05105202210141451109841", "refundno" "ref993883", "partnerrefundno" "239850918204981205970", "refundamount" { "value" "10000 00", "currency" "idr" }, "refundtime" "2020 12 21t17 21 41+07 00", "additionalinfo" { "refundtype" "1" } }