v2025-01-01
- Overview
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Payment Methods
- Offers
- Settlements
- Simulation
- Utilities
Payments API
Enums
List of all enums used in Payment APIs
Order states
Order State | Description |
---|---|
ACTIVE | Orders are marked as ACTIVE, when an order is created by the merchant through an API request to Telr. |
PAID | Orders are marked PAID when the payment is verified by Telr and the payment is successful. |
EXPIRED | Orders are marked as EXPIRED when the order has exceeded order_expiry_time specified by merchant to complete the order. |
TERMINATED | This status might come ONLY if you request to terminate the Order using [Order Termination API](Order Termination API). This indicates that customers can no longer pay for this order. |
TERMINATION_REQUESTED | This status might come ONLY if you request to terminate the Order using [Order Termination API](Order Termination API). This indicates that you have requested to Terminate the order, however, its still under process. Order gets Terminated only if there’s no transaction in a non-terminal state. If a transaction is in intermediate state and gets success then status can go from TERMINATION_REQUESTED to SUCCESS also. |
Payment states
Payment State | Description |
---|---|
SUCCESS | Transactions are marked as SUCCESS when we get a successful response from the bank, and we can capture the amount in our system. Once payment is marked as SUCCESS , we mark the order as PAID . |
FAILED | Transactions are marked as FAILED when we get a failed response from the bank. |
NOT_ATTEMPTED | Transactions are marked as NOT_ATTEMPTED initially when a transaction is created and an acknowledgement is awaited from the bank. |
PENDING | Transactions are marked as PENDING when we have successfully sent the request to the bank but waiting for a response from the bank. |
FLAGGED | Transactions are marked as FLAGGED if we have identified any risks associated with the transaction. |
CANCELLED | Transactions are marked as CANCELLED when there is success response post time to live. In this case, the amount will be reversed to the customer without any charge being levied to them or the merchant. |
VOID | Transactions are marked as VOID when we do not want to capture the transaction amount. This is only applicable for card-based pre-authorized transactions or to UPI one-time mandates. The amount is reversed immediately in these cases by Telr. |
USER_DROPPED | Transactions are marked as USER_DROPPED when customers drop out of the payment flow without completing the transaction. It will help you understand if customers attempted to pay or not. Some common scenarios where the transaction will be marked as USER_DROPPED are: - Android UPI Intent Payments - when a user clicks on the back button in the UPI app without making any payment attempt. - Card Payments - when a user drops out of the payment flow by closing the OTP verification page. - UPI Collect Transactions - when a user does not enter the UPI PIN and closes the transaction screen |
On this page
Assistant
Responses are generated using AI and may contain mistakes.