NICEPAY API
...
API SNAP BI
Payout API (Disbursement) - SN...
Inquiry - API Payout (Disbursement) SNAP
7 min
about inquiry api payout (disbursement) snap this api uses to obtain the inquiry transaction detail going through disbursement process inquiry api payout (disbursement) snap please request the access token firsthand before doing the authentication through the request access token api snap docid 92feymrqs iebhxrfgxuq section api endpoint /nicepay/api/v1 0/transfer/inquiry https //www nicepay co id/nicepay/api/v1 0/transfer/inquiry http method post description to obtain the inquiry transaction detail going through disbursement process content type application/json request inquiry disbursement header parameter parameter type length required description remarks content type string 127 mandatory content type, value always 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 unique partner id, partner id = client id x external id string 40 mandatory unique messaging reference id generated by merchant numeric string reference number that should be unique in every transaction channel id string 5 mandatory unique channel merchant credential id number client id + "01" = channel id "ionpaytest" + "01" = "ionpaytest01" ionpaytest01 request inquiry disbursement body parameter parameter type length required description merchantid string 10 mandatory merchant identifier that is unique per each merchant originalreferenceno string 40 mandatory original transaction identifier on service provider system originalpartnerreferenceno string 40 mandatory original transaction identifier on consumer system beneficiaryaccountno string 25 mandatory beneficiary account number response inquiry disbursement parameter parameter type length required description responsecode string 7 mandatory refer to general response code and message api snap docid\ bjr4kjamzcknln 5zrnvw responsemessage string 150 mandatory refer to general response code and message api snap docid\ bjr4kjamzcknln 5zrnvw 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 beneficiaryaccountno string 25 mandatory beneficiary account number beneficiaryname string 100 mandatory beneficiary name beneficiarycustomerresidence string 2 mandatory beneficiary customer residence 1 indonesia 2 non indonesia beneficiarycustomertype string 2 mandatory beneficiary customer type 1 personal 2 company 3 government beneficiarybankcode string 4 mandatory beneficiary bank code api snap docid 5pxu cbdxvy2biili8 cv amount array of json object variable mandatory amount information "amount" { } value string 12 mandatory transaction amount, if it’s idr then value includes 2 decimal digits e g idr 10 000, will be placed with 10000 00 currency string 3 mandatory currency code based on iso transactiondate string 25 mandatory transaction date latesttransactionstatus string 2 mandatory transaction status api snap docid\ nvclmbygxr5uc 5qmyu7 transactionstatusdesc string 50 optional transaction status description sample parameter request body //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 \ ionpaytest x external id exid202402111402271707638105 channel id ionpaytest { "merchantid" "ionpaytest", "originalpartnerreferenceno" "order1677048512514", "originalreferenceno" "ionpaytest07202302221348332909", "beneficiaryaccountno" "5345000060" } sample response { "responsecode" "2000000", "responsemessage" "successful", "originalpartnerreferenceno" "order1677048512514", "originalreferenceno" "ionpaytest07202302221348332909", "beneficiaryaccountno" "5345000060", "beneficiaryname" "ionpay networks", "beneficiarybankcode" "cena", "beneficiarycustomerresidence" "1", "beneficiarycustomertype" "1", "amount" { "value" "10000 00", "currency" "idr" }, "latesttransactionstatus" "03", "transactionstatusdesc" "pending" }