--- page_source: https://docs.juspay.io/upi-inapp/android/backend-apis/transaction-list-api page_title: Transaction List API --- ## API Version: default ## Transaction List API This is a Server-to-Server API that takes order_id as a path variable and returns the status of the order along with other details. ## Endpoints: - Sandbox: https://sandbox.juspay.in/orders/{order_id}/txns - Production: https://api.juspay.in/orders/{order_id}/txns ## Request Type: GET ## Content-Type: application/json ## Authorization: #### Basic Auth: Consists of two parts. * Username: API Key obtained from Juspay dashboard * Password: Empty string - Value: Example: MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg== - Tags: Base64 Encoded username:password, required ## Headers: #### x-merchantid: Merchant ID provided by Juspay - Value: Example: merchant-id - Tags: string, required #### version: Pass the date in YYYY-MM-DD format - Value: Example: 2023-01-01 - Tags: string, required ## Sample Code Snippets: ### Code Snippets: #### Shell Code Snippet: ```shell curl --location --request GET 'https://{endpoint}/orders/{order_id}/txns' \ --header 'version: 2021-11-12' \ --header 'x-merchantId: stock' \ --header 'Authorization: Basic MjkyN0V*******DRBOg==' ``` ### Sample Response: #### JSON: ```plaintext { "list": [ { "txn_id": "merchantId-hyperorder2298117-1", "order_id": "hyperorder2298117", "txn_uuid": "eulxwaDcQ4h3AM8ZsSx", "gateway_id": 514, "status": "CHARGED", "gateway": "YES_BIZ", "express_checkout": false, "redirect": true, "net_amount": 1, "surcharge_amount": null, "tax_amount": null, "txn_amount": 1, "currency": "INR", "error_message": "", "error_code": "", "created": "2021-11-23T05:39:37Z", "txn_object_type": "ORDER_PAYMENT", "source_object": "UPI_INAPP", "source_object_id": null, "is_conflicted": false, "is_emi": false, "emi_tenure": 0, "emi_bank": null, "payment_info": { "payment_method_type": "UPI", "payment_method": "UPI", "payer_app_name": "abc303@ypay", "payer_vpa": "abc303@ypay", "auth_type": "" }, "payment_gateway_response": { "created": "2021-11-23T05:39:48Z", "txn_id": "eulxwaDcQ4h3AM8ZsSx", "rrn": null, "epg_txn_id": "YJPc5d51f3bc953485489041e62ee572d3d", "auth_id_code": null, "resp_code": "00", "resp_message": "Your transaction is successful" }, "refunds": [ { "amount": 1, "created": "2021-11-23T19:59:06Z", "last_updated": "2021-11-23T19:59:06Z", "gateway": "YES_BIZ", "epg_txn_id": null, "authorization_id": null, "reference_id": null, "unique_request_id": "erf_1352e9902d049ea8", "status": "PENDING", "error_message": null, "response_code": null, "refund_arn": null, "initiated_by": "merchantId_anjali", "sent_to_gateway": false, "refund_type": "STANDARD", "refund_source": "YES_BIZ", "txn_id": "merchantId-hyperorder2298117-1", "order_id": "hyperorder2298117", "refund_parent_id": null, "is_latest": true, "expected_refund_credit_time": { "max": "2021-12-04T20:00:00Z", "min": "2021-11-24T19:00:00Z" } } ] } ], "count": 1, "offset": 0, "total": 1 } ``` ## API Responses: ### 200: #### txn_id: - Description: The transaction id of the payment attempted - Tags: string #### order_id: - Description: The provided order id - Tags: string #### txn_uuid: - Description: The unique alphanumeric reference id created by Juspay. Can be used for reconciliation in case of UPI - Tags: string #### gateway_id: - Description: The unique id that denotes the gateway used for the transaction. [Complete mapping can be seen here]('https://developer.juspay.in/docs/dynamic-routing#enumerations-and-gateway-ids) - Tags: integer #### gateway: - Description: The name of the gateway used - Tags: string #### express_checkout: - Description: True for saved card transactions. False for all other case - Tags: boolean #### net_amount: - Description: The order amount passed during order creation - Tags: string #### surcharge_amount: - Description: The surcharge amount (applicable only if surcharge rule is applied) - Tags: string #### tax_amount: - Description: Tax amount applied in case of surcharge - Tags: string #### txn_amount: - Description: The transaction amount (same as order amount) - Tags: string #### currency: - Description: The currency passed during order creation. Default is INR - Tags: string #### created: - Description: The transaction created time (in UTC) - Tags: string #### txn_object_type: - Description: The type of transaction. Eg- ORDER_PAYMENT, MANDATE_REGISTER, EMANDATE_REGISTER etc - Tags: string #### source_object: - Description: Can be MANDATE- for mandate transactionUPI_COLLECT- For UPI collect transaction UPI_PAY- For UPI intent transactions UPI_INAPP- For UPI in-app transactions - Tags: string #### source_object_id: - Description: The internal id associated against the source object - Tags: string #### is_conflicted: - Description: If true the transaction is conflicted (late success), If false then transaction is not conflicted - Tags: boolean #### is_emi: - Description: True for EMI transactions, false for non emi transactions - Tags: boolean #### emi_tenure: - Description: EMI tenure passed during transaction. 0 in case of non emi transaction - Tags: integer #### emi_bank: - Description: The EMI bank passed during transaction. Empty in case of non emi transaction - Tags: string #### payment_info: - Description: The json object containing the payment details - Value: - **Payment_info.payment_method_type**: - Description: The payment method type used for the transaction. Would be UPI - Tags: string - **Payment_info.payment_method**: - Description: The payment method type used for the transaction. Would be UPI - Tags: string - **Payment_info.payer_vpa**: - Description: The VPA used by the customer - Tags: string - Tags: JSON #### auth_type: - Description: Empty string for UPI ( THREE_DS/ OTP for card transactions) - Tags: string #### payment_gateway_response: - Description: The json object with the response from the gateway - Value: - **Payment_gateway_response.created**: - Description: The transaction created time - Tags: string - **Payment_gateway_response.rrn**: - Description: The bank reference number provided by the gateway - Tags: string - **Payment_gateway_response.epg_txn_id**: - Description: The PG transaction id - Tags: string - **Payment_gateway_response.txn_id**: - Description: The transaction id created by Juspay - Tags: string - **Payment_gateway_response.resp_code**: - Description: The response code provided by gateway - Tags: string - **Payment_gateway_response.resp_message**: - Description: The response message provided by gateway - Tags: string - Tags: JSON #### refunds: - Description: The refund object with details of the refund. - Value: - **Refunds.amount**: - Description: The refund amount - Tags: string - **Refunds.created**: - Description: The created time of the refund (UTC) - Tags: string - **Refunds.last_updated**: - Description: The gateway through which refund was processed - Tags: string - **Refunds.gateway**: - Description: The gateway through which refund was processed - Tags: string - **Refunds.epg_txn_id**: - Description: The refund id provided by the gateway - Tags: string - **Refunds.reference_id**: - Description: The reference id provided by gateway - Tags: string - **Refunds.unique_request_id**: - Description: The unique request passed during refund creation - Tags: string - **Refunds.status**: - Description: The status of the refund PENDING-Refund is processing SUCCESS- Refund has been successfully executed by the payment processor FAILURE- Refund has failed MANUAL_REVIEW- Refunds which are in pending for more than 15 days are set for manual review - Tags: string - **Refunds.error_message**: - Description: The error message provided by the gateway - Tags: string - **Refunds.response_code**: - Description: The response code provided by gateway - Tags: string - **Refunds.refund_arn**: - Description: The ARN number provided by gateway - Tags: string - **Refunds.initiated_by**: - Description: The source of refund initiation - Tags: string - **Refunds.sent_to_gateway**: - Description: True- if the refunds are initiated to gateway. False- When refunds are in queue at Juspay or initiation has failed - Tags: string - **Refunds.refund_type**: - Description: The type of refund initiated. Possible values- STANDARD / INSTANT - Tags: string - **Refunds.refund_source**: - Description: The name of gateway - Tags: string - **Refunds.order_id**: - Description: The order id against which refund was initiated - Tags: string - **Refunds.txn_id**: - Description: The transaction attempt against which refund was initiated - Tags: string - **Refunds.expected_refund_credit_time**: - Description: Expected refund credit time - Tags: string - Tags: JSON ### 400: #### status: - Description: Bad Request - Tags: string #### error_code: - Description: Details of keys missing - Value: Example: Mandatory fields are missing - Tags: string #### error_message: - Description: Further Details of keys missing - Tags: string ### 401: #### status: - Description: error - Tags: string #### error_code: - Description: access_denied - Tags: string ### 500: #### status: - Description: error - Tags: string #### error_code: - Description: Internal server Error - Tags: string