Parameters
Name | Data Type | Length |
| Description |
---|
DateCreated |
|
|
| Date/time message was processed |
RequestInitiator | String | 100 | Optional | Allows requesting user to be logged in |
User |
|
|
|
|
|
|
| Optional | Unique ID for the user |
| String |
| Required | Provided by Debitsuccess |
| String |
| Required | Provided by Debitsuccess |
AccountReferenceNo | String | 15 | Optional* | Debitsuccess account reference |
ExternalAccountReferenceNo | String | 50 | Optional* | External account reference |
CustomerDetail |
|
|
|
|
| DateTime |
| Optional** |
|
| String | 40 | Optional** | First name of the customer |
| Enum |
| Optional** | Male, Female, Unknown |
| String | 40 | Optional** | Last name of the customer |
| String | 40 | Optional** |
|
| String | 10 | Optional** |
|
* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo.
** If an empty string is passed the customer detail will be overridden but if a null is passed it will be ignored.
Response
Name | Data Type | Description |
---|
DateCreated | DateTime | Date/time message was processed |
Id | String | Unique ID for the message |
ResponseNotes () |
| Collection of validation messages |
| String |
|
| String |
|
| Enum | Error, Warning, Info |
Status | Enum | Failed, Succeed, Unknown |
Error Message
Type | Error Code | Error Message |
---|
Error | 12002 | Missing client first name |
Warning | 14020 | DateTime field '{0}' contains time part, but the time is ignored by message. |
Error | 13200 | Title field cannot be more than 10 characters long. |
Error | 13203 | <Field name> field cannot be more than <maxlength> characters. |
Error | 02 | Invalid user credentials |
Error | 12016 | Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both. |
Error | 08 | There is no record found with this criteria |
Error | 10 | Account is not active |
Error | 07 | Multiple accounts found with this criteria |
Info | 00 | Success |
Related Pages