Update customer's payment method

To reduce the level of assessment you may require for PCI, it is recommended to use the Payment Method Capture Widget or GetPaymentToken message when signing up customers or updating their payment method information.

REST API

Using the Widget

Use the Payment Method Capture Widget to securely capture payment details (credit card and bank account) by embedding it in your website and save payment details in Debitsuccess systems.

https://oc.debitsuccess.com/dswidget/dsPaymentFormWidget.js

SOAP WS

Change the payment method used to collect payments for an Account or make changes to the customer’s payment method. This can be achieved by the AdjustAccountPaymentMethod or the GetPaymentToken message.

Update payment method using GetPaymentToken (PayNow)

The GetPaymentToken retrieves an 8 digit token. This token can then been passed through the various wireless networks needed to process the payment without actual bank or credit card details being exposed. You will need to provide:

AccountReferenceNo
CallBackUrl
PayMethodType
RequestType
Choose UpdatePaymentDetail. This allows token to be used for adding payment details

Sample request message

<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:GetPaymentToken>
         <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:AccountReferenceNo>DEA2884487</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb2:CallBackUrl>https://www.testserver.debitsuccess.com</deb2:CallBackUrl>
            <deb2:PayMethodType>Both</deb2:PayMethodType>
            <deb2:RequestType>UpdatePaymentDetail</deb2:RequestType>
         </deb:request>
      </deb:GetPaymentToken>
   </soapenv:Body>
</soapenv:Envelope>

Sample response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="07d31e0f-0a6e-4e96-b5fc-2fa066db3c6b" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
   </s:Header>
   <s:Body>
      <GetPaymentTokenResponse xmlns="Debitsuccess.WebServices.WCF">
         <GetPaymentTokenResult 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-10-06T11:33:38.9308523+13:00</DateCreated>
            <Id xmlns="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core">531d141f-e515-408c-9530-66428a031ded</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:AccountId>f19536d0-8ec2-44cd-b65c-05159e5e9d23</a:AccountId>
            <a:PaymentFormURL>https://oc-qa-sk.debitsuccess.com/PayNow/T/pyRaES9L</a:PaymentFormURL>
            <a:Token>pyRaES9L</a:Token>
            <a:ValidTo>2020-10-06T11:43:38.9933395+13:00</a:ValidTo>
            <a:WebhookToken>kt8IKvt4</a:WebhookToken>
         </GetPaymentTokenResult>
      </GetPaymentTokenResponse>
   </s:Body>
</s:Envelope>

Update payment method using AdjustAccountPaymentMethod

The AdjustAccountPaymentMethod can be used to update the customer’s payment method, but please see the note above regarding PCI. Provide the following details:

AccountNo
Bank count number or credit card no
AccountHolder
nameonbankaccorcreditcard
AccountType
CreditCardType
Required for credit card
ExpiryDate
Required for credit card

Sample request message

<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:AdjustAccountPaymentMethod>
         <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:AccountReferenceNo>DEA2884487</deb1:AccountReferenceNo>
            <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo>
            <deb1:NewPaymethod>
               <deb1:AccountHolder>Test</deb1:AccountHolder>
               <deb1:AccountNo>5555555555554444</deb1:AccountNo>
               <deb1:AccountType>CreditCard</deb1:AccountType>
               <deb1:CreditCardType>Mastercard</deb1:CreditCardType>
               <deb1:ExpiryDate>2020-12</deb1:ExpiryDate>
            </deb1:NewPaymethod>
         </deb:request>
      </deb:AdjustAccountPaymentMethod>
   </soapenv:Body>
</soapenv:Envelope>

Debitsuccess Developer Documentation

Update customer's payment method

REST API

Using the Widget

SOAP WS

Update payment method using GetPaymentToken (PayNow)

Sample request message

Sample response message

Update payment method using AdjustAccountPaymentMethod

Sample request message

Sample response message

Related Articles