Payment Web API
  • Payment API Solutions Map
  • API Common Specifications
  • Payment Status Query API (Common)
  • Refund & Refund Query API (Common)
  • Query Exchange Rate API (Common)
  • Payment Process Flow with Mobile App (Common)
  • API for PC Browser with Wechat Pay/Alipay/UnionPay
    • Payment Request with WeChat Pay
    • Payment Request with Alipay
    • Payment Request with UnionPay-SecurePay
      • Query Transaction with UnionPay-SecurePay
  • API for WeChat Browser with WeChat Pay
    • Payment Request API
    • Query Transaction with WeChat Pay
  • API for WeChat Mini-Program with WeChat Pay
    • Payment Request API
    • Query Transaction API
  • API for Mobile Browser with Alipay
    • Payment Request API
    • Query Transaction API
  • API for Mobile Browser with WeChat
    • Payment Request API
    • Query Transaction API
  • API for Mobile with UnionPay-SecurePay
    • Payment Request API
    • Query Transaction API
    • Code Samples(Web App, Android, iOS)
  • API for Mobile App with WeChat Pay
    • Payment Request API
    • Query Transaction API
  • API for Mobile App with Alipay
    • Payment Request with OTT Pay SDK
    • Implementation with Android App SDK
    • Implementation with iOS App SDK
  • API for In-Store Channels(via Merchant POS/Terminal)
    • API Process Flows
    • Payment Request API
    • Query Transaction API
  • API for Elavon Converge-Hosted payment
    • Payment Request API
    • Query Transaction API
  • API for Global payments PORTICO Ecomm Payment
    • Payment Request API
    • Query Transaction API
  • API for Checkout payment
    • Payment Request API
    • Query Transaction API
  • Appendix A (Data Encryption / Decryption)
  • Appendix B (Response Code)
  • FAQ
  • > Back to Top Page
Powered by GitBook
On this page
  • Refund Transaction API
  • Query Refund API
  • Request Message Parameters
  • Response Message Parameters

Was this helpful?

Refund & Refund Query API (Common)

For all the payment methods

PreviousPayment Status Query API (Common)NextQuery Exchange Rate API (Common)

Last updated 2 years ago

Was this helpful?

Refund Transaction API

Request Message Parameters

Params Name

Description

Required

Notes

action

Action name

Y

REFUND

version

Version number

Y

1.0

merchant_id

Merchant ID

Y

data

Encrypted Transaction Data

Y

refer to "Data" below

md5

Message digest

Y

Data(JSON Data, to be encrypted):

Params Name

Description

Required

Notes

order_id

Order ID

N

Optional. A new order id (Refund Order ID) will be generated for refund instead of old orderID

ori_order_id

Original order ID

Y

refund_amt

Refund amount

Y

String, "100" for 1.00 dollar.

Response Message Parameters

Params Name

Description

Required

Notes

rsp_code

Response code

Y

Please refer to Appendix B

rsp_msg

Response message

Y

data

Encrypted Transaction Data

Y

refer to "Data" below

md5

Message digest

Y

Params Name

Description

Required

Notes

order_id

Order ID

N

Refund Order ID

trade_time

Transact time

N

refund_amt

Refund amount

Y

String, "100" for 1.00 dollar.

Params Name

Description

Required

Notes

action

Action name

Y

REFUND_STATUS_QUERY

version

Version number

Y

1.0

merchant_id

Merchant ID

Y

data

Encrypted Transaction Data

Y

refer to "Data" below

md5

Message digest

Y

Params Name

Description

Required

Notes

order_id

Order ID

N

Refund Order ID

Params Name

Description

Required

Notes

rsp_code

Response code

Y

Please refer to Appendix B

rsp_msg

Response message

Y

data

Encrypted Transaction Data

Y

refer to "Data" below

md5

Message digest

Y

Params Name

Description

Required

Notes

order_id

Order ID

Y

Refund Order ID

order_status

Order status

Y

""success"

refund_amt

Refund amount

Y

String, "100" for 1.00 dollar.

Data(JSON Data, to be encrypted):

Query Refund API

Request Message Parameters

Data(JSON Data, to be encrypted):

Response Message Parameters

Data(JSON Data, to be encrypted):

✅
☑️
✅
☑️
✅
✅
☑️
✅
☑️
✅