Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Usage
| Excerpt |
|---|
Returns the payment status of active one-off schedules belonging to the AccountReferenceNo or ExternalAccountReferenceNo provided in the request. |
| Status | ||||
|---|---|---|---|---|
|
Parameters
Name | Data Type | Length | Description | |
|---|---|---|---|---|
User | ||||
| String | Required | Provided by Debitsuccess | |
| String | Required | Provided by Debitsuccess | |
RequestInitiator | 100 | Optional | Optional | Allows requesting user to be logged |
AccountReferenceNo | 15 | Optional* | ||
ExternalAccountReferenceNo | 50 | Optional* | ||
Status | Enum | Optional |
|
* at least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo. If either account is not active then error 10 will be returned
Response
Name | Data Type | Description |
|---|---|---|
DateCreated | Datetime | Date/time message was processed |
Id | String | Unique ID for message |
ResponseNotes() | ||
| String | |
| String | |
| Enum | Error, Warning, Info |
Status | Enum | Failed, Success, Unknown |
PaymentSchedule() | ||
| String(50) | Unique identifier |
| String(50) | |
| Number | Date of Status of Payment |
| String(15) | |
| Integer | |
| Datetime | |
| Datetime |
Error Messages
| Type | Error Code | Error Message |
|---|---|---|
Error | 02 | Invalid user credentials |
| Error | 08 | There is no record found with this criteria |
Error | 10 | Account is not active |
| Error | 100 | Invalid enum value ‘<invalid status>' cannot be deserialized into type 'Debitsuccess.WebServices.Core.DocketStatus'. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.</Note> |
| Error | 12016 | Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both. |
Related Pages
| Filter by label (Content by label) | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|