Merchandise Credit
Merchandise Credit
If you want to issue a refund to the shopper without the original payment or after the refund validity period has expired, you need to use the POST Merchandise Credit
interface.
The main process is as follows:
- When calling the
POST Merchandise Credit
interface, you must include, but not limited to, the following parameters. For detailed field information, refer to the API documentation:paymentMethod.type
:Indicates the payment method. For card transactions, usecard
.paymentMethod.card
: Object contains consumer card information and terminal details. This field is required whenpaymentMethod.type
is card.transAmount
:Object contains the transaction amount and currency.merchantTransInfo
:Object contains the merchant order number.pspInfo
:Object contains card organization qualification information.
Example
curl 'https://hkg-online-uat.everonet.com/g2/v0/payment/acq/10130014/evo.offline.merchandiseCredit' \
-H 'Authorization: 4e2420fdb01b5ba61d18db59f25fe1b26e578d28f64f91038183773b872b8322' \
-H 'DateTime: 20240306140435+0800' \
-H 'SignType: SHA256' \
-H 'Content-Type: application/json' \
-H 'MsgID: M20240306140435199' \
-d '{
"merchantTransInfo": {
"merchantTransID": "T20240306140435199",
"merchantTransTime": "2024-03-06T14:04:35+08:00"
},
"paymentMethod": {
"type": "card",
"card": {
"posEntryMode":"magnetic",
"pinFlag":false,
"termReadability":"5",
"cardInfo": {
"cardNumber": "4761340000000043",
"expiryDate": "2212",
"track2": "4761340000000043=221220113183086"
}
}
},
"transAmount": {
"currency": "HKD",
"value": "1.00"
},
"pspInfo": {
"mcc": "5499",
"sponsorCode": "467881",
"merchantID": "202106305812001",
"terminalID":"00000001",
"merchantName": "Test",
"storeID": "202106305812001",
"storeName": "Test Store",
"street": "Test street",
"city": "SH",
"postCode": "202000",
"nation": "MYS"
}
}'
Check the
merchandiseCredit.status
field in the EVO Cloud response. If the value isSuccess
, the refund was successful. If not, review theresult.code
andresult.message
to review the reason for the failure.If you do not receive a response from EVO Cloud, you should use the
GET Merchandise Credit
to query the transaction result. Upon receiving the query response, check themerchandiseCredit.status
field to determine the result, using the same method as in step 2. If the transaction failed, review themerchandiseCredit.failureCode
andmerchandiseCredit.failureReason
to understand the failure reason.If you included a
webhook
in thePOST Merchandise Credit
request, you can also receive the transaction result via asynchronous notification. Similarly, use themerchandiseCredit.status
field to determine the result, following the same method as in step 2.