Inform us of a payment collected at the business

Owned by chitra.b (Unlicensed)
Last updated: Apr 29, 2021
3 min read

A business might collect payment for an account directly from the customer and outside the Debitsuccess billing system. This payment still needs to be recorded against the account in order to keep the account balance up to date in the Debitsuccess system to prevent overcharging the customer.

REST API

Use the Business Collected Payment endpoint of Payments API to create a payment collected at the business for an existing account.

POST https://<ServerURL>/payments/v1.0/businessCollectedPayments

Payment collected allows facilities to collect payments at clubs and sync the attempts down to Debitsuccess. This allows Debitsuccess to update the balance of the account so that the same payment is not collected automatically.

If you need to reverse a previously loaded amount, you can use:

POST https://<ServerURL>/payments/v1.0/businessCollectedPayments/{originalExternalPaymentIdentifier}/reverse

Payment collected reverse process is used for reversing the transactions that were created as earlier via the payment collected request. It is useful if a payment collected required were sent in an error. To reverse a payment the API consumer must provide the originalExternalPaymentIdentifier which was sent as part of the original payment collected request. There is no way to reverse an arbitrary transaction or amount. A reversal can only be created for a transaction that was processed at an earlier time.

This process is not real-time/immediate in the Debitsuccess System, we recommend several seconds delay between these two calls.

SOAP WS

Use the PaymentCollected message with the following details:

  • Amount
    If you need to reverse a previously loaded amount, you can use PaymentCollected request with a negative amount

  • DateOfPayment

  • Description

  • ExternalTransactionIdentifier
    If you have your own unique reference for a customer account provide that here and use this value when retrieving or updating accounts subsequently

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"> <soapenv:Header/> <soapenv:Body> <deb:PaymentCollected> <deb:request> <deb1:User> <deb1:Password>#password</deb1:Password> <deb1:Username>username</deb1:Username> </deb1:User> <deb1:AccountReferenceNo>DEM88896737</deb1:AccountReferenceNo> <deb1:ExternalAccountReferenceNo></deb1:ExternalAccountReferenceNo> <deb1:Amount>50</deb1:Amount> <deb1:DateOfPayment>2020-08-10</deb1:DateOfPayment> <deb1:Description>This payment collected by facility</deb1:Description> <deb1:ExternalTransactionIdentifier>123456</deb1:ExternalTransactionIdentifier> </deb:request> </deb:PaymentCollected> </soapenv:Body> </soapenv:Envelope>

Sample response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header> <ActivityId CorrelationId="2d3bae52-f838-4713-9c5a-cdb7dc9035f6" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId> </s:Header> <s:Body> <PaymentCollectedResponse xmlns="Debitsuccess.WebServices.WCF"> <PaymentCollectedResult xmlns:a="http://schemas.datacontract.org/2004/07/Debitsuccess.WebServices.Core" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:DateCreated>2020-08-10T15:47:49.5025256+12:00</a:DateCreated> <a:Id>bf9699ed-4c27-4ee7-b0f6-e0605da37430</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> </PaymentCollectedResult> </PaymentCollectedResponse> </s:Body> </s:Envelope>

 

 

© 2021 Debitsuccess. All rights reserved