Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Usage
| Excerpt |
|---|
Returns a list of BPAY payments between a specified date range for the current user. |
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 |
StartDate | DateTime | Required | ||
EndDate | DateTime | Optional |
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 | |
AccountReferenceNo | String | |
| String | |
| Integer | |
| DateTime | |
| Decimal (10, 2) | |
| Decimal (10, 2) | The amount of commission Debitsuccess charged on the payment. |
| 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 |
| String | A unique identifier for the transaction |
| Integer | Unique identifier for the reversed payment |
** These are Debitsuccess Fees and these values will only be returned by separate calls GetPaymentHistoryWithFeesForDateRange and GetPaymentHistoryWithFeesByAccountId. The request and the rest of the response messages are exactly the same as GetPaymentHistoryForDateRange and GetPaymentHistoryByAccountId respectively.
Error Messages
Need info
| Panel | |
|---|---|
On this page:
|
Related pages
| Filter by label (Content by label) | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|