GetCasualPaymentsByPaymentRef

Usage



Returns details of the casual payment based on the payment reference supplied.



Parameters

Name

Data Type

Length



Description

User









  • Username

String



Required

Provided by Debitsuccess

  • Password

String



Required

Provided by Debitsuccess

ContractPrefix

String

6

Required

Used for payment lookup and user access checks.

PaymentRef 

String

50

Required

Payment reference that is used for generating casual payment token 

Response 



Name

Data Type

Description

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

String

Payment note

  • PaymentAmount

Decimal (10, 2)



  • PaymentDate

DateTime



  • PaymentId

Integer

Unique 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.

  • SettlementDate

DateTime

Date/time message when the Settlement is processed.

In any case if a settlement is not performed then the SettlementDate = NULL

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

Error Messages

Type

Error Code

Error Message

Error

02

Invalid user credentials

Error

14120

PaymentRef is required

Error

13001

Invalid Contract Prefix

Related Pages

Filter by label

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





On this page:





© 2021 Debitsuccess. All rights reserved