v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Add Subscription

post/?addSubs

Request body

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

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

surchargeAmountstring required

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

taxstring

Tax amount - Currency $ (Eg. 00.00)

txn_typestring required

Txn type should be add_subscription

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

recurring_typestring required

To accepts 0-Weekly or 1-Bi-Weekly, 2-Monthly, 3-Quarterly, 4-Annually, 5-Daily and 6- Run at

is_validate_cardstring required

Either 0 or 1 (1 - Card validation only (no charge). 0 - Immediate payment for the current billing cycle.

card_holder_namestring

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

descriptorstring

It should be 25 chars

product_descriptionstring

Description of the product max 50 chars

invoice_nostring

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

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

Failure Notification set as 0 or 1

retry_countstring
payment_typestring

For installment transactions, the payment type will be sent as 2

duplicate_transaction_checkinteger

If you want to check for duplicate transactions, set duplicate_transaction_check to 1 and is_validate_card to 0.

Response

200

object required