| Requires the role: | Admin |
| POST | /recurringPayments/run-charge |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class RunRecurringChargeJobRequest
{
public Boolean dryRun = null;
public Date asOf = null;
public Boolean isDryRun() { return dryRun; }
public RunRecurringChargeJobRequest setDryRun(Boolean value) { this.dryRun = value; return this; }
public Date getAsOf() { return asOf; }
public RunRecurringChargeJobRequest setAsOf(Date value) { this.asOf = value; return this; }
}
public static class RecurringChargeJobSummary
{
public Boolean masterEnabled = null;
public Boolean autoSubmitEnabled = null;
public Boolean dunningEnabled = null;
public Boolean expireLapsedEnabled = null;
public Boolean endOfTermRevokeEnabled = null;
public Integer chargeHour = null;
public Integer batchSize = null;
public Date asOfUtc = null;
public Boolean dryRun = null;
public Boolean chargeLive = null;
public Boolean dunningLive = null;
public Integer charged = null;
public Integer declined = null;
public Integer ambiguous = null;
public Integer skippedAlreadyCharged = null;
public Integer nullOwnerCharged = null;
public Integer skippedSinglePayment = null;
public Integer expiredCards = null;
public Integer endOfTermClosed = null;
public Integer endOfTermRevoked = null;
public Integer hardClosed = null;
public Integer cappedClosed = null;
public Integer expiredCardNotified = null;
public Integer checkFirst = null;
public Boolean circuitBroken = null;
public String circuitBreakerCode = null;
public Integer wouldCharge = null;
public Integer wouldStopHard = null;
public Integer wouldStopCapped = null;
public Integer wouldSms = null;
public Integer wouldEmail = null;
public Integer wouldClose = null;
public Integer wouldExpire = null;
public Integer wouldEndOfTermClose = null;
public Integer wouldEndOfTermRevoke = null;
public Integer smsSent = null;
public Integer emails = null;
public Integer closed = null;
public ArrayList<String> log = null;
public Integer statusCode = null;
public String message = null;
public Boolean isMasterEnabled() { return masterEnabled; }
public RecurringChargeJobSummary setMasterEnabled(Boolean value) { this.masterEnabled = value; return this; }
public Boolean isAutoSubmitEnabled() { return autoSubmitEnabled; }
public RecurringChargeJobSummary setAutoSubmitEnabled(Boolean value) { this.autoSubmitEnabled = value; return this; }
public Boolean isDunningEnabled() { return dunningEnabled; }
public RecurringChargeJobSummary setDunningEnabled(Boolean value) { this.dunningEnabled = value; return this; }
public Boolean isExpireLapsedEnabled() { return expireLapsedEnabled; }
public RecurringChargeJobSummary setExpireLapsedEnabled(Boolean value) { this.expireLapsedEnabled = value; return this; }
public Boolean isEndOfTermRevokeEnabled() { return endOfTermRevokeEnabled; }
public RecurringChargeJobSummary setEndOfTermRevokeEnabled(Boolean value) { this.endOfTermRevokeEnabled = value; return this; }
public Integer getChargeHour() { return chargeHour; }
public RecurringChargeJobSummary setChargeHour(Integer value) { this.chargeHour = value; return this; }
public Integer getBatchSize() { return batchSize; }
public RecurringChargeJobSummary setBatchSize(Integer value) { this.batchSize = value; return this; }
public Date getAsOfUtc() { return asOfUtc; }
public RecurringChargeJobSummary setAsOfUtc(Date value) { this.asOfUtc = value; return this; }
public Boolean isDryRun() { return dryRun; }
public RecurringChargeJobSummary setDryRun(Boolean value) { this.dryRun = value; return this; }
public Boolean isChargeLive() { return chargeLive; }
public RecurringChargeJobSummary setChargeLive(Boolean value) { this.chargeLive = value; return this; }
public Boolean isDunningLive() { return dunningLive; }
public RecurringChargeJobSummary setDunningLive(Boolean value) { this.dunningLive = value; return this; }
public Integer getCharged() { return charged; }
public RecurringChargeJobSummary setCharged(Integer value) { this.charged = value; return this; }
public Integer getDeclined() { return declined; }
public RecurringChargeJobSummary setDeclined(Integer value) { this.declined = value; return this; }
public Integer getAmbiguous() { return ambiguous; }
public RecurringChargeJobSummary setAmbiguous(Integer value) { this.ambiguous = value; return this; }
public Integer getSkippedAlreadyCharged() { return skippedAlreadyCharged; }
public RecurringChargeJobSummary setSkippedAlreadyCharged(Integer value) { this.skippedAlreadyCharged = value; return this; }
public Integer getNullOwnerCharged() { return nullOwnerCharged; }
public RecurringChargeJobSummary setNullOwnerCharged(Integer value) { this.nullOwnerCharged = value; return this; }
public Integer getSkippedSinglePayment() { return skippedSinglePayment; }
public RecurringChargeJobSummary setSkippedSinglePayment(Integer value) { this.skippedSinglePayment = value; return this; }
public Integer getExpiredCards() { return expiredCards; }
public RecurringChargeJobSummary setExpiredCards(Integer value) { this.expiredCards = value; return this; }
public Integer getEndOfTermClosed() { return endOfTermClosed; }
public RecurringChargeJobSummary setEndOfTermClosed(Integer value) { this.endOfTermClosed = value; return this; }
public Integer getEndOfTermRevoked() { return endOfTermRevoked; }
public RecurringChargeJobSummary setEndOfTermRevoked(Integer value) { this.endOfTermRevoked = value; return this; }
public Integer getHardClosed() { return hardClosed; }
public RecurringChargeJobSummary setHardClosed(Integer value) { this.hardClosed = value; return this; }
public Integer getCappedClosed() { return cappedClosed; }
public RecurringChargeJobSummary setCappedClosed(Integer value) { this.cappedClosed = value; return this; }
public Integer getExpiredCardNotified() { return expiredCardNotified; }
public RecurringChargeJobSummary setExpiredCardNotified(Integer value) { this.expiredCardNotified = value; return this; }
public Integer getCheckFirst() { return checkFirst; }
public RecurringChargeJobSummary setCheckFirst(Integer value) { this.checkFirst = value; return this; }
public Boolean isCircuitBroken() { return circuitBroken; }
public RecurringChargeJobSummary setCircuitBroken(Boolean value) { this.circuitBroken = value; return this; }
public String getCircuitBreakerCode() { return circuitBreakerCode; }
public RecurringChargeJobSummary setCircuitBreakerCode(String value) { this.circuitBreakerCode = value; return this; }
public Integer getWouldCharge() { return wouldCharge; }
public RecurringChargeJobSummary setWouldCharge(Integer value) { this.wouldCharge = value; return this; }
public Integer getWouldStopHard() { return wouldStopHard; }
public RecurringChargeJobSummary setWouldStopHard(Integer value) { this.wouldStopHard = value; return this; }
public Integer getWouldStopCapped() { return wouldStopCapped; }
public RecurringChargeJobSummary setWouldStopCapped(Integer value) { this.wouldStopCapped = value; return this; }
public Integer getWouldSms() { return wouldSms; }
public RecurringChargeJobSummary setWouldSms(Integer value) { this.wouldSms = value; return this; }
public Integer getWouldEmail() { return wouldEmail; }
public RecurringChargeJobSummary setWouldEmail(Integer value) { this.wouldEmail = value; return this; }
public Integer getWouldClose() { return wouldClose; }
public RecurringChargeJobSummary setWouldClose(Integer value) { this.wouldClose = value; return this; }
public Integer getWouldExpire() { return wouldExpire; }
public RecurringChargeJobSummary setWouldExpire(Integer value) { this.wouldExpire = value; return this; }
public Integer getWouldEndOfTermClose() { return wouldEndOfTermClose; }
public RecurringChargeJobSummary setWouldEndOfTermClose(Integer value) { this.wouldEndOfTermClose = value; return this; }
public Integer getWouldEndOfTermRevoke() { return wouldEndOfTermRevoke; }
public RecurringChargeJobSummary setWouldEndOfTermRevoke(Integer value) { this.wouldEndOfTermRevoke = value; return this; }
public Integer getSmsSent() { return smsSent; }
public RecurringChargeJobSummary setSmsSent(Integer value) { this.smsSent = value; return this; }
public Integer getEmails() { return emails; }
public RecurringChargeJobSummary setEmails(Integer value) { this.emails = value; return this; }
public Integer getClosed() { return closed; }
public RecurringChargeJobSummary setClosed(Integer value) { this.closed = value; return this; }
public ArrayList<String> getLog() { return log; }
public RecurringChargeJobSummary setLog(ArrayList<String> value) { this.log = value; return this; }
public Integer getStatusCode() { return statusCode; }
public RecurringChargeJobSummary setStatusCode(Integer value) { this.statusCode = value; return this; }
public String getMessage() { return message; }
public RecurringChargeJobSummary setMessage(String value) { this.message = value; return this; }
}
}
Java 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
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"}