Versions Compared
| Version | Old Version 1 | New Version 2 |
|---|---|---|
| Changes made by | ||
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Usage
| Excerpt |
|---|
Returns a list of payments between a specified AccountID reference for the current user. |
Parameters
Name | Data Type | Length | Description | |
|---|---|---|---|---|
User | ||||
| String | Required | Provided by Debitsuccess | |
| String | Required | Provided by Debitsuccess | |
AccountReferenceNo | String | 15 | Optional* | Debitsuccess account reference |
StartDate | Datetime | Required | Start of the report period | |
EndDate | Datetime? | Optional | End of the report period | |
Status | Enum | Required | Settled, Failed, InRetry |
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· | |
| String· | |
| ||
·
| Integer· | |
| ||
·
| DateTime· | |
| Decimal (10, 2)· | |
| String | Description of payment· |
| Enum | NoAuthority, AccountClosed, InsufficientFunds, AuthorityStopped, NoError, InvalidAccount, Declined, CardExpired, RestrictedCard, LostOrStolenCard· |
| Enum | Payment, DebtCollectionPayment, PaidAtBusiness, OneOffPayment, AccountTransfer, Refund, SuspensionFee, CancellationFee DebtCallFee** EstablishmentFee** MiscellaneousFee** PenaltyFee** Service** TransferFee**· |
| 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· |
| DateTime | Start date of Transaction· |
| ||
·
| String | A unique identifier for the transaction· |
| Integer | Unique identifier for the reversed payment· |
| Paid | |
o PaymentScheduleQik | Get | |
§ Description | int | Unique identifier |
§ ExternalIdentifier | ||
§ InRetry | ||
§ Installment | DateTime | Date of Status of Payment |
§ Paid | ||
§ PaymentStatus | ||
§ ScheduleId | Decimal (10,2) | |
§ StartDate | DateTime | Start date of Payment |
§ StatusDate | ||
·
| ||
§ AccountWithPayments |
Error Messages
Need info
| Panel | |
|---|---|
On this page:
|
Related pages
| Filter by label (Content by label) | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|