Statuses in Debitsuccess Systems
Account Overdue Status
The overdue status is returned from the following APIs: GetCustomerAccountForDateRange / GetCustomerAccountWithFeesForDateRange and GetCustomerAccountByAccountId / GetCustomerAccountWithFeesByAccountID.
Status | Description |
OD0 | Either account is not overdue or account has just become overdue (the account overdue amount can be used to check this) and not yet got to the point where overdue correspondence would be sent (normally the day after the missed/failed payment) |
OD1 | The beginning of the overdue reminder cycle. Once the customer misses a payment or a payment is reversed, we reach out to them first through an SMS and then an email. Once the overdue 1 email is sent, the overdue count moves from 0 to 1. Note: SMS and emails are sent to customers only if outbound overdue correspondence is enabled in our system. |
OD2 and OD3 | Similar to OD1, for the subsequent missed/reversed payments the customers continue to receive email reminders. Each time the overdue progresses from 1 to 2 to 3. |
Account Status
Status | Description |
Active | Accounts are considered active when they do not have a finish date set or the cancel reason is “Prep for debt coll” or “pending write off”. Finish date may be set once an account has paid off the contracted amount or when the account is explicitly closed. Notes: Suspended Accounts and Payment Stopped accounts are considered as Active as well. |
Suspended | When accounts are in suspended status, the accumulation of payments owing will halt. |
PaymentStopped | Payments owing will continue to accrue based on payment schedules irrespective of a stop in customer’s payments |
Closed | Accounts will be closed after reaching the end of the term or manually closed. |
Overdue | Accounts will fall into overdue status after DS failed to collect the amount due from the accounts |
Transaction Status
These are the statuses returned from GetCardPaymentStatusForCustomerAccount to check the status of the payment.
Status | Description |
Processing | Waiting for a reply. |
Authorised | Payment has been authorised and recorded against the Debitsuccess account. |
Declined | Payment has been declined by the Debitsuccess payment services provider. |
Requires3ds | The client application must follow the 3DSecure procedure (see below). This is currently not required by the 3rd party payment gateway, however, this may become a requirement at any time. |
StatusRequired | This is a serious error condition that may be returned by the Debitsuccess payment services provider. It is anticipated that it will be an extremely rare case that a client application sees this status. The Debitsuccess payment services provider is unable to return any information about the transaction. This includes whether the transaction is in progress, has been accepted or declined. This is supposed to be a transient condition dependent on the internal state of the Debitsuccess payment services provider‘s infrastructure. The Debitsuccess interface with our payment services provider buffers the StatusRequired status by repeating get status requests over a period of time. Meanwhile, the client application will receive Processing status. Only after retrying a number of times (currently configured as 6 times with 10-second intervals), the Debitsuccess web service will give up and return the StatusRequired status to the client application. |
Payment Status
For full-service accounts, we only display limited payments statuses. Whereas, the gateway billing process is driven by the state of the schedules with additional statuses (unbillable, unattempted, pending) to control the billing.
Full-service
Status | Description |
Failed | When in Credit Control state and N amount of days passed (configurable). No payment was received from the customer. |
Cleared | When funds were successfully collected (two channels: the bank successfully processed transaction or payment through PayNow). |
Settled | When funds were paid out (docket/trans was settled) to the client. This is the final state. |
Retry | When collection fails and the Facility Account is enabled for retry. |
Gateway
These status are returned by GetCustomerPaymentByStatusForDateRange, GetCustomerPaymentByStatusForAccountId, GetPaymentHistoryStatusByAccountID and GetPaymentHistoryByStatusForDateRange APIs.
Status | Description |
Pending | Payment schedule has been sent to the payment processor. |
Payment was successfully processed by the payment processor | |
Cleared | If no payment failure notification has been received within x days (1 day for credit card, 3 working days for bank payment) then the payment is assumed to be successful and is set to cleared. Note: Real-time payments are immediately marked as cleared if they are successful. |
Settled | When funds collected for the payment schedule are paid out to the client. Note: Normally Settled is the final state, but It is possible for a settled payment to then go to a failed state in the case where a late reversal occurs (reversal is notified after the money has been settled). |
Payment was reversed by the bank | |
Retry | When collection fails and the Facility Account/payment type is enabled for retry. |
Failed | If retries are not enabled or after 1 retry, if enabled, the payment schedule will be set to failed. |
Unbillable | When there is a ‘Payments Stop’ (‘DD stop’) of the customer account and a new pay schedule has been added. This new pay schedule will be set as ‘Unbillable’. This is the final state. |
Realtime Credit Card Response Status
These are statuses returned from the Payment API.
Status | Description |
---|---|
authorized | Successful Transaction |
declined | Transaction declined |
declined_card_expired | Payment has been declined due to an expired card. |
declined_do_not_honour | Do not honour means that the customer's card issuing bank has declined the transaction. This is the most common message provided by card-issuing banks when a transaction fails its authorization process. Ask your customers to contact their bank to check there are no issues with their card. |
declined_insufficient_funds | Insufficient funds is an issue that occurs when an account does not have adequate capital to satisfy a payment demand |
declined_refer_to_card_issuer | Refer to Issuer. The customer's bank (Card Issuer) has indicated there is a problem with the card number. |
not_submitted | The request could not be submitted due to the Payment gateway issue. Please submit another request. |
processing | Payment has been accepted for processing. But the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. In this scenario, the client must poll the URL returned in the "location" header of the response to retrieve the payment status code. The client must retry retrieving the status code 5 times within a 2-minute duration. If the status code still is processing after retrying. The client should contact Debitsuccess support. |
Account Close Reason
Following are the account close-reasons available in our system returned via GET Account(s).
It is possible to set up custom close reasons for a business using the Debitsuccess Self Service Web Portal, so any close reason not on this list can be treated as “Facility request”.
|
|
DD Stop Reason / CollectionStopReason
These are statuses returned from the Get Account(s) API. The CollectionStopReason defaults to Manual Payment Stop when payment is stopped using REST API (PUT Account) or SOAP API (StopPayment).
Status | Description |
Manual Payment Stop | Any scenario where the:
|
Charge Back | Customer asked for a chargeback. And requires investigation of finance/retention team. |
Invalid Account | Errors coming from the bank:
|
Activated by Suspension | Customer asked for suspension of the account for a certain period of time. |
Bulk Suspension | Accounts of a business were bulk suspended. |
Batch Collection Attempts To Clear Limit Exceeded |
|
Reversal Reason
These are statuses returned from the Get Account(s) API lastReversalReasons
response parameter.
|
|
© 2021 Debitsuccess. All rights reserved