Sale API

Query Params
string
Defaults to h6tSvf0Cz7fSB86B44bkLEplS15AsWYo

Merchant APP ID (Alphanumeric - Length of 32 chars)

string
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 0200

Message type for 0200 is sale and 0100 for auth transaction request

string

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

string
required
Defaults to 10.12

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

string
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

string
Defaults to 0

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

string
Defaults to 0

Tax amount - Currency $ (Eg. 00.00)

string
Defaults to 0

Tax amount - Currency $ (Eg. 00.00)

string
Defaults to 0

City tax amount - Currency $ (Eg. 00.00)

string
Defaults to 0.2

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

Is recursive payment set as true or false (Boolean)

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

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)

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

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

Customer user id - Numeric max length of 11 chars

Responses

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