PaymentCollected
Usage
Records against the account a payment or refund that was processed directly by you e.g. cash paid on-site at business.
Parameters
Name | Data Type | Length | Description | |
---|---|---|---|---|
User | ||||
| String | Required | Provided by Debitsuccess | |
| String | Required | Provided by Debitsuccess | |
RequestInitiator | String | 100 | Optional | Optional – allows requesting user to be logged |
AccountReferenceNo | String | 15 | Optional* | Debitsuccess account reference |
ExternalAccountReferenceNo | String | 50 | Optional* | External account reference |
Amount | Decimal (10, 2) | Required | Amount of payment – pass negative for a refund | |
DateOfPayment | DateTime | Required | Date/time the payment was collected | |
Description | String | 65535 | Optional | A description of what the transaction is for |
ExternalTransactionIdentifier | String | 50 | Required | A unique identifier for the transaction |
* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo
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 Messages
Type | Error Code | Error Message |
---|---|---|
Error | 13012 | Invalid Amount value |
Error | 13071 | Date of payment required. |
Error | 13063 | Transaction identifier is not valid |
Warning | 14021 | Decimal field '{0}' contains more than 2 decimal points that were ignored by message. |
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 |
Error | 13060 | Transaction identifier is not unique |
Error | 13040 | Refund amount exceeds amount that has been paid |
Warning | 13072 | Amount is more than the outstanding balance. |
Info | 00 | Success |
Related Pages
On this page:
© 2021 Debitsuccess. All rights reserved