---
page_source: https://docs.juspay.io/upi-inapp/android/headless-process-payloads/transaction-status
page_title: Transaction Status
---


## Transaction Status



This api will be used for getting status of a transaction.


###   Process Parameters



## Request Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String, Mandatory
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String, Mandatory
- **Payload**:
  - Description: Parameters required to call Hyper SDK API
  - Value:
    - **Action**:
      - Description: Operation to be performed in the SDK
      - Value: upiTransactionStatus
      - Tags: String, Mandatory
    - **UpiRequestId**:
      - Description: Unique identifier (uuid) for the request sent to NPCI
      - Tags: String, Mandatory
    - **Vpa**:
      - Description: Payer Vpa
      - Value: Example: abc@xyz
      - Tags: String, Mandatory
    - **MerchanKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Tags: String, Mandatory
    - **SignaturePayload**:
      - Description: Signature payload is a stringified JSON of the details mentioned in the below table.
      - Value:
        - **Merchant_id**:
          - Description: Unique identifier associated with an account created by juspay. Ex: stock
          - Value: stock
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Tags: String, Mandatory
      - Tags: String, Mandatory
    - **Signature**:
      - Description: Signature generated for the signaturePayload .
      - Tags: String, Mandatory
    - **UdfParameters**:
      - Description: Stringified json for udf parameters
      - Tags: String, Optional
  - Tags: JSON, Mandatory


## Response Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String
- **Payload**:
  - Description: Response Parameters
  - Value:
    - **Action**:
      - Description: Operation performed in the SDK
      - Value: upiTransactionStatus
      - Tags: String, Mandatory
    - **Status**:
      - Description: Status of the API
      - Value: SUCCESS / FAILURE / PENDING
      - Tags: String, Mandatory
    - **ResponseCode**:
      - Description: PSP response code for the API
      - Tags: String, Mandatory
    - **ResponseMessage**:
      - Description: PSP response message for the API
      - Tags: String, Mandatory
    - **TransactionStatus**:
      - Value:
        - **Amount**:
          - Description: Transaction Amount. Numeric String with two decimals
          - Value: eg. 25.00
          - Tags: String, Mandatory
        - **BankAccountUniqueId**:
          - Description: Unique Identifier for bank account across banks
          - Tags: String, Mandatory
        - **BankCode**:
          - Description: IIN Code for the bank
          - Tags: String, Mandatory
        - **CustomResponse**:
          - Tags: String, Optional
        - **GatewayReferenceId**:
          - Description: upiResponseId as passed in request
          - Tags: String, Mandatory
        - **GatewayResponseCode**:
          - Description: Response Code received from NPCI
          - Tags: String, Mandatory
        - **GatewayResponseMessage**:
          - Description: Response Message received from NPCI
          - Tags: String, Mandatory
        - **GatewayTransactionId**:
          - Description: upiRequestId as passed in request
          - Tags: String, Mandatory
        - **MaskedAccountNumber**:
          - Description: Account Number with last few digits visible
          - Tags: String, Mandatory
        - **MerchantCustomerId**:
          - Description: Merchant generated unique profile id for customer as passed in the request
          - Tags: String, Mandatory
        - **MerchantId**:
          - Description: Unique id for the merchant as passed in request
          - Tags: String, Mandatory
        - **PayeeMcc**:
          - Tags: String, Optional
        - **PayeeMerchantCustomerId**:
          - Tags: String, Optional
        - **PayeeMobileNumber**:
          - Tags: String, Optional
        - **PayeeVpa**:
          - Tags: String, Mandatory
        - **PayerMerchantCustomerId**:
          - Tags: String, Optional
        - **PayerName**:
          - Tags: String, Optional
        - **PayerVpa**:
          - Tags: String, Mandatory
        - **RefUrl**:
          - Tags: String, Optional
        - **TransactionTimestamp**:
          - Tags: String, Optional
        - **Type**:
          - Tags: String, Mandatory
      - Tags: JSON, Mandatory
    - **OtherInfo**:
      - Description: As passed in request
      - Tags: String, Optional
  - Tags: JSON
- **Error**:
  - Description: Possible values :- true/false
  - Tags: Boolean
- **ErrorMessage**:
  - Description: Error Message
  - Tags: String
- **ErrorCode**:
  - Description: Error Code
  - Tags: String
- **Event**:
  - Description: Value: process_result
  - Tags: String





#### Code Snippets: -

#### Java Code Snippet:

```java
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiTransactionStatus",
    "merchantKeyId": "1234",
    "upiRequestId": "<UPI Request Id>",
    "vpa": "abc@xyz",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "XXXXXXXX",
  "timestamp": "1639147293629"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiTransactionStatus",
    "merchantKeyId": "1234",
    "upiRequestId": "<UPI Request Id>",
    "vpa": "abc@xyz",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "XXXXXXXX",
  "timestamp": "1639147293629"
}
```


## Sample Code Snippets:
### Request snippets:

#### Request Code Snippet:

```request
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiTransactionStatus",
    "merchantKeyId": "1234",
    "upiRequestId": "<UPI Request Id>",
    "vpa": "abc@xyz",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "XXXXXXXX",
  "timestamp": "1639147293629"
}
```

### Response snippets:

#### Response:
```plaintext
{
  "service": "in.juspay.hyperapi",
  "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677",
  "payload": {
    "status": "SUCCESS",
    "action": "upiTransactionStatus",
    "responseMessage": "SUCCESS",
    "responseCode": "SUCCESS",
    "transactionStatus": {
      "maskedAccountNumber": "XXXXXXXXXXXXXXXX",
      "merchantCustomerId": "1234567891",
      "merchant_id": "stock",
      "payeeVpa": "abc@xyz",
      "payerVpa": "something@handle",
      "type": ""
      "gatewayTransactionId": "XXXXXXXXXXXXXXXX",
      "gatewayResponseMessage": "Payment success",
      "gatewayResponseCode": "00",
      "gatewayReferenceId": "XXXXXXXXXXX",
      "customerVpa": "XXXXXXXX@XXXXXX",
      "customerMobileNumber": "XXXXXXXXX",
      "bankCode": "500007",
      "bankAccountUniqueId": "XXXXXXXXXXXXXXXXXXXXXXXXX",
      "amount": "1.00",
      "refUrl": "www.google.com"
    },
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}
```