Versions Compared

Version Old Version 1 New Version Current
Changes made by

chitra.b (Unlicensed)

chitra.b (Unlicensed)

Saved on

Key

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

Usage

Description of the usage of the API.


Add labels for each page with the name of the API. Example: PostCustomerAccount. Use these labels then to list the APIs in the Related pages section below
Tip
Excerpt

Returns the list of commission configurations based on how many payment types have been set up for that facility.


Parameters

RequestInitiator

Name

Data Type

Length


Description

User




  • Username

String


Required

Provided by Debitsuccess

  • Password

String

100

Optional

Allows requesting user to be logged in.

* at least one of the following parameters must be supplied. (To add this text use Subscript font.)


Required

Provided by Debitsuccess

ContractPrefix

String

6

Required

Provided by Debitsuccess

Response 

Name

Data Type

Description

*at least one of the following parameters must be supplied. (To add this text use Subscript font.)

Error Messages

Panel

On this page:

Table of Contents

Related pages

PaymentTypeCode

String

AC, AO, BP, BC, BO, CC, CO, DD, PC, SC, SO, WC, WO, ZC, ZO

PaymentType

String

Definition of the PaymentTypeCode:

AC - CasualCreditCard

AO - CasualCreditCardOther

BP - BPAY

BC - BPAYCreditCard

BO - BPAYCreditCardOther

CC - CreditCard

CO - CreditCardOther

DD - DirectDebit

PC - PaidToFacility

SC - CasualPointOfSale

SO - CasualPointOfSaleOther

WC - WebPayCreditCard

WO - WebPayCreditCardOther

ZC - DirectCreditMasterOrVisa

ZO - DirectCreditOtherCC


CommissionChargeType

String

Defines if charged with a specific amount or percentage per payment type:

  • Percentage
  • Transaction Charge
  • PercentagePlusTransactionCharge

Percentage

String (4 decimal places)

The percentage of commission configured for the payment type

TransactionCharge

String (4 decimal places)

The per transaction charge configured for the payment type

CommissionPayerType

String

Defines who pays the commission:

  • Customer
  • Facility

 MinimumTransactionCharge

String (4 decimal places)

If this value is configured, the payer will have to pay the higher amount between the final commission amount and the minimum transaction charge


Error Messages

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

Filter by label (Content by label)
showLabelsfalse
spacesDDE
showSpacefalse
sorttitle
typepage
cqllabel = "

documentation-space-sample

getcommissionconfiguration" and type = "page" and space = "DDE" and ancestor = "986156090"
labelsdocumentation-space-sample


Panel

On this page:

Table of Contents