Skip to main content

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 SALE transaction.
  • The request should be initiated in the background (e.g. through PHP CURL).

Request Parameters

ParameterDescriptionLimitationsRequired
actionAction to perform= CREDITVOIDY
client_keyMerchnat Key provided by TESS PaymentsY
trans_idTransaction ID in the Payment PlatformString up to 255 charactersY
amountThe 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
hashSpecial signature to validate your request to Payment PlatformSee Appendix A, Creditvoid signature.Y

Response Parameters

ParameterDescription
actionCREDITVOID
resultACCEPTED - This states that request is received and accepted. Refund result will be sent on Callback Notification Url
order_idTransaction ID in the Client's system
trans_idTransaction ID in the TESS Payments' Platform