| Requires any of the roles: | Admin, TeamAdmin |
| POST | /recurringPayments |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PhoneVerificationNumber | body | string | No | |
| Token | body | string | No | |
| PanLastFour | body | string | No | |
| ExpYear | body | string | No | |
| ExpMonth | body | string | No | |
| DeviceId | body | string | No | |
| MonthlyPrice | body | int | No | |
| SubscriptionLength | body | int | No | |
| ChargeFirstMonth | body | bool | No | |
| OwnerId | body | int? | No | |
| OwnerCardTypeId | body | int? | No | |
| PaymentTokenId | body | string | No | |
| TransactionFee | body | decimal? | No | |
| Currency | body | string | No | |
| Mode | body | string | No | |
| StartDate | body | DateTime? | No | |
| LastPayment | body | DateTime? | No | |
| NextPayment | body | DateTime? | No | |
| JsonResponse | body | string | No | |
| TermsVersion | body | string | No | |
| TermsAcceptedAt | body | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Item | form | RecurringPayment | No | |
| AlreadyExisted | form | bool | No | |
| StatusCode | form | int | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Status | form | string | No | |
| PhoneVerificationNumber | form | string | No | |
| DeviceId | form | string | No | |
| PanLastFour | form | string | No | |
| ExpYear | form | string | No | |
| ExpMonth | form | string | No | |
| Token | form | string | No | |
| MonthlyPrice | form | int | No | |
| SubscriptionLength | form | int | No | |
| MonthsPaid | form | int | No | |
| ChargeFirstMonth | form | bool | No | |
| OwnerId | form | int? | No | |
| OwnerCardTypeId | form | int? | No | |
| JsonResponse | form | string | No | |
| StartDate | form | DateTime? | No | |
| LastPayment | form | DateTime? | No | |
| NextPayment | form | DateTime? | No | |
| PaymentTokenId | form | string | No | |
| DeclinedCounter | form | int | No | |
| TransactionFee | form | decimal? | No | |
| TermsVersion | form | string | No | |
| TermsAcceptedAt | form | DateTime? | No | |
| Currency | form | string | No | |
| Mode | form | string | No | |
| LastDeclineReason | form | string | No | |
| LastDeclineDate | form | DateTime? | No | |
| LastDunningStage | form | byte | No | |
| LastDunningNotifiedAt | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /recurringPayments HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
phoneVerificationNumber: String,
token: String,
panLastFour: String,
expYear: String,
expMonth: String,
deviceId: String,
monthlyPrice: 0,
subscriptionLength: 0,
chargeFirstMonth: False,
ownerId: 0,
ownerCardTypeId: 0,
paymentTokenId: String,
transactionFee: 0,
currency: String,
mode: String,
startDate: 0001-01-01,
lastPayment: 0001-01-01,
nextPayment: 0001-01-01,
jsonResponse: String,
termsVersion: String,
termsAcceptedAt: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
item:
{
id: 0,
status: String,
phoneVerificationNumber: String,
deviceId: String,
panLastFour: String,
expYear: String,
expMonth: String,
token: String,
monthlyPrice: 0,
subscriptionLength: 0,
monthsPaid: 0,
chargeFirstMonth: False,
ownerId: 0,
ownerCardTypeId: 0,
jsonResponse: String,
startDate: 0001-01-01,
lastPayment: 0001-01-01,
nextPayment: 0001-01-01,
paymentTokenId: String,
declinedCounter: 0,
transactionFee: 0,
termsVersion: String,
termsAcceptedAt: 0001-01-01,
currency: String,
mode: String,
lastDeclineReason: String,
lastDeclineDate: 0001-01-01,
lastDunningStage: 0,
lastDunningNotifiedAt: 0001-01-01
},
alreadyExisted: False,
statusCode: 0,
message: String
}