---
page_source: https://docs.juspay.io/upi-inapp/android/headless-process-payloads/list-transactions
page_title: List Transactions
---


## List Transactions



This api will be used for getting a list of transactions.


###   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: upiTransactionList
      - Tags: String, Mandatory
    - **Offset**:
      - Description: Offset to be applied on transaction list
      - Value: eg : 0
      - Tags: Int, Mandatory
    - **Limit**:
      - Description: Number of transactions to be fetched at once.
      - Value: eg : 20
      - Tags: Int, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Tags: String, Mandatory
    - **SignaturePayload**:
      - Description: Stingified JSON
      - Value:
        - **Merchant_id**:
          - Description: Unique identifier associated with an account created by juspay. Ex: 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
      - Value: <signature>
      - 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: upiTransactionList
      - Tags: String, Mandatory
    - **Status**:
      - Description: If upiTransactionList was success or failed
      - Value: SUCCESS / FAILURE
      - Tags: String, Mandatory
    - **MerchantId**:
      - Description: Unique merchant id shared during onboarding
      - Value: <merchant_id>
      - Tags: String, Mandatory
    - **MerchantChannelId**:
      - Tags: String, Mandatory
    - **MerchantCustomerId**:
      - Description: Merchant generated unique profile id for customer as passed in the request
      - Tags: String, Mandatory
    - **TxnList**:
      - Description: Array of JSON containing all transaction related data .
      - Value:
        - **Amount**:
          - Description: Amount for which the particular transaction was executed. Numeric String with two decimals
          - Value: eg : 5000
          - Tags: String, Mandatory
        - **GatewayReferenceId**:
          - Tags: String, Mandatory
        - **GatewayResponseCode**:
          - Description: Response Code received from NPCI
          - Tags: String, Mandatory
        - **GatewayTransactionId**:
          - Description: upiRequestId as passed in request
          - Tags: String, Mandatory
        - **PayeeName**:
          - Description: Payee Name
          - Tags: String, Mandatory
        - **PayeeVpa**:
          - Description: Payee Vpa
          - Tags: String, Optional
        - **PayerName**:
          - Description: Payer Name
          - Tags: String, Optional
        - **PayerVpa**:
          - Description: Payer Vpa
          - Tags: String, Optional
        - **Remarks**:
          - Description: Remarks for this transaction
          - Tags: String, Mandatory
        - **TransactionTimestamp**:
          - Description: Time at which this transaction was executed.
          - Tags: String, Mandatory
        - **Type**:
          - Description: Type of transaction.
          - Tags: String, Mandatory
        - **IsP2MTransaction**:
          - Description: If the transaction was P2M transaction or P2P transaction
          - Value: true / false
          - Tags: Boolean, Mandatory
        - **Expiry**:
          - Description: Time after which the transaction would expire
          - Tags: String, Optional
        - **RefUrl**:
          - Tags: String, Optional
        - **RefCategory**:
          - Tags: String, Optional
        - **GatewayResponseMessage**:
          - Description: Response Message received from NPCI
          - Tags: String, Optional
        - **MerchantRequestId**:
          - Description: Merchant generated id for the mandate request.
          - Tags: String, Optional
        - **SelfInitiated**:
          - Description: If this transaction was self initiated or not
          - Tags: String, Optional
      - Tags: Array of JSON, Mandatory
  - 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
{
  "service": "in.juspay.hyperapi",
  "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f",
  "payload": {
    "signaturePayload": "<Stringified signature payload used for signature generation>",
    "signature": "GFe…………………..w==",
    "merchantKeyId": "1234",
    "limit": "100",
    "offset": "0",
    "action": "upiTransactionList"
  }
}

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

#### Kotlin Code Snippet:

```kotlin
{
  "service": "in.juspay.hyperapi",
  "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f",
  "payload": {
    "signaturePayload": "<Stringified signature payload used for signature generation>",
    "signature": "GFe…………………..w==",
    "merchantKeyId": "1234",
    "limit": "100",
    "offset": "0",
    "action": "upiTransactionList"
  }
}

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


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

#### Request Code Snippet:

```request
{
  "service": "in.juspay.hyperapi",
  "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f",
  "payload": {
    "signaturePayload": "<Stringified signature payload used for signature generation>",
    "signature": "GFe…………………..w==",
    "merchantKeyId": "1234",
    "limit": "100",
    "offset": "0",
    "action": "upiTransactionList"
  }
}

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

### Response snippets:

#### Response:
```plaintext
{
  "service": "in.juspay.hyperapi",
  "requestId": "621e5bc9-a06a-4593-a16a-1be7d01d1cac",
  "payload": {
    "status": "SUCCESS",
    "merchantChannelId": "STOCKAPP"
    "merchantCustomerId": "9876543210"
    "merchantId": "stock"
    "txnList": [
      { 
        <transaction Payload>
      }, 
      { 
        <transaction Payload>
      }
    ],
    "action": "upiTransactionList"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}
```