API Reference

Direct Sale / Auth

Direct sale with the card number

Log in to see full request history
Body Params
string
required
Defaults to h6tSvf0Cz7fSB86B44bkLEplS15AsWYo

Merchant APP ID (Alphanumeric - Length of 32 chars)

string
required
Defaults to zOKj0LUOiW4L9jFRrMbMiJQ5KxQEpSMm

Merchant APP Key (Alphanumeric - Length of 32 chars)

string
required
Defaults to 2412333540

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 sale

sale or auth ('sale' - Amount of the purchase will be deducted from the cardholder's bank account and 'auth' - it will be held (authorized) for a certain period of time/days)

double
required
Defaults to 5

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

string

Tax amount - Currency $ (Eg. 00.00)

string
required
Defaults to 4111111111111111

Customer card number 15 to 19 digits

date
required
Defaults to 1236

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

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

string
Defaults to Michael Jordan

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

string
Defaults to inv0001

Invoice number is a unique number assigned (Alphanumeric)

string
Defaults to king size bed 10x12

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

double
Defaults to 10.2

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

int32
required
Defaults to 0

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

int32

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

string
Defaults to 2 Jericho Plz

Shipping address should be max 100 chars - Alphanumeric

string

Billing address should be max 100 chars - Alphanumeric

string
Defaults to Jericho

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

string
Defaults to NY

State 2 chars of capital (Ex: New York - NY, California - CA)

string
required
Defaults to US

Shipping country should be mention default set us US

string
Defaults to US

Billing country should be mention default set us US

string
Defaults to 50001

Zip code should be 5 digits (Numeric - Ex: 10001, 90002)

string

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

string
Defaults to 0

Optional - This property is designed to control the sending of emails to customers, where a value of 0 indicates that the mail was not sent, and a value of 1 indicates that the mail will be sent.

string
Defaults to 1

Optional - This property is designed to control the sending of SMS to customers, where a value of 0 indicates that the SMS was not sent, and a value of 1 indicates that the SMS will be sent.

string
Defaults to 0

Optional - This property is designed to control the sending of emails to merchants, where a value of 0 indicates that the mail was not sent, and a value of 1 indicates that the mail will be sent.

productIds
array of objects
productIds
string
Defaults to 1576

Product discount id

string
Defaults to 0

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

Responses

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