NICEPAY API
...
Payout API (Disbursement) - SN...
Registration - API Payout (Disbursement) SNAP
7 min
about registration api payout (disbursement) snap this api with snap standards uses to register the payout or disbursement transaction before executing the transaction process registration api payout (disbursement) snap please request the access token firsthand before performing the authentication through the docid 92feymrqs iebhxrfgxuq section api endpoint /nicepay/api/v1 0/transfer/registration /nicepay/api/v1 0/transfer/registration http method post description create transaction payout or disbursement content type application/json request registration payout (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 docid\ uzex33relyenkogbjjnyp 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 registration payout (disbursement) body parameter parameter type length required description merchantid string 10 mandatory merchant identifier that is unique per each merchant msid string 20 optional merchant seller id beneficiaryaccountno string 25 mandatory beneficiary account number beneficiaryname string 100 mandatory beneficiary name beneficiaryphone string 20 mandatory beneficiary phone 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 beneficiarypostalcode string 6 optional beneficiary postal code payoutmethod string 4 mandatory payout method 0 over booking, 1 online trans 2 skn 3 rtgs beneficiarybankcode string 4 mandatory beneficiary docid 5pxu cbdxvy2biili8 cv amount array of json object variable mandatory amount information "amount" { } value string 12 mandatory transaction amount, including thecents currency string 3 mandatory currency code based on iso partnerreferenceno string 40 mandatory transaction id from merchant reserveddt string 8 optional the date when {{the}} {{payment}} will be automatic reserved yyyymmdd 20251231 reservedtm string 6 optional the date when {{the}} {{payment}} will be automatic reserved hh24miss 235959 description string 255 optional description transaction response registration payout (disbursement) parameter parameter type length required description responsecode string 7 mandatory refer to docid\ bjr4kjamzcknln 5zrnvw list responsemessage string 150 mandatory refer to docid\ bjr4kjamzcknln 5zrnvw list partnerreferenceno string 40 mandatory merchant transaction identifier originalreferenceno string 40 mandatory original transaction identifier on service provider system beneficiaryaccountno string 25 mandatory beneficiary account number beneficiaryname string 100 mandatory beneficiary name payoutmethod string 4 mandatory payout method 0 over booking 1 online trans 2 skn 3 rtgs beneficiarybankcode string 4 mandatory beneficiary 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 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 exid202402111402271707638103 channel id ionpaytest { "merchantid" 'ionpaytest', "msid" "", "beneficiaryaccountno" '5345000060', "beneficiaryname" 'ionpay networks', "beneficiaryphone" '08123456789', "beneficiarycustomerresidence" '1', "beneficiarycustomertype" '1', "beneficiarypostalcode" '123456', "payoutmethod" '0', "beneficiarybankcode" 'cena', "amount" { "value" '12345678 00', "currency" 'idr' }, "partnerreferenceno" 'order1676975014155', "description" 'this is test request', "reserveddt" '20230222', "reservedtm" '172334' } sample response { "responsecode" "2000000", "responsemessage" "successful", "partnerreferenceno" "order1676975014155", "originalreferenceno" "ionpaytest07202302211723331619", "beneficiaryaccountno" "5345000060", "beneficiaryname" "nicepay", "payoutmethod" "1", "beneficiarybankcode" "cena", "amount" { "value" "12345678 00", "currency" "idr" } }