Refund Request (CREDITVOID)
To initiate a refund within the Payment Platform, utilize the "CREDITVOID" request.
API Endpoint
Request URL: {{API_HOST}}
Request Method: POST
Request Body: x-www-form-urlencoded
Response Body: JSON
tip
- {{API_HOST}}
- REFUND transaction is used to return funds to cardholder account against a
SALEtransaction. - The request should be initiated in the background (e.g. through PHP CURL).
Request Parameters
| Parameter | Description | Limitations | Required |
|---|---|---|---|
action | Action to perform | = CREDITVOID | Y |
client_key | Merchnat Key provided by TESS Payments | Y | |
trans_id | Transaction ID in the Payment Platform | String up to 255 characters | Y |
amount | The amount for partial refund. Several partial refunds allowed. | Numbers in the format XXXX.XX Pay attention that amount format depends on currency exponent. If exponent = 0, then amount is integer (without decimals). It used for currencies: CLP, VND, ISK, UGX, KRW, JPY. If exponent = 3, then format: XXXX.XXX (with 3 decimals). It used for currencies: BHD, JOD, KWD, OMR, TND. | N |
hash | Special signature to validate your request to Payment Platform | See Appendix A, Creditvoid signature. | Y |
Response Parameters
| Parameter | Description |
|---|---|
action | CREDITVOID |
result | ACCEPTED - This states that request is received and accepted. Refund result will be sent on Callback Notification Url |
order_id | Transaction ID in the Client's system |
trans_id | Transaction ID in the TESS Payments' Platform |