POST api/recurring/subscribe?api-version=2.0

Step 1: Creates a new subscription per Msisdn

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PartnerId	integer	Required Range: inclusive between 1 and 2147483647
Msisdn	string	Required String length: inclusive between 1 and 20
Currency	string	Required String length: inclusive between 0 and 3
OrderNumber	string	String length: inclusive between 0 and 50
Amount	decimal number	Required Matching regular expression pattern: ^\d+(.\d{1,2})?$ Range: inclusive between 0 and 999999.99
CampaignAmount	decimal number	Matching regular expression pattern: ^\d+(.\d{1,2})?$ Range: inclusive between 0 and 999999.99
PaymentProvider	string	Required
Description	string	Required String length: inclusive between 0 and 2000
Basis	integer	Required
MemberId	string	None.
AgreementUrl	string	Required
Name	string	Required
StatusCallbackUrl	string	String length: inclusive between 0 and 2000
ConfirmSubscriptionCallbackUrl	string	String length: inclusive between 0 and 2000
SendSMS	boolean	None.
SmsText	string	None.
SmsNotificationOriginator	string	None.

Request Formats

application/json, text/json

Sample:

{
  "partnerId": 1,
  "msisdn": "sample string 2",
  "currency": "sample string 3",
  "orderNumber": "sample string 4",
  "amount": 5.0,
  "campaignAmount": 1.0,
  "paymentProvider": "sample string 6",
  "description": "sample string 7",
  "basis": 8,
  "memberId": "sample string 9",
  "agreementUrl": "sample string 10",
  "name": "sample string 11",
  "statusCallbackUrl": "sample string 12",
  "confirmSubscriptionCallbackUrl": "sample string 13",
  "sendSMS": true,
  "smsText": "sample string 15",
  "smsNotificationOriginator": "sample string 16"
}

Response Information

Resource Description

PaymentSetupV2

Name	Description	Type	Additional information
method	Http method.	string	None.
url	Form url destination.	string	None.
fields	From fields.	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "method": "sample string 1",
  "url": "sample string 2",
  "fields": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}