v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

QR Code API

post/?qrCode

Request body

appidstring

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

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)

invoicenumberstring

Invoice number is a unique number assigned (Alphanumeric varchar)

orderdescriptionstring

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

surchargestring

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

phonestring

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

emailstring

Customer email id - Varchar 255 (Ex: test@domain.com)

taxstring

Tax amount - Currency $ (Eg. 00.00)

epagestring required

Should be set always 1

redirect_urlstring

Merchants call back url - It will be redirected to payment page

ignore_surcharge_calcstring

Set value 0 (Fee will be calculate from merchant portal)

success_urlstring

For this flag successful transaction, page redirect to success page

failure_urlstring

For this flag failed transaction, page redirect to failed page

shipping_countrystring

Shipping country should be mention default set us US

is_sync_qbstring

If the transaction can be sent to the QB account, set the value to 1; otherwise, set it to 0.

customer_namestring required

Customer name for the quick book account

is_qrcodestring required

Set the value to 1 to generate the QR code

never_expirestring

If the never expire to set as 0 or 1

active_onstring date

discount_idstring

qb_email_invoicestring

Set to 1 if the QuickBooks invoice email is sent, otherwise set to 0.

Response

200

error_nostring

qr_code_urlstring

uidstring

Example response

{
  "error_no": "S00",
  "qr_code_url": "https://qr-staging.valorpaytech.com/qr_codes/qr_obRvq7XjehpWBKfunsPZ9LHZzSXP3Rg6.png",
  "uid": "obRvq7XjehpWBKfunsPZ9LHZzSXP3Rg6"
}