v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Direct Sale API (L2/L3)

Direct sale with the card number. For AVS verification from the API, the fields sent should be based on the portal settings. If the setting is configured as “Address Only,” then only the address details should be sent in the address1 field. If the setting is configured as “ZIP Only,” then only the zip value should be sent in the zip property.

post/?directsalel2l3

Request body

appidstring required

Merchant APP ID (Alphanumeric - Length of 32 chars and special chars $@%#)

appkeystring required

Merchant APP KEY (Alphanumeric - Length of 32 chars and special chars $@%#)

epistring required

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

txn_typestring required

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)

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

tax_amountstring

Tax amount - Currency $ (Eg. 00.00)

cardnumberstring required

Customer card number 15 to 19 digits

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

cvvstring

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

cardholdernamestring

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

invoicenumberstring required

Invoicenumber is required if we pass order_details

orderdescriptionstring

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

surchargeAmountstring

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

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

phonestring

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

address1string

Address should be max 100 chars - Alphanumeric

addressstring

shipping_countrystring required

Shipping country should be mention default set us US

zipstring

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

emailstring

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

customer_namestring

Customer field must contain a maximum of 100 characters and may include only alphanumeric characters, #, and @.

po_numberstring required

The PO number must be provided to receive the Level 2 benefit (Alphanumeric Max 25 chars).

customer_VATstring required

The Customer VAT should be maximum 13-character alphanumeric value (Level 3 benefit).

freight_amountstring required

Freight amount - Currency $ (Eg. 00.00) (Level 3 benefit).

freight_tax_amountstring required

Freight tax amount - Currency $ (Eg. 00.00) (Level 3 benefit).

ship_from_postal_codestring required

The postal code should be maximum 10 numeric value (Level 3 benefit).

VAT_invoicestring required

The VAT invoice should be Maximum 15-character alphanumeric value (Level 3 benefit).

duty_amountstring required

Duty amount - Currency $ (Eg. 00.00) (Level 3 benefit).

duplicate_transaction_checkinteger

Either 0 or 1.

avsstring

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

Response

200

object required