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

Usage


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

Parameters

Name

Data Type

Length


Description

User




  • Username

String


Required

Provided by Debitsuccess

  • Password

String


Required

Provided by Debitsuccess

ContractPrefix

String

6

Required

Provided by Debitsuccess

Response 

Name

Data Type

Description

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

Need info

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