Refund Transaction - API QRIS SNAP
This API with SNAP standards uses to refund transactions on the QRIS payment method.
Please request the access token firsthand before executing the Refund Transaction API through the Request Access Token API - SNAP section.
Service Code | 78 |
|---|---|
API Endpoint | /nicepay/api/v1.0/qr/qr-mpm-refund |
HTTP Method | POST |
Description | Refund Transaction QRIS API |
Content-type | application/json |
Parameter | Type | Mandatory | 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 | Generated by Partner / Merchant SHA256withRSA (Private_Key, stringToSign). stringToSign = client_ID + "|" + X-TIMESTAMP | |
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 | Device identification on which the API services is currently being accessed by the End User (Customer) | |
Parameter | Parameter Type | Mandatory | NICEPAY Parameter | Description | Example |
|---|---|---|---|---|---|
originalReferenceNo | String (40) | Mandatory | tXId | NICEPAY Transaction ID or Identifier | IONPAYTEST08202106091121206416 |
originalPartnerReferenceNo | String (40) | Mandatory | referenceNo | Unique Transaction ID from Merchant | ncpy20221017161458 |
partnerRefundNo | String (40) | Mandatory | merReferenceRefundNo | Merchant Refund Reference Number | ncpy20221017161458 |
merchantId | String (10) | Mandatory | iMid | NICEPAY Merchant ID | IONPAYTEST |
externalStoreId | String (32) | Mandatory | storeCd | Merchant ID from Acquirer Pay Side | NICEPAY |
refundAmount | Object | Mandatory | "refundAmount": { "value": ..., "currency": ... }, | | |
- 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 |
reason | String (256) | Mandatory | cancelMsg | Reason of Cancel | Refund Trans |
additionalInfo | Object | Mandatory | "additionalInfo": { "cancelType" : "1" } | - | - |
cancelType | String (2) | Mandatory | cancelType | 1: Full Cancellation 2: Partial Cancellation | 1 |
Parameter | Parameter Type | Mandatory | NICEPAY Parameter | Description | Contoh |
|---|---|---|---|---|---|
responseCode | String (7) | Mandatory | responseCd | Error code to specify the error returned | 2007800 |
responseMessage | String (150) | Mandatory | responseMsg | Debug message to provide more information | Successful |
originalReferenceNo | String (40) | Mandatory | canceltXid | NICEPAY Transaction ID or Identifier that need to be cancelled | ncpy20221017161458 |
originalPartnerReferenceNo | String (40) | Mandatory | referenceNo | Unique Transaction ID from Merchant | IONPAYTEST08202106091121206416 |
referenceNo | String (40) | Mandatory | tXid | Unique Refund ID from NICEPAY | IONPAYTEST08202106091121206416 |
partnerRefundNo | String (40) | Mandatory | merReferenceRefundNo | Merchant refund reference number | ncpy20221017161458 |
refundAmount | Object | Mandatory | "refundAmount": { "value": "10000.00", "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 |
refundTime | String (25) | Mandatory | transDt, transTm | Update time of the individual Refund. The value will be returned for successful invalidate request. Using ISO-8601 Timestamp Format. (YYYY-MM-DDTHH:MM:SS) | 2022-07-20T07:15:00+07:00 |
additionalInfo | Object | Mandatory | - | "additionalInfo": { "cancelTrxSn": "07202210051341224326" } | - |
- cancelTrxSn | String (32) | Mandatory | - | Refund Transaction Number From Acquirer Side | 07202210051341224326 |