GetPaymentHistoryByStatusForDateRange

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.

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