GetCasualPaymentsForDateRange
Usage
Returns details of the casual payments processed between the specified date range.
Since this API call does not have pagination, our recommendation is to apply smaller date ranges (not more than 30 days) otherwise, you may receive timeout errors.
Parameters
Name | Data Type | Length |
| Description |
|---|---|---|---|---|
User | ||||
Username | String | Required | Provided by Debitsuccess | |
Password | String | Required | Provided by Debitsuccess | |
ContractPrefix | String | 6 | Required | Used for payment lookup and user access checks. |
StartDate | DateTime | Required | The maximum range between StartDate and EndDate is one month. | |
EndDate | DateTime | Optional | End of today if not provided |
Response
Name | Data Type | Description |
|---|---|---|
DateCreated | DateTime | Date/time message was processed |
Id | String | Unique ID for message |
ResponseNotes () | Collection of validation messages | |
| String | |
| String | |
| Enum | Error, Warning, Info |
Status | Enum | Failed, Succeed, Unknown |
Payments () | Collection | |
| String | |
| String | Payment note |
| Decimal (10, 2) | |
| DateTime | |
| Integer | Unique identifier for the payment |
| Enum | Cleared, Pending, Failed, Settled, |
| Enum? | CasualCreditCard CasualCreditCardOther |
| String | Batch Number |
| Decimal (10, 2) | The amount of commission Debitsuccess charged on the Payment. |
If the payment is declined for any reason in the response CommissionAmount and PaymentID will be 0.
Error Messages
Type | Error Code | Error Message |
|---|---|---|
Error | 02 | Invalid user credentials |
Error | 13001 | Invalid Contract Prefix |
Error | 14204 | Start date and End date cannot be more than 30 days apart |
Error | 13090 | Start date must not be after end date |
Error | 14203 | Start date cannot be in the future |
Error | 14202 | Start date is required |
Related Pages
On this page:
© 2021 Debitsuccess. All rights reserved