v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Sale API

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/?sale (COPY)

Request body

appidstring required

Merchant APP ID (Alphanumeric - Length of 32 chars)

appkeystring required

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

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)

tokenstring required

Card token can be generated from <a href="https://valorapi.readme.io/reference/create-card-token" target="_blank"><b>Create Card Token</b></a>

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

ecomm_channelstring

cardholdernamestring

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

invoicenumberstring

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

orderdescriptionstring

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

surchargeAmountnumber double

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

surchargeIndicatorinteger

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

phoneinteger

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

address1string

Shipping address should be max 100 chars - Alphanumeric

addressstring

Billing address should be max 100 chars - Alphanumeric

shipping_countrystring required

Shipping country should be mention default set us US

billing_countrystring

Billing country should be mention default set us US

zipstring

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

avsstring

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

emailstring

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

tax_amountstring

Tax amount - Currency $ (Eg. 00.00)

po_numberstring

The PO number must be provided to receive the Level 2 benefit.

customer_VATstring

Maximum 13-character alphanumeric value.

freight_amountnumber double

freight_tax_amountnumber double

ship_from_postal_codestring

Maximum 10 numeric value

VAT_invoicestring

Maximum 15-character alphanumeric value.

duty_amountnumber double

Response

200

error_nostring

error_codestring

amountstring

taxstring

customfeestring

msgstring

descstring

{"stackTrail":"paths:/?sale (COPY):post:responses:200:content:application/json:schema:properties:additional_info","oasType":"schema","type":"unknown"}

approval_codestring

rrnstring

txnidstring

tran_nointeger

staninteger

is_partial_approveinteger

partial_amountstring

panstring

{"stackTrail":"paths:/?sale (COPY):post:responses:200:content:application/json:schema:properties:card_type","oasType":"schema","type":"unknown"}

phone_numberstring

email_idstring

{"stackTrail":"paths:/?sale (COPY):post:responses:200:content:application/json:schema:properties:zip","oasType":"schema","type":"unknown"}

card_holder_namestring

expiry_datestring

addressstring

epistring

channelstring

tokenstring

card_brandstring

Example response

{
  "error_no": "S00",
  "error_code": "00",
  "amount": "5.00",
  "customfee": "10.2",
  "msg": "APPROVED",
  "desc": "APPROVAL 111111 ",
  "approval_code": "111111",
  "rrn": "328307751863",
  "txnid": "5202283",
  "tran_no": 2,
  "stan": 341,
  "partial_amount": "000000000500",
  "pan": "XXXX1111",
  "phone_number": "5426987845",
  "email_id": "jhonsmith@valorpaytech.com",
  "card_holder_name": "Michael Jordan",
  "expiry_date": "12/36",
  "epi": "2203082193",
  "channel": "ECOMM",
  "token": "CADB9B5C7F1C082774EED86F4E57D31C00FAE774",
  "card_brand": "Visa"
}