v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

List Subscription API

post/?listsubsc

Query parameters

app_idstring required

Merchant APP ID (Alphanumeric - Length of 32 chars)

auth_keystring required

Merchant APP Key (Alphanumeric - Length of 32 chars)

subscription_idstring required

Subscription id (length of max 11 chars)

mtypestring required

Message type should be set as 'listsubscription'

epistring required

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

activestring

Activate status for either true or false

start_datestring

Subscription start date accepted expiry MM/DD/YY

Response

200

error_nostring
error_codestring

Example response

{
  "records": [
    {
      "subscription_id": "11738",
      "amount": "200",
      "custom_fee": "3.5000",
      "tax": "5.0300",
      "shipping_customer_name": "bevin",
      "shipping_street_no": "2nd Avenue",
      "shipping_street_name": "Newland",
      "shipping_unit": "2",
      "shipping_zipcode": "50001",
      "billing_customerName": "bevin",
      "billing_street_no": "2nd Avenue",
      "billing_street_name": "Newland",
      "billing_unit": "2",
      "billing_zipcode": "50001",
      "subscription_day_of_the_month": "20",
      "subscription_starts_from": "2023-10-03",
      "subscription_valid_for": "6",
      "no_of_failed_attempts": "0",
      "status": "1",
      "card_number": "XXXX1111",
      "total_no_of_payments": "0",
      "forfeit": "0"
    }
  ],
  "error_no": "S00",
  "error_code": "00"
}