GetPaymentHistoryByAccountId / GetPaymentHistoryWithFeesByAccountId
Usage
Returns a list of payments related to the specified customer account ID.
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 |
* 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 |
Payments () | Collection | |
| String | |
| Integer | |
| String | Description of payment |
| String | |
| String | A unique identifier for the transaction |
| Decimal (10, 2) | |
| Enum | Payment, DebtCollectionPayment, PaidAtBusiness, OneOffPayment, AccountTransfer, Refund, SuspensionFee, CancellationFee DebtCallFee** EstablishmentFee** MiscellaneousFee** PenaltyFee** Service** TransferFee** |
| DateTime | |
| Decimal (10, 2) | The amount of commission Debitsuccess charged on the payment. |
| Enum | NoAuthority, AccountClosed, InsufficientFunds, AuthorityStopped, NoError, InvalidAccount, Declined, CardExpired, RestrictedCard, LostOrStolenCard |
| Enum | DirectDebit, AutomaticPayment, CreditCard, BankImport, Cash, Cheque, DebtCollection, DirectCredit, MoneyOrder, PaidtoFacility, TelephoneBanking, Transfer, Suspense, EFTPOS, ManualReceipting, ReAllocation, CreditCardOther, CreditUnion |
| Integer | Unique identifier for the payment |
| Integer | Unique identifier for the reversed payment |
| Integer | The retry counter for the transaction. If it is 0, it means it is the initial retry attempt and the retry count for this transaction are not available. |
| Decimal (10, 2) | The amount of Surcharge Debitsuccess charged on the payment. |
** These are Debitsuccess Fees and these values will only be returned by a separate call GetPaymentHistoryWithFeesByAccountId. The request and the rest of the response messages are exactly the same as GetPaymentHistoryByAccountId.
Error Messages
Type | Error Code | Error 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 |
Info | 00 | Success |
Related Pages
Filter by label
There are no items with the selected labels at this time.
© 2021 Debitsuccess. All rights reserved