Page Comparison

The real-time payment services are offered to businesses that would like to allow their customers to make a payment towards their account outside of the normal billing cycles. The customers can make a real-time payment for different reasons. It could be to: 

1. clear an arrear in payment 

2. make an advance payment 

3. make an initial payment towards an account 

This service needs to be enabled for the business in order that their customers avail the service. To make an advance payment, the customer’s account must be due for the next payment. There is a maximum limit for the payment amount.  

Integrators have a few options to choose from. They are listed as follows: 

GetPaymentToken 

This can mostly be offered to customers who need to make an initial payment towards the account setup with Debitsuccess. It requires the following information from the integrator. 

1. Account Reference No. 

2. Amount 

3. Call back URL 

4. Create a one-off charge 

5. Payment method type 

6. Payment notes 

7. Request type   

It gives the integrator a few options such as: 

1. Receive a link to pass on to the customers to make a payment 

2. A separate one-off charge can be created for this payment if it has been successful 

3. Define the amount that needs to be paid 

4. Provide a URL for the customer to be redirected to after the payment is processed (call back URL) 

5. For each facility, they 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, AccountReferenceNo, ExternalAccountReferenceNo, Status and Message.   

6. 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.  

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

In the GetPaymentToken process, a PayNow link is generated and that can be shared with the customer to process a payment. This will ensure that the integrator does not handle credit card information of the customer. 

Sample Request

Sample Response

ProcessRealTimeCardPayment 

 This is used by an integrator who wants to process a real-time card payment for the customer by themselves.  

It requires the following information from the integrator. 

1. Account Reference No. 

2. UseStoredCardDetails 

3. AccountHolder 

4. CVC 

5. CardNumber 

6. CreditCardType 

7. ExpiryDate 

8. Amount 

9. Create one-off charge 

10. Notes   

It gives the integrator a few options such as: 

1. Use a card already stored against the customer’s account. 

2. Provide a new bank account number to transfer a specified amount or provide a new credit card number to make a payment 

3. A separate one-off charge can be created for this payment if it has been successful 

4. Define the amount that needs to be paid 

5. The integrator is expected to make another call to query the status of the payment (GetCardPaymentStatusForCustomerAccount) 

Sample Request

Sample Response

Casual Payment Token 

 This method allows integrators 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 from the integrator. 

1. Contract Prefix 

2. Amount 

3. Call back URL 

4. Payment notes 

5. Payment Ref   

It gives the integrator a few options such as: 

1. The integrator can get the customer to make a payment without having an account with Debitsuccess 

2. 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 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. 

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

Sample Request

Sample Response