| Requires the role: | Admin |
| POST | /recurringPayments/run-charge |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DryRun | body | bool | No | |
| AsOf | body | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MasterEnabled | form | bool | No | |
| AutoSubmitEnabled | form | bool | No | |
| DunningEnabled | form | bool | No | |
| ExpireLapsedEnabled | form | bool | No | |
| EndOfTermRevokeEnabled | form | bool | No | |
| ChargeHour | form | int | No | |
| BatchSize | form | int | No | |
| AsOfUtc | form | DateTime | No | |
| DryRun | form | bool | No | |
| ChargeLive | form | bool | No | |
| DunningLive | form | bool | No | |
| Charged | form | int | No | |
| Declined | form | int | No | |
| Ambiguous | form | int | No | |
| SkippedAlreadyCharged | form | int | No | |
| NullOwnerCharged | form | int | No | |
| SkippedSinglePayment | form | int | No | |
| ExpiredCards | form | int | No | |
| EndOfTermClosed | form | int | No | |
| EndOfTermRevoked | form | int | No | |
| HardClosed | form | int | No | |
| CappedClosed | form | int | No | |
| ExpiredCardNotified | form | int | No | |
| CheckFirst | form | int | No | |
| CircuitBroken | form | bool | No | |
| CircuitBreakerCode | form | string | No | |
| WouldCharge | form | int | No | |
| WouldStopHard | form | int | No | |
| WouldStopCapped | form | int | No | |
| WouldSms | form | int | No | |
| WouldEmail | form | int | No | |
| WouldClose | form | int | No | |
| WouldExpire | form | int | No | |
| WouldEndOfTermClose | form | int | No | |
| WouldEndOfTermRevoke | form | int | No | |
| SmsSent | form | int | No | |
| Emails | form | int | No | |
| Closed | form | int | No | |
| Log | form | List<string> | No | |
| StatusCode | form | int | No | |
| Message | form | string | No |
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"}