---
page_source: https://juspay.io/in/docs/ec-headless/cordova/mandates/mandate-order-status-api
page_title: Mandate Order Status API
---

## API Version: default


# Get Mandate Order Status



This is the same API used to check order status of one time debit transactions. The status of the mandate and other mandate related details are included in the response of the same API.


| Transaction Status | ID | Meaning |
|---|---|---|
| NEW | 10 | Newly created order. |
| PENDING_VBV | 23 | Authentication is in progress. The customer has to approve the mandate through the PSP App of their choice. |
| CHARGED | 21 | Successful transaction. The subscription cost of the period has been charged. |
| AUTHENTICATION_FAILED	 | 26 | User did not complete authentication. |
| AUTHORIZATION_FAILED	 | 27 | User completed authentication, but the bank refused the transaction. |
| JUSPAY_DECLINED	 | 22 | User input is not accepted by the underlying PG. |
| AUTHORIZING | 28 | Transaction status is pending from bank. |



| Mandate Status | Description |
|---|---|
| CREATED | Mandate has been created, but awaiting status from PG. |
| ACTIVE | When PG accepts the chosen mode of payment, the mandate is set to the active state. This is a terminal state until mandate expires or customer/merchant wants to revoke the mandate. |
| FAILURE | Mandate creation was unsuccessful. This is a terminal state, the merchant has to create a new mandate if failed. |
## Endpoints:
- Sandbox: https://sandbox.juspay.in/orders/{order_id}

- Production: https://api.juspay.in/orders/{order_id}

## Request Type: 
GET

## Authorization:

#### Basic Auth:
Consists of two parts.

* Username: API Key obtained from Juspay dashboard
* Password: Empty string

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
- Tags: Base64 Encoded Username:Password, Mandatory
## Headers:

#### x-merchantid:
Merchant ID which would have been issues while registering with Juspay
- Tags: string, Required

#### version:
Pass the date in YYYY-MM-DD format.

Note: If a version is provided, the response will include data corresponding to that specific version date.

It is recommended not to enforce strict validation on the entire response on the merchant's side to allow for future key additions.
- Value:  Eg: Sample Value: 2025-01-10
- Tags: String, Optional

#### Content-Type:
application/x-www-form-urlencoded
- Tags: String, Mandatory

#### x-routing-id:
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.

> **Warning**
> This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.


- Value: customer_1122
- Tags: String, Required
## Sample Code Snippets:
### Sample Request:

#### Request - Card Code Snippet:

```request - card
curl GET \
 {host}/orders/635 \
--header 'x-merchantid: merchant' \
--header 'x-routing-id: customer_1122'\
--header 'Authorization: Basic <base64 of key:>'
--header 'version: 2023-06-30'

```

### Sample Response:

#### Card:
```json
{
  "udf9": "",
  "udf8": "",
  "udf7": "",
  "udf6": "",
  "udf5": "",
  "udf4": "",
  "udf3": "",
  "udf2": "",
  "udf10": "",
  "udf1": "",
  "txn_uuid": "eulgDkyqPb1qjey713",
  "txn_id": "merchantId-juspay12281-1",
  "txn_detail": {
    "txn_uuid": "eulgDkyqPb1qjey713",
    "txn_object_type": "MANDATE_REGISTER",
    "txn_id": "merchantId-juspay12281-1",
    "txn_amount": 3,
    "tax_amount": null,
    "surcharge_amount": null,
    "status": "CHARGED",
    "source_object_id": "291",
    "source_object": "MANDATE",
    "redirect": true,
    "order_id": "juspay12281",
    "net_amount": 3,
    "gateway_id": 27,
    "gateway": "BILLDESK",
    "express_checkout": false,
    "error_message": "",
    "error_code": "",
    "currency": "BRL",
    "created": "2021-11-27T12:33:12Z"
  },
  "status_id": 21,
  "status": "CHARGED",
  "return_url": "http://www.juspay.inwsws",
  "refunded": false,
  "product_id": "",
  "payment_method_type": "CARD",
  "payment_method": "VISA",
  "payment_links": {
    "web": "https://api.juspay.io/merchant/pay/ordeu_c1c4139c20a84fa799d1c41cdfbwsws",
    "mobile": "https://api.juspay.io/merchant/pay/ordeu_c1c4139c20a84fa799d1c41cdfb?mobile=truewsws",
    "iframe": "https://api.juspay.io/merchant/ipay/ordeu_c1c4139c20a84fa799d1c41cdfb"
  },
  "payment_gateway_response": {
    "txn_id": "merchantId-juspay12281-1",
    "rrn": "123456",
    "resp_message": "success. Transaction Successful",
    "resp_code": "0300",
    "epg_txn_id": "U4560000327840",
    "created": "2021-11-27T12:34:26Z",
    "auth_id_code": "null"
  },
  "order_id": "juspay12281",
  "offers": [],
  "metadata": {
    "BILLDESK:gateway_reference_id": "billdesk-si-sdx-recurring1"
  },
  "merchant_id": "merchantId",
  "mandate": {
    "start_date": "1638008221",
    "revokable_by_customer": true,
    "max_amount": 100,
    "mandate_type": "MANDATE",
    "mandate_token": "1ceb1dca387e4bbe94343036c",
    "mandate_status": "ACTIVE",
    "mandate_id": "aViohAd242mhkMqT8r5UiwHz",
    "frequency": "ASPRESENTED",
    "end_date": "1640633435",
    "block_fund": false,
    "amount_rule": "VARIABLE"
  },
  "id": "ordeu_c1c4139c20a84fa799d1c41cdfb",
  "gateway_reference_id": "billdesk-si-sdx-recurring1",
  "gateway_id": 27,
  "effective_amount": 3,
  "date_created": "2021-11-27T12:30:49Z",
  "customer_phone": "9876543210",
  "customer_id": "cst_zqqmw0vrfbhvvj2zzdzg",
  "customer_email": "test@juspay.in",
  "currency": "BRL",
  "card": {
    "using_token": false,
    "using_saved_card": false,
    "saved_to_locker": false,
    "name_on_card": "test",
    "last_four_digits": "",
    "expiry_year": "2029",
    "expiry_month": "12",
    "card_type": "DEBIT",
    "card_reference": "",
    "card_issuer": "HDFC BANK",
    "card_isin": "459150",
    "card_fingerprint": "",
    "card_brand": "VISA"
  },
  "bank_pg": null,
  "bank_error_message": "",
  "bank_error_code": "",
  "auth_type": "THREE_DS",
  "amount_refunded": 0,
  "amount": 3
}
```

## Path Parameters:

#### order_id:
Order Id for which you want check mandate order status
- Value: Example:- ord_234823498237423894273498
- Tags: String, Mandatory
## API Responses:
### 200:

#### UPI:
- Value:
  - **Udf1-10**:
    - Tags: String
  - **Txn_uuid**:
    - Description: Transaction UUID
    - Tags: String
  - **Txn_id**:
    - Description: Transaction ID
    - Tags: String
  - **Txn_detail**:
    - Value:
      - **Txn_uuid**:
        - Description: Transaction UUID
        - Tags: String
      - **Txn_object_type**:
        - Tags: String
      - **Txn_id**:
        - Tags: String
      - **Txn_amount**:
        - Tags: String
      - **Tax_amount**:
        - Tags: String
      - **Surcharge_amount**:
        - Tags: String
      - **Status**:
        - Tags: String
      - **Source_object_id**:
        - Tags: String
      - **Source_object**:
        - Tags: String
      - **Redirect**:
        - Tags: boolean
      - **Order_id**:
        - Description: Unique Identifier for the order.
        - Tags: String
      - **Net_amount**:
        - Tags: Integer
      - **Gateway_id**:
        - Tags: Integer
      - **Gateway**:
        - Tags: String
      - **Express_checkout**:
        - Tags: Boolean
      - **Error_message**:
        - Tags: String
      - **Error_code**:
        - Tags: String
      - **Currency**:
        - Description: ISO string of the currency.
        - Tags: String
      - **Created**:
        - Tags: String
    - Tags: object
  - **Status_id**:
    - Description: Status ID is a numeric id corresponding to the status value.
    - Tags: Integer
  - **Status**:
    - Description: Status of the order. If you receive “NEW”, then the order is successfully created.
    - Tags: String
  - **Return_url**:
    - Description: A fully qualified URL such as [http://shop.merchant.com/](http://shop.merchant.com/) to which the customer will be redirected after payment completion.
    - Tags: String
  - **Refunded**:
    - Tags: Boolean
  - **Product_id**:
    - Description: An identifier for the product on the Lender side for which the payment is being done. This field is just echoed back in the response so that Lender can differentiate on their side.
    - Tags: String
  - **Payment_method_type**:
    - Description: Payment method type used at the time of creating a mandate
    - Tags: String
  - **Payment_method**:
    - Description: Payment method used at the time of creating a mandate
    - Tags: String
  - **Payment_links**:
    - Description: Contains 3 strings that link to a Desktop optimized, Mobile optimized as well as iFrame checkout screen for the given order.
    - Value:
      - **Web**:
        - Tags: String
      - **Mobile**:
        - Tags: String
      - **Iframe**:
        - Tags: String
    - Tags: Object
  - **Payment_gateway_response**:
    - Value:
      - **Txn_id**:
        - Tags: String
      - **Rrn**:
        - Tags: String
      - **Resp_message**:
        - Tags: String
      - **Resp_code**:
        - Tags: String
      - **Epg_txn_id**:
        - Tags: String
      - **Created**:
        - Tags: String
      - **Auth_id_code**:
        - Tags: String
    - Tags: object
  - **Payer_vpa**:
    - Description: Payer VPA used during setting up mandate
    - Tags: String
  - **Order_id**:
    - Description: Unique Identifier for the order.
    - Tags: String
  - **Metadata**:
    - Value:
      - **PAYTM_V2:gateway_reference_id**:
        - Tags: String
    - Tags: Object
  - **Mandate**:
    - Value:
      - **Start_date**:
        - Description: Mandate start date. The value that is passed during order creation
        - Tags: String
      - **Rule_value**:
        - Description: Rule value
        - Tags: Integer
      - **Rule_type**:
        - Description: Rule Type
        - Tags: String
      - **Revokable_by_customer**:
        - Description: Mandate revocable by customer
        - Tags: boolean
      - **Max_amount**:
        - Description: Mandate max amount
        - Tags: integer
      - **Mandate_type**:
        - Description: Type of Mandate. Example: EMANDATE
        - Tags: String
      - **Mandate_token**:
        - Description: Mandate token sent by Juspay after mandate creation
        - Tags: String
      - **Mandate_status**:
        - Description: Status of the Mandate. Will be ACTIVE if the mandate is successfully setup
        - Tags: String
      - **Mandate_id**:
        - Description: Mandate id sent by Juspay after mandate creation
        - Tags: String
      - **Frequency**:
        - Description: Mandate frequency
        - Tags: String
      - **End_date**:
        - Description: Mandate end data.The value that is passed during order creation
        - Tags: String
      - **Block_fund**:
        - Description: Mandate block fund
        - Tags: boolean
      - **Amount_rule**:
        - Description: Amount rule
        - Tags: String
    - Tags: Object
  - **Id**:
    - Description: Unique ID generated by Juspay for the given order.
    - Tags: String
  - **Gateway_reference_id**:
    - Tags: String
  - **Gateway_id**:
    - Tags: integer
  - **Date_created**:
    - Tags: String
  - **Customer_phone**:
    - Description: Mobile number or fixed line number of the customer.
    - Tags: String
  - **Customer_id**:
    - Description: Customer Identifier against which a mandate should be created. This has to be unique for a customer
    - Tags: String
  - **Customer_email**:
    - Description: Email address of the customer.
    - Tags: String
  - **Currency**:
    - Description: ISO string of the currency.
    - Tags: String
  - **Bank_error_message**:
    - Description: Bank Error Message
    - Tags: String
  - **Bank_error_code**:
    - Description: Bank Error Code
    - Tags: String
  - **Auth_type**:
    - Description: Type of authentication used
    - Tags: String
  - **Amount_refunded**:
    - Description: The amount that was refunded
    - Tags: Integer
  - **Amount**:
    - Description: This is the amount that a customer will be charged in this transaction.
    - Tags: Integer
- Tags: JSON

#### Card:
- Value:
  - **Udf1-10**:
    - Tags: String
  - **Txn_uuid**:
    - Description: Transaction UUID
    - Tags: String
  - **Txn_id**:
    - Description: Transaction ID
    - Tags: String
  - **Txn_detail**:
    - Value:
      - **Txn_uuid**:
        - Description: Transaction UUID
        - Tags: String
      - **Txn_object_type**:
        - Tags: String
      - **Txn_id**:
        - Tags: String
      - **Txn_amount**:
        - Tags: String
      - **Tax_amount**:
        - Tags: String
      - **Surcharge_amount**:
        - Tags: String
      - **Status**:
        - Tags: String
      - **Source_object_id**:
        - Tags: String
      - **Source_object**:
        - Tags: String
      - **Redirect**:
        - Tags: boolean
      - **Order_id**:
        - Description: Unique Identifier for the order.
        - Tags: String
      - **Net_amount**:
        - Tags: Integer
      - **Gateway_id**:
        - Tags: Integer
      - **Gateway**:
        - Tags: String
      - **Express_checkout**:
        - Tags: Boolean
      - **Error_message**:
        - Tags: String
      - **Error_code**:
        - Tags: String
      - **Currency**:
        - Description: ISO string of the currency.
        - Tags: String
      - **Created**:
        - Tags: String
    - Tags: object
  - **Status_id**:
    - Description: Status ID is a numeric id corresponding to the status value.
    - Tags: Integer
  - **Status**:
    - Description: Status of the order. If you receive “NEW”, then the order is successfully created.
    - Tags: String
  - **Return_url**:
    - Description: A fully qualified URL such as [http://shop.merchant.com/](http://shop.merchant.com/) to which the customer will be redirected after payment completion.
    - Tags: String
  - **Refunded**:
    - Tags: Boolean
  - **Product_id**:
    - Description: An identifier for the product on the Lender side for which the payment is being done. This field is just echoed back in the response so that Lender can differentiate on their side.
    - Tags: String
  - **Payment_method_type**:
    - Description: Payment method type used at the time of creating a mandate
    - Tags: String
  - **Payment_method**:
    - Description: Payment method used at the time of creating a mandate
    - Tags: String
  - **Payment_links**:
    - Description: Contains 3 strings that link to a Desktop optimized, Mobile optimized as well as iFrame checkout screen for the given order.
    - Value:
      - **Web**:
        - Tags: String
      - **Mobile**:
        - Tags: String
      - **Iframe**:
        - Tags: String
    - Tags: Object
  - **Payment_gateway_response**:
    - Value:
      - **Txn_id**:
        - Tags: String
      - **Rrn**:
        - Tags: String
      - **Resp_message**:
        - Tags: String
      - **Resp_code**:
        - Tags: String
      - **Epg_txn_id**:
        - Tags: String
      - **Created**:
        - Tags: String
      - **Auth_id_code**:
        - Tags: String
    - Tags: object
  - **Offers**:
    - Description: Payer VPA used during setting up mandate
    - Tags: array
  - **Order_id**:
    - Description: Unique Identifier for the order.
    - Tags: String
  - **Metadata**:
    - Value:
      - **BILLDESK:gateway_reference_id**:
        - Tags: String
    - Tags: Object
  - **Mandate**:
    - Value:
      - **Start_date**:
        - Description: Mandate start date. The value that is passed during order creation
        - Tags: String
      - **Revokable_by_customer**:
        - Description: Mandate revocable by customer
        - Tags: boolean
      - **Max_amount**:
        - Description: Mandate max amount
        - Tags: integer
      - **Mandate_type**:
        - Description: Type of Mandate. Example: EMANDATE
        - Tags: String
      - **Mandate_token**:
        - Description: Mandate token sent by Juspay after mandate creation
        - Tags: String
      - **Mandate_status**:
        - Description: Status of the Mandate. Will be ACTIVE if the mandate is successfully setup
        - Tags: String
      - **Mandate_id**:
        - Description: Mandate id sent by Juspay after mandate creation
        - Tags: String
      - **Frequency**:
        - Description: Mandate frequency
        - Tags: String
      - **End_date**:
        - Description: Mandate end data.The value that is passed during order creation
        - Tags: String
      - **Block_fund**:
        - Description: Mandate block fund
        - Tags: boolean
      - **Amount_rule**:
        - Description: Amount rule
        - Tags: String
    - Tags: Object
  - **Id**:
    - Description: Unique ID generated by Juspay for the given order.
    - Tags: String
  - **Gateway_reference_id**:
    - Tags: String
  - **Gateway_id**:
    - Tags: integer
  - **Date_created**:
    - Tags: String
  - **Customer_phone**:
    - Description: Mobile number or fixed line number of the customer.
    - Tags: String
  - **Customer_id**:
    - Description: Customer Identifier against which a mandate should be created. This has to be unique for a customer
    - Tags: String
  - **Customer_email**:
    - Description: Email address of the customer.
    - Tags: String
  - **Currency**:
    - Description: ISO string of the currency.
    - Tags: String
  - **Card**:
    - Value:
      - **Using_token**:
        - Tags: boolean
      - **Using_saved_card**:
        - Tags: boolean
      - **Saved_to_locker**:
        - Tags: boolean
      - **Name_on_card**:
        - Tags: String
      - **Last_four_digits**:
        - Tags: String
      - **Expiry_year**:
        - Tags: String
      - **Expiry_month**:
        - Tags: String
      - **Card_type**:
        - Tags: String
      - **Card_reference**:
        - Tags: String
      - **Card_issuer**:
        - Tags: String
      - **Card_isin**:
        - Tags: String
      - **Card_fingerprint**:
        - Tags: String
      - **Card_brand**:
        - Tags: String
    - Tags: object
  - **Auth_type**:
    - Description: Type of authentication used
    - Tags: String
  - **Amount_refunded**:
    - Description: The amount that was refunded
    - Tags: Integer
  - **Amount**:
    - Description: This is the amount that a customer will be charged in this transaction.
    - Tags: Integer
  - **Bank_error_message**:
    - Description: Bank Error Message
    - Tags: String
  - **Bank_pg**:
    - Tags: String
  - **Bank_error_code**:
    - Description: Bank Error Code
    - Tags: String
- Tags: JSON

#### NB:
- Value:
  - **Udf1-10**:
    - Tags: String
  - **Txn_uuid**:
    - Description: Transaction UUID
    - Tags: String
  - **Txn_id**:
    - Description: Transaction ID
    - Tags: String
  - **Txn_detail**:
    - Value:
      - **Txn_uuid**:
        - Description: Transaction UUID
        - Tags: String
      - **Txn_object_type**:
        - Tags: String
      - **Txn_id**:
        - Tags: String
      - **Txn_amount**:
        - Tags: String
      - **Tax_amount**:
        - Tags: String
      - **Surcharge_amount**:
        - Tags: String
      - **Status**:
        - Tags: String
      - **Source_object_id**:
        - Tags: String
      - **Source_object**:
        - Tags: String
      - **Redirect**:
        - Tags: boolean
      - **Order_id**:
        - Description: Unique Identifier for the order.
        - Tags: String
      - **Net_amount**:
        - Tags: Integer
      - **Gateway_id**:
        - Tags: Integer
      - **Gateway**:
        - Tags: String
      - **Express_checkout**:
        - Tags: Boolean
      - **Error_message**:
        - Tags: String
      - **Error_code**:
        - Tags: String
      - **Currency**:
        - Description: ISO string of the currency.
        - Tags: String
      - **Created**:
        - Tags: String
    - Tags: object
  - **Status_id**:
    - Description: Status ID is a numeric id corresponding to the status value.
    - Tags: Integer
  - **Status**:
    - Description: Status of the order. If you receive “NEW”, then the order is successfully created.
    - Tags: String
  - **Return_url**:
    - Description: A fully qualified URL such as [http://shop.merchant.com/](http://shop.merchant.com/) to which the customer will be redirected after payment completion.
    - Tags: String
  - **Refunded**:
    - Tags: Boolean
  - **Product_id**:
    - Description: An identifier for the product on the Lender side for which the payment is being done. This field is just echoed back in the response so that Lender can differentiate on their side.
    - Tags: String
  - **Payment_method_type**:
    - Description: Payment method type used at the time of creating a mandate
    - Tags: String
  - **Payment_method**:
    - Description: Payment method used at the time of creating a mandate
    - Tags: String
  - **Payment_links**:
    - Description: Contains 3 strings that link to a Desktop optimized, Mobile optimized as well as iFrame checkout screen for the given order.
    - Value:
      - **Web**:
        - Tags: String
      - **Mobile**:
        - Tags: String
      - **Iframe**:
        - Tags: String
    - Tags: Object
  - **Payment_gateway_response**:
    - Value:
      - **Txn_id**:
        - Tags: String
      - **Rrn**:
        - Tags: String
      - **Resp_message**:
        - Tags: String
      - **Resp_code**:
        - Tags: String
      - **Epg_txn_id**:
        - Tags: String
      - **Created**:
        - Tags: String
      - **Auth_id_code**:
        - Tags: String
    - Tags: object
  - **Merchant_id**:
    - Tags: String
  - **Order_id**:
    - Description: Unique Identifier for the order.
    - Tags: String
  - **Metadata**:
    - Tags: string
  - **Mandate**:
    - Value:
      - **Revokable_by_customer**:
        - Description: Mandate revocable by customer
        - Tags: boolean
      - **Max_amount**:
        - Description: Mandate max amount
        - Tags: integer
      - **Mandate_type**:
        - Description: Type of Mandate. Example: EMANDATE
        - Tags: String
      - **Mandate_token**:
        - Description: Mandate token sent by Juspay after mandate creation
        - Tags: String
      - **Mandate_status**:
        - Description: Status of the Mandate. Will be ACTIVE if the mandate is successfully setup
        - Tags: String
      - **Mandate_id**:
        - Description: Mandate id sent by Juspay after mandate creation
        - Tags: String
      - **Frequency**:
        - Description: Mandate frequency
        - Tags: String
      - **Bank_details**:
        - Value:
          - **Ifsc**:
            - Description: IFSC Code of the bank
            - Tags: String
          - **Beneficiary_name**:
            - Description: Account holder name
            - Tags: String
          - **Bank_name**:
            - Description: Bank name
            - Tags: String
          - **Account_number**:
            - Description: Bank account number
            - Tags: String
        - Tags: object
      - **Block_fund**:
        - Description: Mandate block fund
        - Tags: boolean
      - **Amount_rule**:
        - Description: Amount rule
        - Tags: String
    - Tags: Object
  - **Id**:
    - Description: Unique ID generated by Juspay for the given order.
    - Tags: String
  - **Gateway_reference_id**:
    - Tags: String
  - **Gateway_id**:
    - Tags: integer
  - **Date_created**:
    - Tags: String
  - **Customer_phone**:
    - Description: Mobile number or fixed line number of the customer.
    - Tags: String
  - **Customer_id**:
    - Description: Customer Identifier against which a mandate should be created. This has to be unique for a customer
    - Tags: String
  - **Customer_email**:
    - Description: Email address of the customer.
    - Tags: String
  - **Currency**:
    - Description: ISO string of the currency.
    - Tags: String
  - **Bank_error_message**:
    - Description: Bank Error Message
    - Tags: String
  - **Bank_error_code**:
    - Description: Bank Error Code
    - Tags: String
  - **Auth_type**:
    - Description: Type of authentication used
    - Tags: String
  - **Amount_refunded**:
    - Description: The amount that was refunded
    - Tags: Integer
  - **Amount**:
    - Description: This is the amount that a customer will be charged in this transaction.
    - Tags: Integer
- Tags: JSON