Hosted Page Sale (L2 & L3)

post

https://securelink-staging.valorpaytech.com:443/api/v1/sale?hostedl2

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Level 2: The PO Number is mandatory and must be included in the request.
Level 3: All Level 3–specific fields listed in the API description are mandatory and must be included in the request.

Body Params

appid

string

required

Defaults to h6tSvf0Cz7fSB86B44bkLEplS15AsWYo

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

appkey

string

required

Defaults to zOKj0LUOiW4L9jFRrMbMiJQ5KxQEpSMm

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

epi

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

amount

double

required

Defaults to 20

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

invoicenumber

string

Defaults to inv0001

Invoice number field must contain a maximum of 100 characters and may include only alphanumeric characters. < and > are not allowed.

orderdescription

string

Defaults to king size bed 10x12

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

surcharge

string

Defaults to 0

Additional surcharge fee amount to be applied to the transaction. Must be provided as a currency amount in USD (e.g., 10.00).

phone

string

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

string

Customer email id - Varchar 255 (Ex: [email protected])

tax

string

Defaults to 0

Tax amount to be applied to the transaction. Must be provided as a currency amount in USD (e.g., 10.00).

epage

int32

required

Defaults to 1

Should be set always 1

redirect_url

string

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

ignore_surcharge_calc

string

Defaults to 0

Set 0 to calculate tax and fees based on the merchant portal configuration, set 1 to calculate tax and fees from the request.

success_url

string

Specifies the URL to which the customer is redirected after a successful transaction.

failure_url

string

Specifies the URL to which the customer is redirected after a failed transaction.

shipping_country

string

required

Defaults to US

Shipping country should be mention default set us US

is_sync_qb

string

Defaults to 0

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

customer_name

string

Defaults to Test

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

never_expire

string

Defaults to 0

Set 1 to indicate that the payment or subscription will never expire, set 0 to allow it to expire.

active_on

date

Please ensure it is active and formatted as YYYY-MM-DD

lineItems

array of objects

lineItems

discount_id

string

Defaults to 1699

Unique identifier of the product discount.

qb_email_invoice

string

Defaults to 0

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

additional_prompts

array of objects

Custom inputs, with a maximum of 25 entries allowed.

additional_prompts

notification_status

string

Defaults to 0

Set 1 to send SMS and email notifications, set 0 to disable SMS and email notifications.

is_customer_info_avail

string

Set 1 to display customer details, such as email and phone, on the hosted page, set 0 to hide them.

po_number

string

required

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

customer_VAT

string

required

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

freight_amount

double

required

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

freight_tax_amount

double

required

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

ship_from_postal_code

string

required

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

VAT_invoice

string

required

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

duty_amount

string

required

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

amount_type

string

Defaults to 0

Pay Now amount type. Set to 1 for Flexible amount or 0 for Fixed amount.

invoice_mode

int32

Defaults to 0

Set 1 for Pay Now transactions that allow multiple payments before the UID expires. Set 0 for one-time E-Invoice payments.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400