Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Usage


Returns a list of payments between a specified AccountID reference for the current user.

Parameters

Name

Data Type

Length


Description

User





  • Username

String


Required

Provided by Debitsuccess

  • Password

String


Required

Provided by Debitsuccess

AccountReferenceNo

String

15

Optional*

Debitsuccess account reference

StartDate

Datetime


Required

Start of the report period

EndDate

Datetime?


Optional

End of the report period

Status

Enum


Required

Settled, Failed, InRetry


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


  • ExternalTransactionIdentifier



  • BatchNumber

Integer


  • CommissionAmount



  • PaymentDate

DateTime


  • PaymentAmount

Decimal (10, 2)


  • 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

  • TransactionDate

DateTime

Start date of Transaction

  • WasRetry



  • ExternalTransactionIdentifier

String

A unique identifier for the transaction

  • ReversedPaymentId

Integer

Unique identifier for the reversed payment

  • PaySchedules


Paid

o  PaymentScheduleQik



Get

§  Description

int

Unique identifier

§  ExternalIdentifier



§  InRetry



§  Installment

DateTime

Date of Status of Payment

§  Paid



§  PaymentStatus



§  ScheduleId

Decimal (10,2)


§  StartDate

DateTime

Start date of Payment

§  StatusDate



  • PaymentsWithSchedule



§  AccountWithPayments




Error Messages

Need info

TypeError CodeError Message



Related Pages

Filter by label

There are no items with the selected labels at this time.

On this page:




  • No labels