Refund API

post https://vt-staging.valorpaytech.com:4430?/refundapi?direct

Query Params

app_id

string

required

Defaults to WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw

Merchant APP ID (Alphanumeric - Length of 32 chars)

auth_key

string

required

Defaults to 53PWdki5U0PGSVhRnVoFsfVSbuDutsA8

Merchant APP Key (Alphanumeric - Length of 32 chars)

epi

string

required

Defaults to 2203082193

The unique id refers to a particular store of the merchant

mtype

string

required

Defaults to refund

Set the message type as 'refund'

amount

double

required

Defaults to 100

Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99)

pan

string

required

Defaults to 4111111111111111

Customer card number 15 to 19 digits

expiry_date

string

required

Defaults to 1225

Card expiry date, Accepted expiry MMYY & MM/YY

surchargeIndicator

int32

required

Defaults to 1

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_amount

double

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

tax

double

Tax amount - Currency $ (Eg. 00.00)

city_tax

double

Defaults to 0

City tax amount - Currency $ (Eg. 00.00)

reduced_tax

double

Defaults to 0

Reduced tax amount - Currency $ (Eg. 00.00)

uid

string

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

custom_fee

double

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

cvv

string

Defaults to 999

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

binType

string

Defaults to 1

To identify the card type to check Credit or Debit

surchargeRemoved

string

Defaults to 0

To remove the surcharge fee set value 0 else set 1

card_holder_name

string

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

s_customerName

string

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

b_customerName

string

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

recursivePaymentId

string

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

avs

string

Defaults to 1

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

phone

string

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

string

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

username

string

Customer user name (Alphanumeric length of 25 chars)

s_street_no

string

Defaults to 2nd Avenue

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

s_street_name

string

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

s_unit

string

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

s_city

string

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

s_state

string

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

s_zip

string

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

b_street_no

string

Defaults to 123 Avenue

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

b_street_name

string

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

b_unit

string

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

b_city

string

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

b_state

string

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

b_zip

string

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

orderId

string

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

invoicenumber

string

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

dataset_id

string

Defaults to 0

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

orderdescription

string

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

validateCard

string

Defaults to 0

Validate the card default set as 1

userid

string

It is the userid of the merchant to be updated

uuid

string

required

2FA request uuid (Max length of 50 chars)

otp

string

required

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

otp_app_id

string

required

Defaults to WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw

Refund OTP API key

otp_api_key

string

required

Defaults to 53PWdki5U0PGSVhRnVoFsfVSbuDutsA8

Refund OTP APP Id

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://vt-staging.valorpaytech.com:4430/?app_id=WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw&auth_key=53PWdki5U0PGSVhRnVoFsfVSbuDutsA8&epi=2203082193&mtype=refund&amount=100&pan=4111111111111111&expiry_date=1225&surchargeIndicator=1&city_tax=0&reduced_tax=0&cvv=999&binType=1&surchargeRemoved=0&avs=1&s_street_no=2nd%20Avenue&b_street_no=123%20Avenue&dataset_id=0&validateCard=0&otp_app_id=WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw&otp_api_key=53PWdki5U0PGSVhRnVoFsfVSbuDutsA8&/refundapi?direct=' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400