GetPaymentHistoryForDateRange / GetPaymentHistoryWithFeesForDateRange

Owned by chitra.b (Unlicensed)
Last updated: Sept 01, 2022 by Maddy.L (Unlicensed)
1 min read

Usage



Returns a list of 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









  • 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



EndDate

DateTime



Required





Response Message

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

  • RetryCount

Integer

The retry counter for the transaction. If it is 0, it means it is the initial retry attempt and the retry count for this transaction are not available.

  • SurchargeAmount

Decimal (10, 2)

The amount of Surcharge Debitsuccess charged on the payment.

** These are Debitsuccess Fees and these values will only be returned by a separate call GetPaymentHistoryWithFeesForDateRange. The request and the rest of the response messages are exactly the same as GetPaymentHistoryForDateRange.

Error Messages

Type

Error Code

Error Message

Error

02

Invalid user credentials

Info

00

Success



On this page:



REST API

GET Payment History









© 2021 Debitsuccess. All rights reserved