GATEWAY ONLY

Usage

Returns a list of payments and provides the associated schedule between a specified date range by status for the current user.

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		Description
User
Username	String	Required	Provided by Debitsuccess
Password	String	Required	Provided by Debitsuccess
ContractPrefix	String	Required	Provided by Debitsuccess
StartDate	Datetime	Required	Start of the report period Must be formatted as `YYYY-MM-DD`
EndDate	Datetime?	Optional	End of the report period Must be formatted as `YYYY-MM-DD`
Status	Enum	Required	Settled, Failed, InRetry The default value is Settled, if not provided.

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
Accounts ()
AccountsWithPayments
Id	String
AccountReferenceNo	String	Debitsuccess account reference
ExternalAccountReference	String	Your account identifier
Payments ()	Collection
PaymentWithPaySchedule
o PaymentAmount
o PaymentCode	Enum	Payment, DebtCollectionPayment, PaidAtBusiness, OneOffPayment, AccountTransfer, Refund, SuspensionFee, CancellationFee DebtCallFee EstablishmentFee MiscellaneousFee PenaltyFee Service TransferFee
o PaymentErrorCode	Enum	NoAuthority, AccountClosed, InsufficientFunds, AuthorityStopped, NoError, InvalidAccount, Declined, CardExpired, RestrictedCard, LostOrStolenCard
o PaymentId	Integer	Unique identifier for the payment
o PaymentType	Decimal? (10,2)	DirectDebit, AutomaticPayment, CreditCard, BankImport, Cash, Cheque, DebtCollection, DirectCredit, MoneyOrder, PaidtoFacility, TelephoneBanking, Transfer, Suspense, EFTPOS, ManualReceipting, ReAllocation, CreditCardOther, CreditUnion
o PaySchedules		Paid
§ PaymentScheduleQik		Get
· Description	int	Unique identifier
· ExternalIdentifier
· Installment	DateTime	Date of Status of Payment
· Paid
· PaymentStatus		Pending Retry Failed Cleared Settled Unbillable For descriptions of these statuses, see Statuses in Debitsuccess Systems.
· ScheduleId	Decimal (10,2)
· StartDate	DateTime	Start date of Payment
· StatusDate
· PaymentWithPaySchedule
· AccountWithPayments

Error Messages

Type	Error Code	Error Message
Error	14101	Invalid Start Date - start date must not be empty or in the future.
Error	14033	Invalid Start date - start date must be less than end date.
Error	14104	Invalid Date range - start date and end date must be within 31 days.
Error	02	Invalid user credentials
Error	13001	Invalid Contract Prefix
Error	13151	Multiple contracts found for given contract prefix
Error	14110	Get retry status for GetPaymentHistoryByStatusForDateRange is disabled.
Info	00	Success

Related Pages

Page:

Get payment status within a date range (gateway only)

On this page:

REST API

GET Payment History

Browser not supported