API Reference

Sale API

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

Test Cards

CardTypePAN NumberExpiration DateCVV
Visa40120000987654391224999
MasterCard54997400000000571224998
MasterCard22230000484000111224998
Amex37144963539237612249997
Discover60110009930269091224996
Diners305515551516181224996
JCB35301420199458591224996
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

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

string
required
Defaults to 0200

Message type for 0200 is sale transaction request

string

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

double
required
Defaults to 11.11

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

int32
required
Defaults to 4111111111111111

Customer card number 15 to 19 digits

date
required
Defaults to 1224

Card expiry date, Accepted expiry MMYY & MM/YY (The expiration date must be exactly 4 characters long, consisting of a 2-digit month (with a leading zero if necessary) followed by a 2-digit year (e.g., "0526"))

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
Defaults to 0

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

double
Defaults to 0.44

Tax amount - Currency $ (Eg. 00.00)

double
Defaults to 0

Tax amount - Currency $ (Eg. 00.00)

double
Defaults to 0

City tax amount - Currency $ (Eg. 00.00)

double
Defaults to 0.02

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

int32
Defaults to 999

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

int32
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)

boolean
Defaults to false

Is recursive payment set as true or false (Boolean)

int32

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

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

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)

int32

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

int32

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

int32

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

int32

Customer user id - Numeric max length of 11 chars

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