iMerchant Sandbox: https://www.sandbox-checkout.imerchant.online/

iMerchant Production: https://www.checkout.imerchant.online/

Manage and issue refunds for payments made to merchants for a previously processed payment.

The following apply for refunds:

  • You cannot refund more than what was originally collected
  • The refund will be returned to it’s original payment account. There’s a remark of refund in iMerchant Merchant Management System
  • Real-time refund
  • Support a full or partial refund

note: Although the refund can be processed immediately, it takes time for the bank to process the fund. Therefore, the refund will not appear in buyer’s bank account in real-time. The standard is 5-10 working days

Protocol parameter

variable namerequiredfield type
service_versionnoString(8)
signyesString(32)

Request Body

bid string(16) required

BID is the account number generated by iMerchant for the merchant. It is a string of 32 bits long to uniquely identify the merchant generated by the system

transaction_id string(26) required

iMerchant platform number to identify a transaction. It contains 26 digits

refund_mchid string(32) required

The unique remark for the merchant processing a specific refund

amount Int required

Refund amount, pay minimum unit

Response Field

result string required

Information about errors encountered during the request

'Fail' or 'Success'

transaction_id string(26) required

iMerchant plaform id

attch_id string(32) required

The unique id to record the refund

error_message string

The message for the error in refund

Language
Click Try It! to start a request and see the response here!