TicketUserServices

<back to all web services

RunRecurringChargeJobRequest

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
POST/recurringPayments/run-charge
RunRecurringChargeJobRequest Parameters:
NameParameterData TypeRequiredDescription
DryRunbodyboolNo
AsOfbodyDateTime?No
RecurringChargeJobSummary Parameters:
NameParameterData TypeRequiredDescription
MasterEnabledformboolNo
AutoSubmitEnabledformboolNo
DunningEnabledformboolNo
ExpireLapsedEnabledformboolNo
EndOfTermRevokeEnabledformboolNo
ChargeHourformintNo
BatchSizeformintNo
AsOfUtcformDateTimeNo
DryRunformboolNo
ChargeLiveformboolNo
DunningLiveformboolNo
ChargedformintNo
DeclinedformintNo
AmbiguousformintNo
SkippedAlreadyChargedformintNo
NullOwnerChargedformintNo
SkippedSinglePaymentformintNo
ExpiredCardsformintNo
EndOfTermClosedformintNo
EndOfTermRevokedformintNo
HardClosedformintNo
CappedClosedformintNo
ExpiredCardNotifiedformintNo
CheckFirstformintNo
CircuitBrokenformboolNo
CircuitBreakerCodeformstringNo
WouldChargeformintNo
WouldStopHardformintNo
WouldStopCappedformintNo
WouldSmsformintNo
WouldEmailformintNo
WouldCloseformintNo
WouldExpireformintNo
WouldEndOfTermCloseformintNo
WouldEndOfTermRevokeformintNo
SmsSentformintNo
EmailsformintNo
ClosedformintNo
LogformList<string>No
StatusCodeformintNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /recurringPayments/run-charge HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"dryRun":false,"asOf":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"masterEnabled":false,"autoSubmitEnabled":false,"dunningEnabled":false,"expireLapsedEnabled":false,"endOfTermRevokeEnabled":false,"chargeHour":0,"batchSize":0,"asOfUtc":"0001-01-01T00:00:00.0000000","dryRun":false,"chargeLive":false,"dunningLive":false,"charged":0,"declined":0,"ambiguous":0,"skippedAlreadyCharged":0,"nullOwnerCharged":0,"skippedSinglePayment":0,"expiredCards":0,"endOfTermClosed":0,"endOfTermRevoked":0,"hardClosed":0,"cappedClosed":0,"expiredCardNotified":0,"checkFirst":0,"circuitBroken":false,"circuitBreakerCode":"String","wouldCharge":0,"wouldStopHard":0,"wouldStopCapped":0,"wouldSms":0,"wouldEmail":0,"wouldClose":0,"wouldExpire":0,"wouldEndOfTermClose":0,"wouldEndOfTermRevoke":0,"smsSent":0,"emails":0,"closed":0,"log":["String"],"statusCode":0,"message":"String"}