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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;

namespace TicketUserServices.ServiceModel
{
    public partial class RecurringChargeJobSummary
    {
        public RecurringChargeJobSummary()
        {
            Log = new List<string>{};
        }

        public virtual bool MasterEnabled { get; set; }
        public virtual bool AutoSubmitEnabled { get; set; }
        public virtual bool DunningEnabled { get; set; }
        public virtual bool ExpireLapsedEnabled { get; set; }
        public virtual bool EndOfTermRevokeEnabled { get; set; }
        public virtual int ChargeHour { get; set; }
        public virtual int BatchSize { get; set; }
        public virtual DateTime AsOfUtc { get; set; }
        public virtual bool DryRun { get; set; }
        public virtual bool ChargeLive { get; set; }
        public virtual bool DunningLive { get; set; }
        public virtual int Charged { get; set; }
        public virtual int Declined { get; set; }
        public virtual int Ambiguous { get; set; }
        public virtual int SkippedAlreadyCharged { get; set; }
        public virtual int NullOwnerCharged { get; set; }
        public virtual int SkippedSinglePayment { get; set; }
        public virtual int ExpiredCards { get; set; }
        public virtual int EndOfTermClosed { get; set; }
        public virtual int EndOfTermRevoked { get; set; }
        public virtual int HardClosed { get; set; }
        public virtual int CappedClosed { get; set; }
        public virtual int ExpiredCardNotified { get; set; }
        public virtual int CheckFirst { get; set; }
        public virtual bool CircuitBroken { get; set; }
        public virtual string CircuitBreakerCode { get; set; }
        public virtual int WouldCharge { get; set; }
        public virtual int WouldStopHard { get; set; }
        public virtual int WouldStopCapped { get; set; }
        public virtual int WouldSms { get; set; }
        public virtual int WouldEmail { get; set; }
        public virtual int WouldClose { get; set; }
        public virtual int WouldExpire { get; set; }
        public virtual int WouldEndOfTermClose { get; set; }
        public virtual int WouldEndOfTermRevoke { get; set; }
        public virtual int SmsSent { get; set; }
        public virtual int Emails { get; set; }
        public virtual int Closed { get; set; }
        public virtual List<string> Log { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class RunRecurringChargeJobRequest
    {
        public virtual bool DryRun { get; set; }
        public virtual DateTime? AsOf { get; set; }
    }

}

C# RunRecurringChargeJobRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"dryRun":false,"asOf":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}