TicketUserServices

RunRecurringChargeJobRequest

**Requires Authentication**
Requires the role:	Admin

The following routes are available for this service:
POST	/recurringPayments/run-charge

**RunRecurringChargeJobRequest** Parameters:
Name	Parameter	Data Type	Required	Description
DryRun	body	bool	No
AsOf	body	DateTime?	No

**RecurringChargeJobSummary** Parameters:
Name	Parameter	Data Type	Required
MasterEnabled	form	bool	No
AutoSubmitEnabled	form	bool	No
DunningEnabled	form	bool	No
ExpireLapsedEnabled	form	bool	No
EndOfTermRevokeEnabled	form	bool	No
ChargeHour	form	int	No
BatchSize	form	int	No
AsOfUtc	form	DateTime	No
DryRun	form	bool	No
ChargeLive	form	bool	No
DunningLive	form	bool	No
Charged	form	int	No
Declined	form	int	No
Ambiguous	form	int	No
SkippedAlreadyCharged	form	int	No
NullOwnerCharged	form	int	No
SkippedSinglePayment	form	int	No
ExpiredCards	form	int	No
EndOfTermClosed	form	int	No
EndOfTermRevoked	form	int	No
HardClosed	form	int	No
CappedClosed	form	int	No
ExpiredCardNotified	form	int	No
CheckFirst	form	int	No
CircuitBroken	form	bool	No
CircuitBreakerCode	form	string	No
WouldCharge	form	int	No
WouldStopHard	form	int	No
WouldStopCapped	form	int	No
WouldSms	form	int	No
WouldEmail	form	int	No
WouldClose	form	int	No
WouldExpire	form	int	No
WouldEndOfTermClose	form	int	No
WouldEndOfTermRevoke	form	int	No
SmsSent	form	int	No
Emails	form	int	No
Closed	form	int	No
Log	form	List<string>	No
StatusCode	form	int	No
Message	form	string	No

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<RunRecurringChargeJobRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AsOf>0001-01-01T00:00:00</AsOf>
  <DryRun>false</DryRun>
</RunRecurringChargeJobRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecurringChargeJobSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Ambiguous>0</Ambiguous>
  <AsOfUtc>0001-01-01T00:00:00</AsOfUtc>
  <AutoSubmitEnabled>false</AutoSubmitEnabled>
  <BatchSize>0</BatchSize>
  <CappedClosed>0</CappedClosed>
  <ChargeHour>0</ChargeHour>
  <ChargeLive>false</ChargeLive>
  <Charged>0</Charged>
  <CheckFirst>0</CheckFirst>
  <CircuitBreakerCode>String</CircuitBreakerCode>
  <CircuitBroken>false</CircuitBroken>
  <Closed>0</Closed>
  <Declined>0</Declined>
  <DryRun>false</DryRun>
  <DunningEnabled>false</DunningEnabled>
  <DunningLive>false</DunningLive>
  <Emails>0</Emails>
  <EndOfTermClosed>0</EndOfTermClosed>
  <EndOfTermRevokeEnabled>false</EndOfTermRevokeEnabled>
  <EndOfTermRevoked>0</EndOfTermRevoked>
  <ExpireLapsedEnabled>false</ExpireLapsedEnabled>
  <ExpiredCardNotified>0</ExpiredCardNotified>
  <ExpiredCards>0</ExpiredCards>
  <HardClosed>0</HardClosed>
  <Log xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Log>
  <MasterEnabled>false</MasterEnabled>
  <Message>String</Message>
  <NullOwnerCharged>0</NullOwnerCharged>
  <SkippedAlreadyCharged>0</SkippedAlreadyCharged>
  <SkippedSinglePayment>0</SkippedSinglePayment>
  <SmsSent>0</SmsSent>
  <StatusCode>0</StatusCode>
  <WouldCharge>0</WouldCharge>
  <WouldClose>0</WouldClose>
  <WouldEmail>0</WouldEmail>
  <WouldEndOfTermClose>0</WouldEndOfTermClose>
  <WouldEndOfTermRevoke>0</WouldEndOfTermRevoke>
  <WouldExpire>0</WouldExpire>
  <WouldSms>0</WouldSms>
  <WouldStopCapped>0</WouldStopCapped>
  <WouldStopHard>0</WouldStopHard>
</RecurringChargeJobSummary>