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

Usage


Returns the fees and other settings for a given contract/facility account.

Parameters

Name

Data Type

Length


Description

DateCreated



Date/time message was processed
Id



Unique ID for the facility
User





  • Id



Unique ID for the user
  • Username

String


Required

Provided by Debitsuccess

  • Password

String


Required

Provided by Debitsuccess

RequestInitiator

String

100

Optional

Optional – allows requesting user to be logged

ContractPrefix

String

6

Required

Provided by Debitsuccess

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

EstablishmentFeePayer

Enum

Defines who pays the establishment fee:
1 Client pays
2 Facility pays
3 No establishment fee

EstablishmentFeeAmount

Decimal (10, 2)

Total amount of establishment fee

EstablishmentFeePercent

Decimal (10, 2)

Percentage of establishment fee for the facility

DDCommissionType

Enum

Defines if charged with a specific amount or percentage per debit payment:
1 Fix amount per payment
2 Percentage of payment

DDCommissionRate

Decimal (10, 2)

Either fixed amount or percentage of debit payment (depending on DDCommissionType)

CCCommissionType

Enum

Defines if charged with a specific amount or percentage per credit card payment (MasterCard, Visa:
1 Fix amount per payment
2 Percentage of payment

CCCommissionRate

Decimal (10, 2)

Either fixed amount or percentage of credit card payment (depending on CCCommissionType)

COCommissionType

Enum

Defines if charged with a specific amount or percentage per other credit cards (Amex) payment:
1 Fix amount per payment
2 Percentage of payment

COCommissionRate

Decimal (10, 2)

Either fixed amount or percentage of credit card other payment (depending on COCommissionType)

Error Message

TypeError CodeError Message
Error13152Contract prefix must not be null, empty or white space
Error02Invalid user credentials
Error13150No contract found for given contract prefix
Error13151Multiple contracts found for given contract prefix
Info00Success

Related Pages


On this page:


  • No labels