---
page_source: https://juspay.io/in/docs/upi-plugin-direct-psp/android/miscellaneous/get-session-token
page_title: Get Session Token
---


# Get Session Token




###   Process Parameters


> **Note**
> Status Description
> 
> NOPERMISSION - User has not given necessary permissions yet (Phone State). FRESH - Necessary permissions are provided but the user is not registered. BOUND - User registered on device but no accounts are found. LINKED - User registered on device and valid accounts are found.




## 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: upiGetSessionToken
      - Tags: String, Mandatory
    - **Signature**:
      - Description: Base 64 encoding of signaturePayload and Protected .
      - Tags: String, Mandatory
    - **Protected**:
      - Description: Base 64 encoding of the below parameters.
      - Value:
        - **Kid**:
          - Description: Key ID to identify the public-private key pair used for signature generation.It will be provided to you by the Juspay team.
          - Value: Example: uat833359804655bb748702e324111
          - Tags: String, Mandatory
        - **Alg**:
          - Description: Asymmetric algorithm used. Will be RS256 in this case..
          - Value: RS256
          - Tags: String, Mandatory
      - Tags: String, Mandatory
    - **SignaturePayload**:
      - Description: Base 64 encoded stringified signature payload
      - Value:
        - **MerchantId**:
          - Description: Unique identifier associated with an account created by juspay.Ex: stock
          - Tags: String, Mandatory
        - **MerchantCustomerId**:
          - Description: Merchant generated unique profile id for the customer.
          - Tags: String, Mandatory
        - **MerchantChannelId**:
          - Description: As provided by Juspay.
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Tags: String, Mandatory
      - Tags: String, Mandatory
  - 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: upiGetSessionToken
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED.
      - Tags: String
    - **IsDeviceBound**:
      - Description: If the current device is in bound state or not.
      - Value: Possible values: true/false
      - Tags: String
    - **IsDeviceActivated**:
      - Description: If the device is in active state or not
      - Value: Possible values: true/false
      - Tags: String
    - **Prefix**:
      - Description: Prefix to append before requestID
      - Value: Example: ABC
      - Tags: String
    - **VpaAccounts**:
      - Description: It's an array of Vpa Accounts. We will get this only after successful linking of accounts.
      - Value:
        - **Vpa**:
          - Description: Vpa
          - Tags: String
        - **Accounts**:
          - Description: Accounts linked to this vpa
          - Value:
            - **BankCode**:
              - Description: IIN Code for the bank
              - Tags: String
            - **BankName**:
              - Description: Name of bank
              - Tags: String
            - **MaskedAccountNumber**:
              - Description: Account Number with last few digits visible
              - Tags: String
            - **MpinLength**:
              - Description: Length of mpin
              - Tags: String
            - **MpinSet**:
              - Description: Is mpin set?
              - Value: Possible values: true/false
              - Tags: String
            - **ReferenceId**:
              - Description: Account Reference Id
              - Tags: String
            - **OtpLength**:
              - Description: Length of OTP
              - Value: Example: 6
              - Tags: String
            - **AtmPinLength**:
              - Description: Length of atm pin
              - Value: Example: 6
              - Tags: String
            - **Type**:
              - Description: Type of account
              - Value: Example: Savings
              - Tags: String
            - **BranchName**:
              - Description: Name of branch in which account is registered
              - Tags: String
            - **BankAccountUniqueId**:
              - Description: Unique Identifier for bank account across banks
              - Tags: String
            - **Ifsc**:
              - Description: Account IFSC
              - Tags: String
            - **IsInitialTopUpDone**:
              - Description: This key will be available in UPI Lite usecase. The value of this either be 'true' or 'topup_txn_pending', the occurence of 'topup_txn_pending' will be very rare and its state will get updated in every 10mins.
              - Value: Possible values: true/topup_txn_pending
              - Tags: Conditional
            - **IsPrimary**:
              - Description: Is this account the primary account
              - Value: Possible values: true/false
              - Tags: String
            - **Name**:
              - Description: Name of account holder
              - Value: Example: ABC
              - Tags: String
          - Tags: Array of JSON
      - Tags: Array of JSON
    - **CustomerMobileNumber**:
      - Description: Masked phone number of the customer
      - Value: <Customer mobile number>
      - Tags: String
    - **DeviceFingerPrint**:
      - Description: Unique fingerprint of the device
      - Tags: String
    - **OtherInfo**:
      - Description: As passed in request
      - Tags: String
  - 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
{"success":false,"message":"No Data found for the given path"}
```

#### Kotlin Code Snippet:

```kotlin
{"success":false,"message":"No Data found for the given path"}
```