Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Usage
Excerpt |
---|
Returns the fees and other settings for a given contract/facility account. |
Info |
---|
Use the GetCommissionConfiguration call to get a full set of commission values for the facility account. |
Parameters
Name | Data Type | Length | Description | |
---|---|---|---|---|
DateCreated | Date/time message was processed | |||
Id | Unique ID for the facility | |||
User | ||||
| Unique ID for the user | |||
| String | Required | Provided by Debitsuccess | |
| 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 | |
| String | |
| String | |
| Enum | Error, Warning, Info |
Status | Enum | Failed, Succeed, Unknown |
EstablishmentFeePayer | Enum | Defines who pays the 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: |
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: |
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: |
COCommissionRate | Decimal (10, 2) | Either fixed amount or percentage of credit card other payment (depending on COCommissionType) |
PenaltyFeePayer | Enum "Customer Pays" | Defines who pays the penalty fee: 0 - "Customer Pays" |
PenaltyFeeAmount | Decimal (10, 2) | Total amount of penalty fee |
Error Message
Type | Error Code | Error Message |
---|---|---|
Error | 13152 | Contract prefix must not be null, empty or white space |
Error | 02 | Invalid user credentials |
Error | 13150 | No contract found for given contract prefix |
Error | 13151 | Multiple contracts found for given contract prefix |
Info | 00 | Success |
Related Pages
Filter by label (Content by label) | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Panel | |
---|---|
On this page:
|