Transaction Types
Different types of transactions represent different use cases.| Types | Description |
|---|---|
| DEPOSIT | This is a credit transaction and will be credited only when the transaction is in status SUCCESS. |
| REFUND | This is a debit transaction for the refund raised by the partner. |
| CHARGEBACK | This is a debit transaction for the refund raised by the bank against dissatisfaction. |
Billing Session Status
These billing session statuses represent the state the session is currently in.| Types | Description |
|---|---|
| CREATED | A session has been created but the link has not been used by the customer to initiate the payment window. |
| STARTED | When the customer opens the payment link and proceeds with accepting TnC. |
| CLOSED | Payment has been successfully done by the customer and an invoice has been created. |
| EXPIRED | In case of non-payment, the link will be expired after a configured interval. Partners can pass the expiry date at the time of session creation. The default expiry date is 24 hours from the time of the creation of the session. |
| REJECTED | This status needs to be enabled by the Admin Team, once done, if a customer clicks on “Back to Shopping” on the payment page then the billing session will be marked REJECTED and no further attempts will be allowed. |
Subscription Status
These subscription statuses represent the state the subscription is currently in.| Types | Description |
|---|---|
| PENDING | A subscription has been created, the link is active and the customer can pay on the link to start the subscription in TRIAL or ACTIVE status |
| PENDING_EXPIRED | When the subscription has crossed the pendingExpire minutes configured during the creation of the subscription, the status is changed to PENDING_EXPIRED. This is a terminal state and the customer cannot attempt a payment after this. |
| TRIAL | Subscription is in trial mode and depending on the trialSettings post completion of trial auto debit may occur or may not. |
| ACTIVE | Subscription has been activated by adding a payment method for postpaid subscriptions or paying in full for prepaid subscriptions. |
| PAUSED | Subscription has been paused by the system configured by the partner using reAttemptConfig.Subscription can also be paused directly by the partner |
| EXPIRED | |
| CANCELLED | The subscription has been canceled by the end customer using the customer panel. If partialCancel was allowed in the subscription, then the customer would be able to cancel on an immediate basis as well. The subscription can also be cancelled directly by the partner or by the system depending on the configuration of reAttemptConfig. |
| FAILED | The subscription is in unknown status due to unforeseen reasons. |
Invoice Status
These invoice statuses represent the actual status of the invoice.| Status | Txn Sub Status | Description |
|---|---|---|
| DRAFT | CREATED | The invoice has just been created and there is pending approval from the partner. |
| APPROVED | N/A | The invoice has been approved by the partner and we will try to auto-debit the customer on the due date. |
| DUE | N/A | The invoice is in due state and the customer can pay on the invoice. If there is a mandate available, we will try for auto-debit as well. |
| OVERDUE | N/A | The invoice could not be paid within the due time and is not in the overdue state. Customers can still attempt to make the payment on the invoice. |
| PAID | CAPTURED | The invoice has been successfully paid and is ready to be sent to the customer. Note: Billing Session Flow will only have invoices in this state from the start. |
| PAID | CHARGEBACK | There has been a chargeback request on the invoice and is in the processing state. |
| PAID | CHARGEBACK-COMPLETED | The chargeback has been processed and a credit note has been created. |
| PAID | REFUND | There has been a refund request on the invoice and is in the processing state. |
| PAID | REFUND-COMPLETED | The refund has been processed and a credit note has been created. |
| CANCELLED | N/A | The invoice has been marked canceled by the partner |
| VOID | N/A | The invoice has been marked void by the partner. |
Deposit Transaction Status
These transaction statuses represent the actual status of the transaction.| Status | Txn Sub Status | Description |
|---|---|---|
| PENDING | INITIATED | The transaction has just been created and there has been a payment attempt on it. |
| PROCESSING | N/A | A payment attempt has been made on the transaction. It is an intermediary state until we get a confirmation from the acquirer. |
| CANCELLED | VOID | The transaction has been cancelled and no further payment attempt can be made. This is a terminal state. |
| FAILED | VOID | A payment attempt was made on the transaction but due to any reason, the transaction was failed by the acquirer. To know more check the txStatusCode value. |
| FAILED | REJECTED | A payment attempt was made but the payment was rejected either by the customer of by the bank due to insufficient funds. |
| SUCCESS | CAPTURED | The payment attempt on the transaction has been successful and a successful debit has been made on the customer’s account. Note: A transaction is treated as successful only if the status is SUCCESS and txSubStatus is CAPTURED. The transactions which were accepted as chargeback will have the status SUCCESS and txSubStatus as CHARGEBACK |
Payment Verification Status
These payment verification status represents the different states the transaction can be in. These status only applies toPACB Module and not to TSP or Session Module
| Status | Description |
|---|---|
| PENDING | There is no verification details that have been uploaded. |
| IN_REVIEW | After uploading verification details, accquirer is verifying the details and no further action is required from the partner. |
| ACTION_REQUIRED | Accquirer have rejected the verification detail and now partner needs to update the details again. |
| VERIFIED | A payment attempt was made on the transaction but due to any reason, the transaction was failed by the acquirer. To know more check the txStatusCode value. |
| EXPIRED | Payment verification details cannot be verifieid in the stipulated time perid of 7 days and therefore the payment will now be refunded back to the customer. |
| CANCELLED | When a refund is initiated for the payment the payment verification status changes to CANCELLED. Note: Transactions for which paymentVerificationStatus if not VERIFIED, will not be settled to the partner. |
Refund Transaction Status
These transaction statuses represent the actual status of the transaction.| Status | Description |
|---|---|
| PENDING | A refund has been created by the partner. Once we acknowledge the status will be changed to PROCESSING. |
| PROCESSING | The refund has been passed over to the bank. We are waiting for the status update from the bank. |
| SUCCESS | The refund has been successfully done and the payment reached the end customer. |
| FAILED | Due to some reason, the refund could not be completed. |
| CANCELLED | The refund request has been canceled by the partner. |
Subscription Frequency
A subscription is a recurring billing mechanism which requires the billing cycle that is the frequency at which invoice has to be raised and subsequent auto-debit from customer has to be made. Below are the frequencies that are allowed.| Frequency | Description |
|---|---|
| DAIL | For billing that requires daily auto-debit. Note: Even though the billing is daily, the invoice needs to be generated 1-2 days prior depending on the payment method. |
| WEEK | For billing that requires weekly / 7-day based auto-debit. |
| MNTH | For billing that requires monthly auto-debit. |
| BIMN | For billing that requires bi-monthly auto-debit. |
| QURT | For billing that requires quaterly auto-debit. |
| MIAN | For billing that requires semi-annully that is 6 months based auto-debit. |
| YEAR | For billing that requires yearly based auto-debit. |
| ONDM | For billing that requires on demand based auto-debit. |