API Reference

Update Subscription API

post
https://securelink-staging.valorpaytech.com:4430/?updateSub

Update the existing subscription to use a new payment method by providing either card information, vault payment details, or a token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
Defaults to h6tSvf0Cz7fSB86B44bkLEplS15AsWYo

Merchant APP ID (Alphanumeric - Length of 32 chars)

string
required
Defaults to zOKj0LUOiW4L9jFRrMbMiJQ5KxQEpSMm

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

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

string
required
Defaults to updateSubscription

Txn type should be set as 'updateSubscription'

int32
required
Defaults to 30763

Subscription id

double
required
Defaults to 100

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

double
required
Defaults to 2

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

double
Defaults to 2

Tax amount - Currency $ (Eg. 00.00)

payment_info
object
required

Payment method by providing either card information, vault payment details, or a token

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

string
required
Defaults to 2

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

string
required
Defaults to 1

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

string

Customer name for the quick book account

string
Defaults to Test

It should be 25 chars

string

Description of the product max 50 chars

string
Defaults to 1233

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

string

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

string

Subscription start payment date accepted expiry YYYYMMDD

string

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

string

Customer email id - Varchar (Ex: [email protected], Max length of 50 chars)

string
required
Defaults to 6

Months or Week based on recurring_type. If never expire to pass "never_expired"

string
required
Defaults to 25

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

string

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

string

Street name - Alphanumeric (Length of 50 chars)

string

Street name - Alphanumeric (Length of 50 chars)

string
Defaults to 206

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

string
Defaults to ASTORIA

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

string
Defaults to NY

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

string
Defaults to 11106

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

string

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

string

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

string

Street name - Alphanumeric (Length of 50 chars)

string

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

string

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

string

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

string

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

string
Defaults to 0

Failure Notification set as 0 or 1

additional_prompts
array of objects
additional_prompts
string

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

Responses

Updated 4 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago