Versions Compared

Key

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

REST API

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.

Tip

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

SOAP API

Capture new payment method details for an account using the GetPaymentToken call as part of the sign-up process. If the account does not already exist it should be loaded through PostCustomerAccount (Payment method information can be configured as optional at the Debitsuccess end)

Call GetPaymentToken with the following key parameters:

Request

Parameter

Description

AccountReferenceNo

Debitsuccess reference for account

ExternalAccountReferenceNo

Business/Client reference for account (note: either AccountReferenceNo or ExternalAccountReferenceNo or both can be provided

RequestType

UpdatePaymentDetail

PayMethodType

CreditCard, BankAccount or Both

CallBackURL

Redirect URL where the customer will be redirected to after completion of the PayNow process.

Response

The response message for GetPaymentToken Debitsuccess returns a URL PaymentFormURL which is a unique reference that the customer should be redirected to so that they can enter the payment method information. Once the customer completes the entry of their payment details they will be redirected to the URL provided in the request CallBackURL field and notification will be sent to the webhook address configured if any.


Debitsuccess hosted form in payment method capture mode for Credit Card:


Debitsuccess hosted form in payment method capture mode for Bank Account:

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
excerptTypesimple
cqllabel = "getpaymenttoken"

On this page:

Table of Contents