Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Usage


Excerpt

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


Parameters

Name

Data Type

Length


Description

User



  • Username
String
RequiredProvided by Debitsuccess
  • Password
String
RequiredProvided by Debitsuccess
ContractPrefixString6RequiredUsed for payment lookup and user access checks.
PaymentRef String50RequiredPayment 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.

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

Error Messages

TypeError CodeError Message
Error
02
Invalid user credentials
Error14120
PaymentRef is required
Error
13001
Invalid Contract Prefix

Related Pages

Filter by label (Content by label)
showLabelsfalse
spacesDDE
showSpacefalse
sorttitle
typepage
cqllabel = "getcasualpaymentsbypaymentref" and type = "page" and ancestor = "986156090"
labelsdocumentation-space-sample



Panel

On this page:

Table of Contents