| Requires the role: | Admin |
| 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 .xml suffix or ?format=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>