| Requires the role: | Admin |
| POST | /recurringPayments/run-charge |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class RunRecurringChargeJobRequest
{
var dryRun:Boolean? = null
var asOf:Date? = null
}
open class RecurringChargeJobSummary
{
var masterEnabled:Boolean? = null
var autoSubmitEnabled:Boolean? = null
var dunningEnabled:Boolean? = null
var expireLapsedEnabled:Boolean? = null
var endOfTermRevokeEnabled:Boolean? = null
var chargeHour:Int? = null
var batchSize:Int? = null
var asOfUtc:Date? = null
var dryRun:Boolean? = null
var chargeLive:Boolean? = null
var dunningLive:Boolean? = null
var charged:Int? = null
var declined:Int? = null
var ambiguous:Int? = null
var skippedAlreadyCharged:Int? = null
var nullOwnerCharged:Int? = null
var skippedSinglePayment:Int? = null
var expiredCards:Int? = null
var endOfTermClosed:Int? = null
var endOfTermRevoked:Int? = null
var hardClosed:Int? = null
var cappedClosed:Int? = null
var expiredCardNotified:Int? = null
var checkFirst:Int? = null
var circuitBroken:Boolean? = null
var circuitBreakerCode:String? = null
var wouldCharge:Int? = null
var wouldStopHard:Int? = null
var wouldStopCapped:Int? = null
var wouldSms:Int? = null
var wouldEmail:Int? = null
var wouldClose:Int? = null
var wouldExpire:Int? = null
var wouldEndOfTermClose:Int? = null
var wouldEndOfTermRevoke:Int? = null
var smsSent:Int? = null
var emails:Int? = null
var closed:Int? = null
var log:ArrayList<String> = ArrayList<String>()
var statusCode:Int? = null
var message:String? = null
}
Kotlin 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>