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. |
| Note |
|---|
Since this API call does not have pagination, our recommendation is to apply smaller date ranges (not more than 30 days) otherwise, you may receive timeout errors. |
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 | Must be formatted as | |
EndDate | DateTime | Optional | Must be formatted as |
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 GetPaymentHistoryWithFeesByAccountIdseparate 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:
|
Type | Error Code | Error Message |
|---|---|---|
Error | 02 | Invalid user credentials |
Error | 14202 | Start date is required |
Error | 14203 | Start date cannot be in the future |
Error | 13090 | Start date must not be after end date |
Error | 14204 | Start date and End date cannot be more than 30 days apart |
Error | 13001 | Invalid Contract Prefix |
Error | 13171 | Cannot process this request as your Facility is missing key configuration. Please contact Debitsuccess directly to resolve this. |
Warning | 14201 | No BPay transactions were found for the date range provided. |
Info | 00 | Success |
Related Pages
| Filter by label (Content by label) | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
| Panel | |
|---|---|
On this page:
|