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

A casual payment is a real-time payment but the payment relates to the business and not associated with a customer account in particular.

Using the PaymentToken for casual payment or GetCasualPaymentToken gives you the following options:

  1. Get the customer to make a payment without having an account with Debitsuccess

  2. Paynow URL where customer can make payment

  3. At the end of the operation, the user will be redirected to the call back URL provided in the request message and the status of the operation will be returned as a URL parameter.

  4. The token has a lifespan of 10 minutes. This will mean that the customer needs to access the payment form URL within 10 minutes of the token being issued.

  5. The token is for a one-time usage. Once the operation has started (link is clicked), it cannot be reused.

  6. For each facility you can provide a Webhook URL which, after approval, we will store in our database. We will post the transaction details to this Webhook URL once as a JSON object. The transaction details are the same as what we send back for CallbackURL - the WebhookToken, PaymentFormToken, Status, Message, ResponseCode.

We recommend that you store the WebhookToken we provide in the response securely to authenticate the information received through the WebhookURL is from Debitsuccess.

REST API

Use the Generate PaymentToken for casual payment endpoint of Customer Services API to make a casual payment using credit card.

POST https://<ServerURL>/CustomerServices/v1.0/businessAccounts/{businessAccountId}/paymentTokens

Provide the following:

  • amount Amount to pay.

  • callbackURL The URL the customer needs to be redirected to after the operation.

  • paymentNote Any notes to be recorded against the payment.

  • paymentRef if provided must be unique at ContractPrefix level.

SOAP API

The GetCasualPaymentToken method allows you to retrieve a token and a URL which allows you to redirect the customer to a form to process a real-time casual payment. It requires the following information:

  1. Contract Prefix

  2. Amount

  3. Call back URL

  4. Payment notes

  5. Payment Ref 

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" xmlns:deb2="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.RequestMessages"> 
<soapenv:Header/> 
   <soapenv:Body> 
      <deb:GetCasualPaymentToken> 
        <deb:request> 
         <deb1:User> 
         <deb1:Password>#QualIT</deb1:Password> 
         <deb1:Username>QualIT</deb1:Username> 
         </deb1:User> 
         <deb1:ContractPrefix>DEA2</deb1:ContractPrefix> 
         <deb2:Amount>5</deb2:Amount> 
         <deb2:CallBackUrl>https://www.abc.com</deb2:CallBackUrl> 
         <deb2:PaymentNote></deb2:PaymentNote> 
         <deb2:PaymentRef>reference</deb2:PaymentRef> 
        </deb:request> 
      </deb:GetCasualPaymentToken> 
  </soapenv:Body> 
</soapenv:Envelope>

Sample Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> 
   <s:Header> 
      <ActivityId CorrelationId="f571ec94-9814-4c43-9e99-a8dc95a97f1b" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId> 
   </s:Header> 
   <s:Body> 
     <GetCasualPaymentTokenResponse xmlns="Debitsuccess.WebServices.WCF"> 
        <GetCasualPaymentTokenResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core.ResponseMessages" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
            <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">2020-09-23T07:18:29.6292414+12:00</DateCreated> 
            <Id xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">2f4ad37b-7508-4e98-b16e-9738b1930bb7</Id> 
           <ResponseNotes xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core"> 
              <ResponseMessageNote> 
                  <Code>00</Code> 
                 <Note>Success</Note> 
               <NoteType>Info</NoteType> 
               </ResponseMessageNote> 
           </ResponseNotes> 
            <Status xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">Succeed</Status> 
            <a:PaymentFormURL>https://OC-QA-ChaosRiders.debitsuccess.com/PayNow/c/FE1V18RmG5HTEbrP</a:PaymentFormURL> 
            <a:Token>FE1V18RmG5HTEbrP</a:Token> 
           <a:ValidTo>2020-09-23T07:28:29.6604957+12:00</a:ValidTo> 
            <a:WebhookToken>LTEK51MXhZY3fjvT</a:WebhookToken> 
         </GetCasualPaymentTokenResult> 
      </GetCasualPaymentTokenResponse> 
   </s:Body> 
</s:Envelope>

On this page:

  • No labels

© 2021 Debitsuccess. All rights reserved