v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Refund API

post/?refundapi

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

The unique id refers to a particular store of the merchant

mtypestring required

Set the message type as 'refund'

amountnumber double required

Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99). A request should not be sent when the amount is 0. The amount must be greater than zero

panstring required

Customer card number 15 to 19 digits

expiry_datestring required

Card expiry date, Accepted expiry MMYY & MM/YY

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

food_amountnumber double

Currency $(Eg. 00.00) - Food amount should be less than to transaction amount

taxnumber double

Tax amount - Currency $ (Eg. 00.00)

city_taxnumber double

City tax amount - Currency $ (Eg. 00.00)

reduced_taxnumber double

Reduced tax amount - Currency $ (Eg. 00.00)

uidstring

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

custom_feenumber double

Additional fee of surcharge amount - Currency $ (Eg: 10.00)

cvvstring

Card Verification Value should be 3 or 4 digits (Ex: 999, 9997)

binTypestring

To identify the card type to check Credit or Debit

surchargeRemovedstring

To remove the surcharge fee set value 0 else set 1

card_holder_namestring

Name of the cardholder - Alphabet (Max length of 25 chars)

s_customerNamestring

Shipping address customer name - Alphabet (Max length of 25 chars)

b_customerNamestring

Billing address customer name - Alphabet (Max length of 25 chars)

recursivePaymentIdstring

Customer unique recursive payment id (subscription id) (Numeric - Max length of 11 chars)

avsstring

Address verification service (zip, street address - Numeric length of one chars)

phonestring

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

emailstring

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

usernamestring

Customer user name (Alphanumeric length of 25 chars)

s_street_nostring

Shipping address street number - Number with hyphen (Ex: 1-95)

s_street_namestring

Shipping address street name - Alphanumeric (Length of 50 chars)

s_unitstring

Shipping address unit (Ex. block, apartment) - Max length of 25 chars

s_citystring

Shipping address city should be allowed max 50 chars of string (Ex: New York, San Francisco)

s_statestring

Shipping address state 2 chars of capital (Ex: New York - NY, California - CA)

s_zipstring

Shipping address zip code should be 5 digits (Numeric - Ex: 10001, 90002)

b_street_nostring

Billing address street number - Number with hyphen (Ex: 1-95)

b_street_namestring

Billing address street name - Alphanumeric (Length of 50 chars)

b_unitstring

Billing address unit (Ex. block, apartment) - Max length of 25 chars

b_citystring

Billing address city should be allowed max 50 chars of string (Ex: New York, San Francisco)

b_statestring

Billing address state 2 chars of capital (Ex: New York - NY, California - CA)

b_zipstring

Billing address zip code should be 5 digits (Numeric - Ex: 10001, 90002)

orderIdstring

Transaction order id for sale and auth (Length of max 11 chars)

invoicenumberstring

Invoice number is a unique number assigned (Alphanumeric - Max length of 12 chars)

dataset_idstring

Line item against created dataset id (Numeric -Max length of 20 chars, Ex: 364, 370 )

orderdescriptionstring

Add the order description - Optional (Alphanumeric - Max length of 50 chars)

validateCardstring

Validate the card default set as 1

useridstring

It is the userid of the merchant to be updated

uuidstring required

2FA request uuid (Max length of 50 chars)

otpstring required

Direct refund OTP (Ex: 500654, Max length of 6 chars)

otp_app_idstring required

Refund OTP API key

otp_api_keystring required

Refund OTP APP Id

tokenstring

Card token, received from sale or tokenization use it only

Response

200

error_nostring
error_codestring
amountstring
msgstring
descstring
{"stackTrail":"paths:/?refundapi: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": "100.00",
  "msg": "APPROVED",
  "desc": "  NO  MATCH     ",
  "epi": "2319914861",
  "channel": "VT",
  "rrn": "328911501243",
  "txnid": "5227750"
}