v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Void API

post/?void

Query parameters

app_idstring required

Merchant APP ID (Alphanumeric - Length of 32 chars)

auth_keystring required

Merchant APP Key (Alphanumeric - Length of 32 chars)

epistring required

EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2

mtypestring required

Message type should be set as 'void'

rrnstring required

RRN number from sale txn response (Numeric - Max length of 15 chars)

auth_codestring required

Approval code response from sale transaction (Alphanumeric - Max length of 8 chars)

tran_nointeger required

Should match the original sale tran_no (Numeric - Max length of chars 11)

staninteger required

STAN number (Numeric - Max length of 6 chars)

amountnumber double required

Add excess two zero for original void transaction amount (ex: 10.00 means 1000). A request should not be sent when the amount is 0. The amount must be greater than zero

pos_entry_modestring required

Mode of transaction in POS terminal (Numeric - length of max chars)

surchargeIndicatorinteger required

The value '0' represents a transaction being ran on the traditional MID with no custom fee added, while '1' represents a transaction being ran on the cash discounting MID with the custom fee added

pos_condition_codeinteger

Check the condition of transaction (length of max 3 chars)

phonestring

Customer phone number- 10 digit Numeric (Ex: 5247896523)

useridstring

Customer user id - Numeric max length of 11 chars

emailstring

Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)

uidstring

A unique id of the request, A client can send any number of 10 digit

taxnumber double

Tax amount - Currency $ (Eg. 00.00)

custom_feenumber double

Custom fee/surcharge fee if any - Add excess two zero for original amount (ex: 5.00 means 500)

tip_amountnumber double

Tip if any - Optional (Eg. 00.00)

Response

200

error_nostring

error_codestring

amountstring

msgstring

descstring

{"stackTrail":"paths:/?void:post:responses:200:content:application/json:schema:properties:additional_info","oasType":"schema","type":"unknown"}

epistring

channelstring

rrnstring

txnidstring

Example response

{
  "error_no": "S00",
  "error_code": "00",
  "amount": "567.67",
  "msg": "APPROVED",
  "desc": "APPROVAL TAS191 ",
  "epi": "2313185814",
  "channel": "VT",
  "rrn": "328604501386",
  "txnid": "5221304"
}