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

export class RecurringChargeJobSummary
{
    public masterEnabled?: boolean;
    public autoSubmitEnabled?: boolean;
    public dunningEnabled?: boolean;
    public expireLapsedEnabled?: boolean;
    public endOfTermRevokeEnabled?: boolean;
    public chargeHour?: number;
    public batchSize?: number;
    public asOfUtc?: string;
    public dryRun?: boolean;
    public chargeLive?: boolean;
    public dunningLive?: boolean;
    public charged?: number;
    public declined?: number;
    public ambiguous?: number;
    public skippedAlreadyCharged?: number;
    public nullOwnerCharged?: number;
    public skippedSinglePayment?: number;
    public expiredCards?: number;
    public endOfTermClosed?: number;
    public endOfTermRevoked?: number;
    public hardClosed?: number;
    public cappedClosed?: number;
    public expiredCardNotified?: number;
    public checkFirst?: number;
    public circuitBroken?: boolean;
    public circuitBreakerCode?: string;
    public wouldCharge?: number;
    public wouldStopHard?: number;
    public wouldStopCapped?: number;
    public wouldSms?: number;
    public wouldEmail?: number;
    public wouldClose?: number;
    public wouldExpire?: number;
    public wouldEndOfTermClose?: number;
    public wouldEndOfTermRevoke?: number;
    public smsSent?: number;
    public emails?: number;
    public closed?: number;
    public log?: string[];
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<RecurringChargeJobSummary>) { (Object as any).assign(this, init); }
}

export class RunRecurringChargeJobRequest
{
    public dryRun?: boolean;
    public asOf?: string;

    public constructor(init?: Partial<RunRecurringChargeJobRequest>) { (Object as any).assign(this, init); }
}

TypeScript RunRecurringChargeJobRequest DTOs

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>