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 2 Next »

Usage


Returns details of the casual payments processed between the specified date range.

Parameters

Name

Data Type

Length


 

Description

User





Username

String


Required

Provided by Debitsuccess

Password

String


Required

Provided by Debitsuccess

ContractPrefixString6RequiredUsed for payment lookup and user access checks.
StartDateDateTime
RequiredThe maximum range between StartDate and EndDate is one month.
EndDateDateTime
OptionalEnd of today if not provided

Response 

Name

Data Type

Description

DateCreated

DateTime

Date/time message was processed

Id

String

Unique ID for message

ResponseNotes ()


Collection of validation messages

  • Code

String


  • Note

String


  • NoteType

Enum

Error, Warning, Info

Status

Enum

Failed, Succeed, Unknown

Payments ()

Collection


  • Payment Ref
String
  • Description
StringPayment note
  • PaymentAmount
Decimal (10, 2)
  • PaymentDate
DateTime
  • PaymentId
IntegerUnique identifier for the payment
  • PaymentStatus
Enum

Cleared,

Pending,

Failed,

Settled,

  • PaymentType
Enum?

CasualCreditCard

CasualCreditCardOther

  • Receipt
String

Batch Number

  • CommissionAmount
Decimal (10, 2)The amount of commission Debitsuccess charged on the Payment.

If the payment is declined for any reason in the response CommissionAmount and PaymentID will be 0.

Error Messages

TypeError CodeError Message



























Related Pages

Filter by label

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

On this page:


  • No labels