---
page_source: https://docs.juspay.io/upi-inapp/android/backend-apis/incoming-mandate-status
page_title: Incoming Mandate Status
---

## API Version: default


## Incoming Mandates Status



This is a Server-to-Server API that takes org_mandate_id and issuing_psp as a path variable and returns the status of the order along with other details. ## Endpoints:
- Sandbox: https://sandbox.juspay.in/upi/inapp/mandate/status

- Production: https://api.juspay.in/upi/inapp/mandate/status

## Request Type: 
GET

## Content-Type: 
application/json

## Headers:

#### x-merchantid:
Merchant ID provided by Juspay
- Value: Example: merchant-id
- Tags: string, required
## Sample Code Snippets:
### Code Snippets:

#### Shell Code Snippet:

```shell
curl --location --request GET '{endpoint}/upi/inapp/mandate/status?org_mandate_id={orgMandateId}&issuing_psp={issuingPsp}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header'x-merchantid: stock '
```

### Sample Response:

#### JSON:
```plaintext
{
   "upi": {
       "merchant_channel_id": "GROWWUATAPP",
       "payee_name": "JUSPAY_TEST",
       "merchant_id": "GROWWUAT",
       "upi_app": "YES_BIZ",
       "payee_mcc": "1520",
       "payer_vpa": "abcaa88170@ypay",
       "payee_vpa": "growwuat@ypay"
   },
   "transaction": {
       "umn": "1c5bf9a8cda94052ae3a96e4640747c0@ypay",
       "ref_url": "https://www.juspay.com/",
       "merchant_request_id": "958006824001836469359888",
       "gateway_response_status": "SUCCESS",
       "gateway_response_code": "00",
       "gateway_reference_id": "205515966548"
   },
   "remarks": "Debit Money For UPI Autopay",
   "payment_method_type": "UPI",
   "payment_method": "UPI",
   "message": "Mandate is in active state",
   "merchant_customer_id": "3a77ead9-d8fd-44cc-9188-debe285ebb42",
   "mandate": {
       "initiated_by": "PAYEE",
       "transaction_type": "UPI_MANDATE",
       "validity_end": "2031/07/28",
       "gateway_mandate_id": "YJP11gsqszvoufoceulauTfJQFDwLgreWnY",
       "share_to_payee": true,
       "mandate_name": "Nothing",
       "org_mandate_id": "YJP11gsqszvoufoceulauTfJQFDwLgreWnY",
       "role": "PAYER",
       "recurrence_pattern": "ASPRESENTED",
       "mandate_approval_timestamp": "2022-02-24T15:42:33Z",
       "validity_start": "2022/02/25",
       "amount_rule": "VARIABLE",
       "block_fund": false,
       "payer_revocable": true,
       "mandate_timestamp": "2022-02-24T15:38:51Z",
       "mandate_type": "CREATE"
   },
   "amount": "100.00"
}

```

## Query Parameters:

#### org_mandate_id:
Org mandate id of the mandate
- Value: Example: YJP11gsqszvoufoceulauTfJQFDwLgreWnY
- Tags: string, required

#### issuing_psp:
Issuing psp name
- Value: Example: YES_BIZ
- Tags: string, required
## API Responses:
### 200:

#### payer_vpa:
- Description: Vpa of the upi user who sent the payment.
- Tags: string

#### payer_merchant_customer_id:
- Description: Merchant generated unique id for customer who sent the payment.
- Tags: string

#### payee_vpa:
- Description: Vpa of the upi user who received the payment.
- Tags: string

#### payee_mcc:
- Description: payee Merchant Category Code
- Tags: integer

#### merchant_id:
- Description: Unique id for merchant.
- Tags: string

#### merchant_channel_id:
- Description: Unique id for the channel via which request is made.
- Tags: string

#### masked_account_number:
- Description: Masked account number for the customer bank account used for transaction. Only if gatewayResponseCode is non 'U69'.
- Tags: string

#### bank_code:
- Description: IIN for the customer bank account used for transaction. Only if gatewayResponseCode is non 'U69'.
- Tags: string

#### bank_account_unique_id:
- Description: Unique hash for the customer bank account used for transaction. Only if gatewayResponseCode is non 'U69'.
- Tags: string

#### ref_url:
- Description: Invoice as sent by merchant or reference to the transaction in the form of url.
- Tags: string

#### merchant_request_id:
- Description: Merchant generated request id as passed in the collect request. Only if gatewayResponseCode is not 'U69'.
- Tags: string

#### gateway_transaction_id:
- Description: UPI request id returned by gateway for the transaction.
- Tags: string

#### gateway_response_code:
- Description: Response code returned by gateway for the transaction. [Click here](../resources/error-codes) for mandate gateway response codes.
- Tags: string

#### gateway_reference_id:
- Description: Customer reference number (rrn) for the transaction.
- Tags: string

#### message:
- Description: response message returned by gateway for the transaction.
- Tags: string

#### date_created:
- Description: Timestamp of when the payment
- Tags: string

#### amount:
- Description: Amount for which customer made the payment.
- Tags: double

#### mandate:
- Description: Object containing mandate details
- Tags: JSON
### 400:

#### status:
- Description: Bad Request

#### error_code:
- Description: Details of keys missing
- Value: Example: Mandatory fields are missing

#### error_message:
- Description: Further Details of keys missing
### 401:

#### status:
- Description: error

#### error_code:
- Description: access_denied
### 500:

#### status:
- Description: error

#### error_code:
- Description: Internal server Error