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

GATEWAY ONLY

Usage


Returns the schedule with payment status found in between the date range provided in the request.

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

Allows requesting user to be logged

ContractPrefix

String

6

Optional

If not provided, records from all facility accounts associated with the WS user will be extracted

Status

Enum


Optional

  • All (default value)

  • Pending

  • Retry

  • Failed

  • Cleared

  • Settled

  • Unbillable

For descriptions of these statuses, see Statuses in Debitsuccess Systems.

StartDate

DateTime


Required

Start date and end date must be within 31 days

EndDate

DateTime


Optional

If EndDate is not provided, it will default to today date

Response 

Name

Data Type

Description

DateCreated

Datetime

Date/time message was processed

Id

String

Unique ID for the message

ResponseNotes()



  •  Code

String


  • Note

String


  • NoteType

Enum

Error, Warning, Info

Status

Enum

Failed, Success, Unknown

PaymentSchedules()

  1. PayScheduleWithStatus()



  • ContractPrefix

String


  • AccountRef

String


  • Description

String(50)

Unique identifier

  • ExternalIdentifier

String(50)


  • Installment

Number

Date of Status of Payment

  • PaymentStatus

String(15)


  • ScheduleId

Integer


  • StartDate

Datetime


  • StatusDate

Datetime


  • ErrorCode

String

Note: Only returned for failed Payments.
Account Closed
Authority Stopped
Card Expired
Chargeback
Declined
Insufficient Funds
Invalid Account
Lost / Stolen Card
No Authority
Restricted Card

Error Messages

Type

Error Code

Error Message

Error

14033

Invalid Start date - start date must be less than end date.

Error

14101

Invalid Start Date - start date must not be empty or in the future

Error

14104

Invalid Date range - start date and end date must be within 31 days.

Error

13001

Invalid Contract Prefix

Error

100

Invalid enum value ‘<invalid status>' cannot be deserialized into type 'Debitsuccess.WebServices.Core.DocketStatus'. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.

Error

100

There was an error deserializing the object of type Debitsuccess.WebServices.Core.RequestMessages.RequestGetPaymentHistoryByStatusForDateRange. The value '' cannot be parsed as the type 'DateTime'.

Related Pages



On this page:


REST API





  • No labels