Add Subscription API

post https://vt-staging.valorpaytech.com:4430?/?addSubs

Query Params

app_id

string

required

Defaults to WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw

Merchant APP ID (Alphanumeric - Length of 32 chars)

auth_key

string

required

Defaults to 53PWdki5U0PGSVhRnVoFsfVSbuDutsA8

Merchant APP Key (Alphanumeric - Length of 32 chars)

amount

double

required

Defaults to 100

Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99)

custom_fee

double

required

Defaults to 3

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

tax

string

Defaults to 3.50

Tax amount - Currency $ (Eg. 00.00)

cvv

string

Defaults to 999

Card Verification Value should be 3 or 4 digits (Ex: 999, 9997)

mtype

string

required

Defaults to add_subscription

Message type should be set as 'add_subscription'

epi

string

required

Defaults to 2203082193

EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2

pan

string

required

Defaults to 4111111111111111

Customer card number 15 to 19 digits

expiry_date

string

required

Defaults to 0225

Card expiry date, Accepted expiry MMYY & MM/YY

surchargeIndicator

string

required

Defaults to 1

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_type

string

required

Defaults to 2

To accepts 0-Weekley or 1-Bi-Weekly or 2-Monthly

is_validate_card

string

required

Defaults to 1

Either 0 or 1

card_holder_name

string

Defaults to John Doe

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

descriptor

string

Defaults to TEST DESCRIPTOR

It should be 25 chars

product_description

string

Defaults to Product 1

Description of the product max 50 chars

invoice_no

string

Defaults to 12345678

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

shipping_street_no

string

Defaults to 3636

Street number - Number with hyphen (Ex: 1-95)

shipping_street_name

string

Defaults to 33rd street

Street name - Alphanumeric (Length of 50 chars)

shipping_customer_name

string

Defaults to John Doe

Shipping customer name - Alphabet (Max length of 25 chars)

shipping_unit

string

Defaults to 206

Street unit (Ex. block, apartment) - Max length of 25 chars

shipping_zip

string

Defaults to 11106

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

shipping_city

string

Defaults to ASTORIA

City should be allowed max 50 chars of string (Ex: New York, San Francisco)

billing_customer_name

string

Defaults to John Doe

Customer Name - Alphabet (Max length of max 25 chars)

shipping_state

string

Defaults to NY

State 2 chars of capital (Ex: New York - NY, California - CA)

billing_street_no

string

Defaults to 3636

Street number - Number with hyphen (Ex: 1-95)

billing_unit

string

Defaults to 206

Street unit (Ex. block, apartment) - Max length of 25 chars

billing_street_name

string

Defaults to 33rd street

Street name - Alphanumeric (Length of 50 chars)

billing_zip

string

Defaults to 11106

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

billing_city

string

Defaults to ASTORIA

City should be allowed max 50 chars of string (Ex: New York, San Francisco)

billing_state

string

Defaults to NY

State 2 chars of capital (Ex: New York - NY, California - CA)

subscription_starts_from

string

required

Defaults to 2024-08-23

Subscription start payment date accepted expiry YYYYMMDD

phone

string

Defaults to 5478964785

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

string

Defaults to jhonsmith@valorpaytech.com

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

charge_until

string

Defaults to 6

Months or Week based on recurring_type

charge_on

string

Defaults to 25

If recurring type 0-Weekley or 1-Bi-Weekly this should be any value from 0 to 6 else if recurring type 2-Monthly it accept any value from 1 to 30 Days in month

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://vt-staging.valorpaytech.com:4430/?app_id=WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw&auth_key=53PWdki5U0PGSVhRnVoFsfVSbuDutsA8&amount=100&custom_fee=3&tax=3.50&cvv=999&mtype=add_subscription&epi=2203082193&pan=4111111111111111&expiry_date=0225&surchargeIndicator=1&recurring_type=2&is_validate_card=1&card_holder_name=John%20Doe&descriptor=TEST%20DESCRIPTOR&product_description=Product%201&invoice_no=12345678&shipping_street_no=3636&shipping_street_name=33rd%20street&shipping_customer_name=John%20Doe&shipping_unit=206&shipping_zip=11106&shipping_city=ASTORIA&billing_customer_name=John%20Doe&shipping_state=NY&billing_street_no=3636&billing_unit=206&billing_street_name=33rd%20street&billing_zip=11106&billing_city=ASTORIA&billing_state=NY&subscription_starts_from=2024-08-23&phone=5478964785&email=jhonsmith%40valorpaytech.com&charge_until=6&charge_on=25&/?addSubs=' \
3
     --header 'accept: application/json'

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

application/json

200200

400400