API Reference

Refund API

post
https://vt-staging.valorpaytech.com:4430/?refundapi
Query Params
string
required
Defaults to WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw

Merchant APP ID (Alphanumeric - Length of 32 chars)

string
required
Defaults to 53PWdki5U0PGSVhRnVoFsfVSbuDutsA8

Merchant APP Key (Alphanumeric - Length of 32 chars)

string
required
Defaults to 2203082193

The unique id refers to a particular store of the merchant

string
required
Defaults to refund

Set the message type as 'refund'

double
required
Defaults to 100

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

string
required
Defaults to 4111111111111111

Customer card number 15 to 19 digits

string
required
Defaults to 1225

Card expiry date, Accepted expiry MMYY & MM/YY

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

double

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

double

Tax amount - Currency $ (Eg. 00.00)

double
Defaults to 0

City tax amount - Currency $ (Eg. 00.00)

double
Defaults to 0

Reduced tax amount - Currency $ (Eg. 00.00)

string

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

double

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

string
Defaults to 999

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

string
Defaults to 1

To identify the card type to check Credit or Debit

string
Defaults to 0

To remove the surcharge fee set value 0 else set 1

string

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

string

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

string

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

string

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

string
Defaults to 1

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

string

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

string

Customer email id - Varchar (Ex: [email protected], Max length of 50 chars)

string

Customer user name (Alphanumeric length of 25 chars)

string
Defaults to 2nd Avenue

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

string

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

string

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

string

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

string

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

string

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

string
Defaults to 123 Avenue

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string
Defaults to 0

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

string

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

string
Defaults to 0

Validate the card default set as 1

string

It is the userid of the merchant to be updated

string
required

2FA request uuid (Max length of 50 chars)

string
required

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

string
required
Defaults to WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw

Refund OTP API key

string
required
Defaults to 53PWdki5U0PGSVhRnVoFsfVSbuDutsA8

Refund OTP APP Id

string

Card token, received from sale or tokenization use it only

Responses

Updated 3 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago