iMerchant Sandbox: https://gw-test.passfeed.com
iMerchant Production: https://api.passfeed.com/
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 name | required | field type |
|---|---|---|
| service_version | no | String(8) |
| sign | yes | String(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
Refunds can only be sent back to the original payment method used in a charge. It’s not possible to send a refund to a different destination (for example, another card or bank account).
The refund will 'fail' if the customer's bank or card issuer has been unable to process it correctly (for example, a closed bank account or a problem with the card). The bank returns the refunded amount to us. This process can take up to 30 days from the post date and refund status will keep staying 'pending' during this case.
| variable name | required | field type | description |
|---|---|---|---|
| result | yes | string | The result of the refund transacation. Could be 'Fail', 'Success' and 'pending' |
| transaction_id | yes | string(26) | iMerchant platform id |
| attch_id | yes | string(32) | The unique id to record the refund |
| error_message | no | string | The message for the error in the refund |