Returns a list of BPAY payments between a specified date range for the current user.
Parameters
Name
Data Type
Length
Description
User
Username
String
Required
Provided by Debitsuccess
Password
String
Required
Provided by Debitsuccess
RequestInitiator
String
100
Optional
Optional – allows requesting user to be logged
StartDate
DateTime
Required
Must be formatted as YYYY-MM-DD
EndDate
DateTime
Optional
Must be formatted as YYYY-MM-DD
Response
Name
Data Type
Description
DateCreated
DateTime
Date/time message was processed
Id
String
Unique ID for the message
ResponseNotes ()
Collection of validation messages
Code
String
Note
String
NoteType
Enum
Error, Warning, Info
Status
Enum
Failed, Succeed, Unknown
Payments ()
Collection
AccountReferenceNo
String
ExternalAccountReferenceNo
String
BatchNumber
Integer
PaymentDate
DateTime
PaymentAmount
Decimal (10, 2)
CommissionAmount
Decimal (10, 2)
The amount of commission Debitsuccess charged on the payment.
Description
String
Description of payment
PaymentErrorCode
Enum
NoAuthority,
AccountClosed,
InsufficientFunds,
AuthorityStopped,
NoError,
InvalidAccount,
Declined,
CardExpired,
RestrictedCard,
LostOrStolenCard
PaymentCode
Enum
Payment,
DebtCollectionPayment,
PaidAtBusiness,
OneOffPayment,
AccountTransfer,
Refund,
SuspensionFee,
CancellationFee
DebtCallFee**
EstablishmentFee**
MiscellaneousFee**
PenaltyFee**
Service**
TransferFee**
PaymentType
Enum
DirectDebit,
AutomaticPayment,
CreditCard,
BankImport,
Cash,
Cheque,
DebtCollection,
DirectCredit,
MoneyOrder,
PaidtoFacility,
TelephoneBanking,
Transfer,
Suspense,
EFTPOS,
ManualReceipting,
ReAllocation,
CreditCardOther,
CreditUnion
PaymentId
Integer
Unique identifier for the payment
ExternalTransactionIdentifier
String
A unique identifier for the transaction
ReversedPaymentId
Integer
Unique identifier for the reversed payment
** These are Debitsuccess Fees and these values will only be returned by separatecalls GetPaymentHistoryWithFeesForDateRangeand GetPaymentHistoryWithFeesByAccountId. The request and the rest of the response messages are exactly the same as GetPaymentHistoryForDateRange and GetPaymentHistoryByAccountId respectively.
Error Messages
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
There are no items with the selected labels at this time.
Add Comment