v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Sale API

post/?sale

Query parameters

app_idstring

Merchant APP ID (Alphanumeric - Length of 32 chars)

auth_keystring

Merchant APP Key (Alphanumeric - Length of 32 chars)

epistring required

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

mtypestring required

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

uidstring

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

amountstring required

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

panstring required

Customer card number 15 to 19 digits

expiry_datestring required

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

surchargeIndicatorstring required

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_amountstring

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

taxstring

Tax amount - Currency $ (Eg. 00.00)

city_taxstring

Tax amount - Currency $ (Eg. 00.00)

reduced_taxstring

City tax amount - Currency $ (Eg. 00.00)

custom_feestring

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

cvvstring

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

surchargeRemovedstring

To remove the surcharge fee set value 0 else set 1

card_holder_namestring

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

s_customerNamestring

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

b_customerNamestring

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

recursivePaymentIdstring

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

avsstring

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

recursivePaymentboolean

Is recursive payment set as true or false (Boolean)

phonestring

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

emailstring

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

usernamestring

Customer user name (Alphanumeric length of 25 chars)

s_street_nostring

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

s_street_namestring

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

s_unitstring

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

s_citystring

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

s_statestring

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

s_zipstring

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

b_street_nostring

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

b_street_namestring

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

b_unitstring

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

b_citystring

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

b_statestring

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

b_zipstring

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

orderIdstring

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

invoicenumberstring

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

dataset_idstring

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

orderdescriptionstring

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

validateCardstring

Validate the card default set as 1

useridstring

Customer user id - Numeric max length of 11 chars

Response

200

object required