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
import Foundation
import ServiceStack

public class RunRecurringChargeJobRequest : Codable
{
    public var dryRun:Bool?
    public var asOf:Date?

    required public init(){}
}

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

    required public init(){}
}


Swift RunRecurringChargeJobRequest DTOs

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"}