Getting Facility Account Configuration

Add Commission Value to Payment Amount

Every transaction taken by Debitsuccess will incur a commission fee. The commission can be different depending upon what type of transaction has taken place. There are three types of transaction, which are derived from the payment method used:

Direct Debit

Standard Credit Card (Visa/Mastercard)

Other Credit Card (American Express/Diners)

There are also two types of commission calculation:

Per Transaction: This adds the rate as a flat fee to the transaction value.

Percentage: This uses the rate to add a percentage of the transaction value to the transaction value.

A business may want to pass the commission onto the end customer rather than pay it themselves. To achieve this, the instalment amount provided must include the commission on top, which will then be taken out by us leaving the desired amount. The following example shows how this can be done:

Sample Request

Sample Response

Retrieve Facility Account Configuration

Every facility account has a preset contract value like fees and commission rates. These can be retrieved by asking for a specific contract prefix.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:deb="Debitsuccess.WebServices.WCF" xmlns:deb1="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">
   <soapenv:Header/>
   <soapenv:Body>
      <deb:GetFacilityAccountConfiguration>
         <deb:request>
            <deb1:DateCreated>2020-09-22</deb1:DateCreated>
            <deb1:Id>333</deb1:Id>
            <deb1:RequestInitiator>Kin333</deb1:RequestInitiator>
            <deb1:User>
               <deb1:Id>33333</deb1:Id>
               <deb1:Password>#Password</deb1:Password>
               <deb1:Username>Username</deb1:Username>
            </deb1:User>
            <deb1:ContractPrefix>DEA2</deb1:ContractPrefix>
         </deb:request>
      </deb:GetFacilityAccountConfiguration>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="7ac9b788-5764-4424-b3ed-0547103ec85a" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <GetFacilityAccountConfigurationResponse xmlns="Debitsuccess.WebServices.WCF">
         <GetFacilityAccountConfigurationResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:DateCreated>2020-09-22T12:32:43.7307768+12:00</a:DateCreated>
            <a:Id>dbe896b1-640d-4955-a604-d5a13d62d545</a:Id>
            <a:ResponseNotes>
               <a:ResponseMessageNote>
                  <a:Code>00</a:Code>
                  <a:Note>Success</a:Note>
                  <a:NoteType>Info</a:NoteType>
               </a:ResponseMessageNote>
            </a:ResponseNotes>
            <a:Status>Succeed</a:Status>
            <a:CCCommissionRate>5.0000</a:CCCommissionRate>
            <a:CCCommissionType>PercentagePlusPerTransaction</a:CCCommissionType>
            <a:COCommissionRate>0.9901</a:COCommissionRate>
            <a:COCommissionType>Percentage</a:COCommissionType>
            <a:DDCommissionRate>1.0000</a:DDCommissionRate>
            <a:DDCommissionType>PerTransaction</a:DDCommissionType>
            <a:EstablishmentFeeAmount>3.00</a:EstablishmentFeeAmount>
            <a:EstablishmentFeePayer>ClientPaysEstablishmentFee</a:EstablishmentFeePayer>
            <a:EstablishmentFeePercent>0</a:EstablishmentFeePercent>
         </GetFacilityAccountConfigurationResult>
      </GetFacilityAccountConfigurationResponse>
   </s:Body>
</s:Envelope>

On this page: