appidstring required
Merchant APP ID (Alphanumeric - Length of 32 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
subscription_idstring required
Unique identifier of the subscription.
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
custom_feestring required
Additional surcharge fee amount to be applied to the transaction. Must be provided as a currency amount in USD (e.g., 10.00).
taxstring
Tax amount to be applied to the transaction. Must be provided as a currency amount in USD (e.g., 10.00).
surchargeIndicatorstring required
Set 0 for transactions processed through a traditional MID with no custom fee. Set 1 for transactions processed through a cash discounting MID with a custom fee.
recurring_typestring required
Set the recurring type. <table> <tbody> <tr> <th>Recurring Type</th> <th>Options</th> </tr> <tr> <td>Weekly</td> <td>0</td> </tr> <tr> <td>Bi-Weekly</td> <td>1</td> </tr> <tr> <td>Monthly</td> <td>2</td> </tr> <tr> <td>Quarterly</td> <td>3</td> </tr> <tr> <td>Annually</td> <td>4</td> </tr> <tr> <td>Daily</td> <td>5</td> </tr> <tr> <td>Run at</td> <td>6</td> </tr> </tbody> </table>
is_validate_cardstring required
Set 1 for card validation only without charging. Set 0 to process the payment for the current billing cycle.
card_holder_namestring
Name of the cardholder. Must contain alphabetic characters only and have a maximum length of 25 characters.
descriptorstring
The descriptor must not exceed 25 characters.
product_descriptionstring
Description of the product max 50 chars
invoice_nostring
Invoice number field must contain a maximum of 12 characters and may include only alphanumeric characters. < and > are not allowed.
customer_namestring
Customer field must contain a maximum of 100 characters and may include only alphanumeric characters, #, and @.
shipping_street_nostring
Street number - Number with hyphen (Ex: 1-95)
shipping_street_namestring
Street name - Alphanumeric (Length of 50 chars)
shipping_customer_namestring required
Shipping customer name - Alphabet (Max length of 25 chars)
shipping_unitstring
Street unit (Ex. block, apartment) - Max length of 25 chars
shipping_zipstring required
Zip code should be 5 digits (Numeric - Ex: 10001, 90002)
shipping_citystring
City should be allowed max 50 chars of string (Ex: New York, San Francisco)
billing_customer_namestring required
Customer Name - Alphabet (Max length of max 25 chars)
shipping_statestring
State 2 chars of capital (Ex: New York - NY, California - CA)
billing_street_nostring
Street number - Number with hyphen (Ex: 1-95)
billing_unitstring
Street unit (Ex. block, apartment) - Max length of 25 chars
billing_street_namestring
Street name - Alphanumeric (Length of 50 chars)
billing_zipstring required
Zip code should be 5 digits (Numeric - Ex: 10001, 90002)
billing_citystring
City should be allowed max 50 chars of string (Ex: New York, San Francisco)
billing_statestring
State 2 chars of capital (Ex: New York - NY, California - CA)
subscription_starts_fromstring required
Subscription start payment date accepted expiry YYYYMMDD
phonestring
Customer phone number- 10 digit Numeric (Ex: 5247896523)
emailstring
Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)
charge_untilstring required
Months or Week based on recurring_type. If never expire to pass "never_expired"
charge_onstring required
If recurring type 0-Weekly or 1-Bi-Weekly this should be any value from 0 to 6 else if recurring type 2, 3, 4, 5, 6 it accept any value from 1 to 30 Days in month
failure_notificationstring
Set 1 to enable failure notifications. Set 0 to disable failure notifications.
retry_countstring
Specifies the maximum number of retry attempts for recurring payments that fail due to insufficient funds, with a maximum value of 10. If set to 2, the payment will be retried on the next day and the following day.
payment_typestring
For installment transactions, the payment type will be sent as 2
duplicate_transaction_checkinteger
Set to 1 to enable duplicate transaction checking based on the portal setting. Set to 0 to disable it. For example, By Invoice Number declines transactions with the same invoice number in the same batch.