Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Usage
Excerpt |
---|
Returns details of the casual payments processed between a the specified date range. |
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 |
---|---|---|
Related Pages
Filter by label (Content by label) | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Panel | |
---|---|
On this page:
|