1. Refund
EVO Payment Gateway API
  • Gateway Integration
    • Version Record
    • CardInfoLink Gateway API Integration Guide
      • Online payments scenes
        • DCC
        • Tokenization
        • Payment
        • 3DS Authentication
        • Capture
        • Cancel
        • Refund
        • Merchandise Credit
        • Network token management
        • Cancel or Refund
        • Recapture
        • Recurring
      • Security Requirements and Message Header
        • Message protocol
        • Signature
        • Card Information Encryption
        • PIN Encryption
      • Offline payments scenes
        • Pre-authorization
        • Payment
        • Capture
        • Refund
        • Merchandise Credit
        • Cancel
        • Reversal
        • DCC
        • Recurring
      • Appendix
        • Response code
        • FAQ
        • Mastercard-Merchant Advice Code
        • Product Code
    • Offline API Specification
      • Payment
        • Payment
        • Payment
      • StandaloneCapture
        • StandaloneCapture
        • StandaloneCapture
      • Reversal
        • Reversal
      • MerchandiseCredit
        • MerchandiseCredit
        • MerchandiseCredit
      • Capture
        • Capture
        • Capture
      • TipsAdjustment
        • TipsAdjustment
        • TipsAdjustment
      • Cancel
        • Cancel
        • Cancel
      • MultipleCapture
        • MultipleCapture
        • MultipleCapture
      • FXRateInquiry
        • FXRateInquiry
        • FXRateInquiry
      • Refund
        • Refund
        • Refund
      • DCCToNon-DCC
        • DCCToNon-DCC
        • DCCToNon-DCC
      • ZPK
        • ZPK
      • Notification
        • Asynchronous notification for StandaloneCapture
        • Asynchronous notification for MultipleCapture
        • Asynchronous notification for Payment
        • Asynchronous notification for Capture
        • Asynchronous notification for Refund
        • Asynchronous notification for MerchandiseCredit
        • Asynchronous notification for Cancel
    • Online API Specification
      • PaymentMethod
        • PaymentMethod
        • PaymentMethod
        • PaymentMethod
        • PaymentMethod
      • Payment
        • Payment
        • Payment
        • Payment
      • Refund
        • Refund
          POST
        • Refund
          GET
      • Cancel
        • Cancel
        • Cancel
      • Capture
        • Capture
        • Capture
      • PaymentInstrument
        • PaymentInstrument
        • PaymentInstrument
        • PaymentInstrument
        • PaymentInstrument
      • MerchandiseCredit
        • MerchandiseCredit
        • MerchandiseCredit
      • CancelOrRefund
        • CancelOrRefund
        • CancelOrRefund
      • TransactionHistoryInquiry Copy
        • TransactionHistoryInquiry
      • MultipleCapture
        • MultipleCapture
        • MultipleCapture
      • Cryptogram
        • Cryptogram
        • Cryptogram
      • StandaloneCapture
        • StandaloneCapture
        • StandaloneCapture
      • Recapture
        • Recapture
        • Recapture
      • AsynchronousNotification
        • Asynchronous notification for Multiple Capture
        • Asynchronous notification for PaymentMethod
        • Asynchronous notification for PaymentInstrument
        • Asynchronous notification for Payment
        • Asynchronous notification for Merchandise Credit
        • Asynchronous notification for Refund
        • Asynchronous notification for Capture
        • Asynchronous notification for Cancel
        • Asynchronous notification for Recapture
        • Asynchronous notification for Cryptogram
        • Asynchronous notification for Network Token update
        • Asynchronous notification for Standalone Capture
        • Asynchronous notification for Network Token authentication finished
      • HealthCheck
        • HealthCheck
      • FX Rate inquiry
        • FXRateInquiry
        • FXRateInquiry
  1. Refund

Refund

POST
/g2/v0/payment/acq/{aid}/evo.e-commerce.refund/{merchantTransID}

Request

Path Params

Header Params

Body Params application/json

Example
{
    "merchantTransInfo": {
        "merchantTransID": "T20250620144441454",
        "merchantTransTime": "2025-06-20T14:44:41+08:00"
    },
    "transAmount": {
        "currency": "HKD",
        "value": "1.00"
    },
    "metadata": "This is a metadata",
    "initiatingReason": "Customer Refund",
    "webhook": "https://17bc0f2b-621c-407e-8bc3-4e6cabef6f04.mock.pstmn.io"
}

Responses

🟢200Success
application/json
Headers

Bodyapplication/json

Example
{
    "merchantTransInfo": {
        "merchantTransTime": "2025-06-20T14:44:41+08:00"
    },
    "metadata": "This is a metadata",
    "payment": {
        "evoTransInfo": {
            "evoTransID": "413e537805354aaa8d98802d7cc2a881",
            "evoTransTime": "2025-06-20T06:43:38Z",
            "retrievalReferenceNum": "517114534481",
            "traceNum": "534481"
        },
        "merchantTransInfo": {
            "merchantTransID": "T20250620144338765",
            "merchantTransTime": "2025-06-20T14:43:38+08:00"
        },
        "pspTransInfo": {
            "authorizationCode": "097651",
            "pspTransID": "305171242187673",
            "pspTransTime": "2025-06-20T06:43:38Z"
        },
        "status": "Refunded",
        "transAmount": {
            "currency": "HKD",
            "value": "1.00"
        }
    },
    "paymentMethod": {
        "card": {
            "first6No": "417666",
            "fundingType": "debit",
            "issuingCountry": "826",
            "last4No": "0104",
            "paymentBrand": "VIS"
        },
        "type": "card"
    },
    "pspData": {
        "name": "Visa"
    },
    "refund": {
        "evoTransInfo": {
            "evoTransID": "83dfe0938939470ab73de01c0ad5f3bd",
            "evoTransTime": "2025-06-20T06:44:42Z",
            "retrievalReferenceNum": "517114534554",
            "traceNum": "027006"
        },
        "merchantTransInfo": {
            "merchantTransID": "T20250620144441454",
            "merchantTransTime": "2025-06-20T14:44:41+08:00"
        },
        "pspTransInfo": {
            "authorizationCode": "092223",
            "pspTransID": "305171242828063",
            "pspTransTime": "2025-06-20T06:44:41Z"
        },
        "status": "Success",
        "transAmount": {
            "currency": "HKD",
            "value": "1.00"
        }
    },
    "result": {
        "code": "S0000",
        "message": "Success",
        "pspMessage": "Successful approval/completion or V .I.P .PIN verification is successful",
        "pspResponseCode": "00"
    }
}
Previous
Payment
Next
Refund
Built with