Versions Compared

Key

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

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

Code Block
languagexml

Sample Response

Code Block

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. Use the GetFacilityAccountConfiguration SOAP API for this purpose.

Sample Request

Code Block
languagexml
<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

Code Block
languagexml
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="7ac9b78811b369d0-5764d388-44244dbd-b3edb662-0547103ec85a2e89ce25b97e" 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>2020DateCreated>2021-0902-22T1211T17:3241:4336.73077682391408+1213:00</a:DateCreated>
            <a:Id>dbe896b1Id>f0ac03ca-640dfcac-49554ba0-a604a92b-d5a13d62d545<d2d9ccf5d549</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>5CCCommissionRate>1.0000<6716</a:CCCommissionRate>
            <a:CCCommissionType>PercentagePlusPerTransaction<CCCommissionType>Percentage</a:CCCommissionType>
            <a:COCommissionRate>0COCommissionRate>3.9901<8462</a:COCommissionRate>
            <a:COCommissionType>Percentage</a:COCommissionType>
            <a:DDCommissionRate>1DDCommissionRate>0.0000<6000</a:DDCommissionRate>
            <a:DDCommissionType>PerTransaction</a:DDCommissionType>
            <a:EstablishmentFeeAmount>3.00<EstablishmentFeeAmount>0</a:EstablishmentFeeAmount>
            <a:EstablishmentFeePayer>ClientPaysEstablishmentFee<EstablishmentFeePayer>NoEstablishmentFee</a:EstablishmentFeePayer>
            <a:EstablishmentFeePercent>0</a:EstablishmentFeePercent>
            <a:PenaltyFeeAmount>9.90</a:PenaltyFeeAmount>
            <a:PenaltyFeePayer>CustomerPays</a:PenaltyFeePayer>
         </GetFacilityAccountConfigurationResult>
      </GetFacilityAccountConfigurationResponse>
   </s:Body>
</s:Envelope>
Filter by label (Content by label)
showLabelsfalse
showSpacefalse
excerptTypesimple
cqllabel = "getfacilityaccountconfiguration"

On this page:

Table of Contents