| 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 .csv suffix or ?format=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"}