---
page_title: UPI Onboarding and Pay
product: UPI Plugin SDK
platform: Android
page_source: https://juspay.io/in/docs/upi-plugin-sdk/android/process-payloads/upi-onboarding
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/upi-plugin-sdk/llms.txt
---


# UPI Onboarding and Pay




###   Process Parameters - Signature Support



## 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. Should be onboardingAndPay for this call.
      - Value: Value: onboardingAndPay
      - Tags: String, Mandatory
    - **CustomerMobileNumber**:
      - Description: Customer mobile number. Device binding will take place via this number if the parameter is passed.
      - Value: 12 digits mobile number string
      - Tags: String, Conditional
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Value: Example: 1234
      - Tags: String, Mandatory
    - **Signature**:
      - Description: Signature generated for the signaturePayload.
      - 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.
          - Value: Example: stock
          - Tags: String, Mandatory
        - **Amount**:
          - Description: Amount to be paid. Numeric String with two decimals
          - Value: Example: 2.00
          - Tags: String, Mandatory
        - **Order_id**:
          - Description: Unique Identifier for the order. Should be Alphanumeric with character length less than 21.Using only sequential or numeric characters is not recommended.
          - Value: Example: ABC123456789
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: Example: abcde12345
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Value: Example: 1665996901100
          - Tags: String, Mandatory
        - **Customer_mobile_number**:
          - Description: 12 digit mobile number to be passed (with 91 prefix). To be passed when issuing PSP is BHIM or when device binding has to be limited to a particular mobile number.
          - Tags: String, Conditional
      - Tags: String, Mandatory
    - **ShowStatusScreen**:
      - Description: Pass false to hide payment status screen. Default value: true
      - Value: Possible values: true/false
      - Tags: Boolean, Optional
    - **UdfParameters**:
      - Description: Stringified JSON for udf parameters
      - Tags: Optional
    - **AccountRefId**:
      - Description: Reference Id to be selected for the account
      - Value: Example: A12345
      - Tags: String, Optional
    - **PaymentMethod**:
      - Description: Payment method
      - Value: UPI_INAPP
      - 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: Value: onboardingAndPay
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE, Pay_Failure, BACKPRESS, USER_ABORTED
      - Value: Example: SUCCESS
      - Tags: String
    - **SelectedAccount**:
      - Description: Account selected for payment
      - Value:
        - **Vpa**:
          - Description: UPI ID linked to account
          - Value: Example: XXXX
          - Tags: String
        - **Account**:
          - Description: Account Details
          - Value:
            - **BankCode**:
              - Description: Bank Code
              - Value: Example: 123456
              - Tags: String
            - **BankName**:
              - Description: Bank Name
              - Value: Example: YES Bank
              - Tags: String
            - **MaskedAccountNumber**:
              - Description: Account Number with last few digits visible
              - Value: Example: XXXXXXXXX1234
              - Tags: String
            - **MpinSet**:
              - Description: Is MPIN set?
              - Value: Value: true/false
              - Tags: String
            - **ReferenceId**:
              - Description: Unique Identifier for the account
              - Value: Example: abcd1234xyz
              - Tags: String
            - **IsPrimary**:
              - Description: Is the account primary?
              - Value: Value: true/false
              - Tags: String
            - **Ifsc**:
              - Description: IFSC Code
              - Value: Example: ABCD0123456
              - Tags: String
          - Tags: JSON
      - Tags: JSON
    - **OrderId**:
      - Description: Order ID for the transaction.
      - Value: Example: ABC123456789
      - Tags: String
    - **TxnUuid**:
      - Description: Unique reference number for the transaction
      - Value: Example: ABC123456789
      - Tags: String
    - **AccountRefId**:
      - Description: Reference Id for selected account
      - Value: Example: A12345
      - Tags: String
    - **UdfParameters**:
      - 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
{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "onboardingAndPay",
    "merchantKeyId": "<Merchant Key Id>",
    "paymentMethod": "UPI_INAPP",
    "customerMobileNumber": "918888888888",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>",
    "accountRefId": "<Account reference Id>",
    "showStatusScreen": "true",
    "udfParameters": "{}"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848",
  "amount": "200.00",
  "metadata.<issuing_psp>:gateway_reference_id" : "ABC123",
  "order_id": "ABC1234567890"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "onboardingAndPay",
    "merchantKeyId": "<Merchant Key Id>",
    "paymentMethod": "UPI_INAPP",
    "customerMobileNumber": "918888888888",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>",
    "accountRefId": "<Account reference Id>",
    "showStatusScreen": "true",
    "udfParameters": "{}"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848",
  "amount": "200.00",
  "metadata.<issuing_psp>:gateway_reference_id" : "ABC123",
  "order_id": "ABC1234567890"
}
```



###   Process Parameters - ClientAuthToken Support



## Request Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: $requestId
  - 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. Should be onboardingAndPay for this call.
      - Value: Value: onboardingAndPay
      - Tags: String, Mandatory
    - **CustomerMobileNumber**:
      - Description: Customer mobile number. Device binding will take place via this number if the parameter is passed.
      - Value: 12 digits mobile number string
      - Tags: String, Conditional
    - **MerchantId**:
      - Description: Unique identifier associated with an account created by juspay.
      - Value: Example: stock
      - Tags: String, Mandatory
    - **Amount**:
      - Description: Amount to be paid. Numeric String with two decimals
      - Value: Example: 2.00
      - Tags: String, Mandatory
    - **OrderId**:
      - Description: Unique Identifier for the order. Should be Alphanumeric with character length less than 21.Using only sequential or numeric characters is not recommended.
      - Value: Example: ABC123456789
      - Tags: String, Mandatory
    - **CustomerId**:
      - Description: Any unique reference associated with your customer.
      - Value: Example: abcde12345
      - Tags: String, Mandatory
    - **ClientAuthToken**:
      - Description: clientAuthToken
      - Value: Example: tkn_2p2k1b6d26eg4740b9ef01294d3a43b4
      - Tags: String, Mandatory
    - **AccountRefId**:
      - Description: Reference Id to be selected for the account
      - Value: Example: A12345
      - Tags: String, Optional
    - **AuthExpiry**:
      - Description: Default 15min (functionality to be extended if configuration to change signature expiry is added)
      - Value: Example: 2021-07-19T07:20:53.318Z
      - Tags: String, Optional
    - **ShowStatusScreen**:
      - Description: Pass false to hide payment status screen. Default value: true
      - Value: Possible values: true/false
      - Tags: Boolean, Optional
    - **PaymentMethod**:
      - Description: Payment method
      - Value: UPI_INAPP
      - 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: Value: onboardingAndPay
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE, Pay_Failure, BACKPRESS, USER_ABORTED
      - Value: Example: SUCCESS
      - Tags: String
    - **SelectedAccount**:
      - Description: Account selected for payment
      - Value:
        - **Vpa**:
          - Description: UPI ID linked to account
          - Value: Example: XXXX
          - Tags: String
        - **Account**:
          - Description: Account Details
          - Value:
            - **BankCode**:
              - Description: Bank Code
              - Value: Example: 123456
              - Tags: String
            - **BankName**:
              - Description: Bank Name
              - Value: Example: YES Bank
              - Tags: String
            - **MaskedAccountNumber**:
              - Description: Account Number with last few digits visible
              - Value: Example: XXXXXXXXX1234
              - Tags: String
            - **MpinSet**:
              - Description: Is MPIN set?
              - Value: Value: true/false
              - Tags: String
            - **ReferenceId**:
              - Description: Unique Identifier for the account
              - Value: Example: abcd1234xyz
              - Tags: String
            - **IsPrimary**:
              - Description: Is the account primary?
              - Value: Value: true/false
              - Tags: String
            - **Ifsc**:
              - Description: IFSC Code
              - Value: Example: ABCD0123456
              - Tags: String
          - Tags: JSON
      - Tags: JSON
    - **OrderId**:
      - Description: Order ID for the transaction.
      - Value: Example: ABC123456789
      - Tags: String
    - **TxnUuid**:
      - Description: Unique reference number for the transaction
      - Value: Example: ABC123456789
      - 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
{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "onboardingAndPay",
    "customerMobileNumber" : "9876879867",
    "clientAuthToken": "<clientAuthToken>",
    "paymentMethod": "UPI_INAPP",
    "authExpiry" : "2023-07-19T14:15:40Z",
    "merchantId": "stock",
    "customerId": "abcde12345",
    "amount": "2.00",
    "accountRefId": "<Account reference Id>",
    "showStatusScreen" : "true/false"
    "orderId": "ABC1234567890"
     }
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "onboardingAndPay",
    "customerMobileNumber" : "9876879867",
    "clientAuthToken": "<clientAuthToken>",
    "paymentMethod": "UPI_INAPP",
    "authExpiry" : "2023-07-19T14:15:40Z",
    "merchantId": "stock",
    "customerId": "abcde12345",
    "amount": "2.00",
    "accountRefId": "<Account reference Id>",
    "showStatusScreen" : "true/false"
    "orderId": "ABC1234567890"
     }
}
```



###    


> **Note**
> For more calls refer this section [Additional Processes](../miscellaneous/additional-processes)





---

## Complete Code Reference

The following code files are referenced in the steps above:

### ClientAuth.txt

```
// block:start:clientAuthTokenPayload

{
  "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a",
  "service": "in.juspay.hyperapi",
  "payload": {
    ...
    "clientAuthToken": "<clientAuthToken>"
    ...
  }
}

// block:end:clientAuthTokenPayload

// block:start:initiate-payloadClientAuth

{
  "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "initiate",
    "clientId": "<Client Id>",
    "environment": "sandbox",
    "merchantLoader": false,
    "clientAuthToken": "<clientAuthToken>",
    "authExpiry" : "2023-07-19T14:15:40Z",
    "shouldCreateCustomer": true,
    "merchantId": "stock",
    "issuingPsp": "YES_BIZ",
    "customerId": "abcde12345",
  }
}

// block:end:initiate-payloadClientAuth


// block:start:initiate-payloadClientAuthResp

{
  "requestId": "<request id passed>",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "initiate",
    "status": "SUCCESS/FAILURE",
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:initiate-payloadClientAuthResp


// block:start:getSessionTokenClientAuthReq

{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiGetSessionToken",
    "clientAuthToken": "<clientAuthToken>",
    "authExpiry" : "2023-07-19T14:15:40Z",
    "merchantId": "stock",
    "customerId": "abcde12345",
      }
}


// block:end:getSessionTokenClientAuthReq


// block:start:getSessionTokenClientAuthResp

{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiGetSessionToken",
    "status": "LINKED",
    "isDeviceBound": "true",
    "isDeviceActivated": "true",
    "vpaAccounts": [{
      "account": {
        "bankCode": "11111",
        "bankName": "ABCD",
        "maskedAccountNumber": "XXXX203891",
        "mpinLength": "6",
        "mpinSet": "true",
        "referenceId": "A0760cb548bb4dda9d32e3030863dd5",
        "isInitialTopUpDone": "true",   //In case of UPI lite,
        "isPrimary": "true",
        "otpLength": "6",
        "atmPinLength": "6"
      },
      "vpa": "abc@xyz",
    }],
    "prefix": "XYZ"
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:getSessionTokenClientAuthResp


// block:start:onboardingAndPayClientAuthReq

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "onboardingAndPay",
    "customerMobileNumber" : "9876879867",
    "clientAuthToken": "<clientAuthToken>",
    "paymentMethod": "UPI_INAPP",
    "authExpiry" : "2023-07-19T14:15:40Z",
    "merchantId": "stock",
    "customerId": "abcde12345",
    "amount": "2.00",
    "accountRefId": "<Account reference Id>",
    "showStatusScreen" : "true/false"
    "orderId": "ABC1234567890"
     }
}


// block:end:onboardingAndPayClientAuthReq


// block:start:onboardingAndPayClientAuthResp

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "onboardingAndPay",
    "txnUuid": "mozoghi9Z6PsanCGWK1V",
    "selectedAccount": {
      "vpa": "abc@xyz",
      "account": {
        "ifsc": "ABCD0000011",
        "mpinSet": "true",
        "bankCode": "123456",
        "referenceId": "A621542c281c4a20b8faf0ee1cb75d",
        "maskedAccountNumber": "XXXXXXX20000",
        "isPrimary": "true",
        "bankName": "Mybank"
      }
    },
    "orderId": "ABCDE12345",
    "status": "SUCCESS"
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:onboardingAndPayClientAuthResp

// block:start:managementClientAuthReq

{
  "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "management",
    "merchantId": "stock",
    "customerId": "abcde12345",
    "clientAuthToken": "<clientAuthToken>",
    "authExpiry" : "2023-07-19T14:15:40Z",
    "shouldExitOnDeregister": "true"
  }
}

// block:end:managementClientAuthReq


// block:start:managementClienttAuthResp

{
  "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "management",
    "status": "SUCCESS"
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:managementClientAuthResp

// block:start:upiUiScanPayClientAuthReq

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "onboardingAndPay",
    "merchantid": "stock",
    "customerid": "abcde12345",
    "clientAuthToken": "<clientAuthToken>"
    "authExpiry" : "2023-07-19T14:15:40Z",
    "showStatusScreen" : "true/false"
     }
}


// block:end:upiUiScanPayClientAuthReq

/ block:start:upiUiScanPayClientAuthResp

{
  "service": "in.juspay.hyperapi",
  "requestId": "d0c1d85e-c954-4758-9701-bfa69dd33239",
  "payload": {
    "status": "Successful",
    "gatewayTransactionId": "AXB4e3459e929a6464d8a37c47e9e52b7c1",
    "gatewayResponseMessage": "Your transaction is successful",
    "gatewayResponseCode": "00",
    "actionPerformed": "Pay",
    "action": "upiUiScanPay",
    "accountReferenceId": "Aa6c1763d28a406e8c2d7fbe23fcc1",
    "payeeName": "ABC",
    "amount": "20.00",
    "transactionTimestamp": "2022-01-28T14:44:51+05:30"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}

// block:end:upiUiScanPayClientAuthResp

// block:start:payClientAuthReq

{
  "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiTxn",
    "merchantId": "stock",
    "customerId": "abcde12345",
    "clientAuthToken": "<clientAuthToken>",
    "authExpiry" : "2023-07-19T14:15:40Z",
    "accountRefId" : "ABC123456789",
    "amount" : "2.00",
    "gatewayReferenceId": "ABC123",
    "orderId" " "ABC123456789"
  }
}

// block:end:payClientAuthReq

// block:start:payClientAuthResp

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "upiTxn",
    "txnUuid": "moz3hjuAtiiQriCVFBn",
    "selectedAccount": {
      "vpa": "abc@xyz",
      "account": {
        "type": "SAVINGS",
        "referenceId": "A0387f9jkl54476183527acfaf9491",
        "otpLength": "6",
        "name": "XXXXat",
        "mpinSet": "true",
        "mpinLength": "6",
        "maskedAccountNumber": "XXXXXXX20000",
        "isPrimary": "true",
        "ifsc": "AAAA1236543",
        "branchName": "",
        "bankName": "MYPSP",
        "bankCode": "500001",
        "bankAccountUniqueId": "082eedaa58700e492179e97841584HJ8d39a4cff9275ef8ee9bc59f9186d3d68",
        "atmPinLength": "4"
      }
    },
    "status": "SUCCESS"
    "orderId": "ABC1234567890"
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:payClientAuthResp


// block:start:onboardingAndCreateMandate-ClientAuthReq

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
   "action": "onboardingAndPay",
   "shouldCreateMandate": true,
   "merchant_id": "stock",
   "customer_id": "abcde12345",
   "order_id": "ABC1234567890",
   "clientAuthToken": "<clientAuthToken>",
   "authExpiry" : "2023-07-19T14:15:40Z",
   "accountRefId" : "ABC123456789",
   "amount": "2.00",
   "gatewayReferenceId": "ABC123",
   "metadata.<issuing_psp>:mandate_name": "metadata.YES_BIZ:ABC",
   "options.create_mandate": "REQUIRED",
   "mandate.max_amount": "2000.00",
   "mandate.amount_rule": "FIXED",
   "mandate.frequency": "MONTHLY",
   "mandate.start_date": "166674893389237",
   "mandate.end_date": "16667389373820323",
   "mandate.block_funds" : "true",
   "mandate.rule_type" : "ON/BEFORE/AFTER",
   "mandate.rule_value" : "Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern.",
   "payType" : "P2P_PAY"
  }
} 

// block:end:onboardingAndCreateMandate-ClientAuthReq

// block:start:onboardingAndCreateMandate-ClientAuthResp

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "onboardingAndPay",
    "status": "SUCCESS",
    "mandate": {
    "amount": "10.00",
    "amountRule": "EXACT",
    "blockFund": "false",
    "expiry": "2022-01-02T14:17:06+05:30",
    "gatewayMandateId": "YJPMe5c9711f1ede1f5524e2fadb48003aa0",
    "gatewayReferenceId": "806115044725",
      "gatewayResponseCode": "00",
      "gatewayResponseMessage": "Your transaction is successful",
      "gatewayResponseStatus": "SUCCESS",
      "initiatedBy": "PAYER",
      "mandateName": "Test Mandate",
      "mandateTimestamp": "2021-12-30T14:17:06+05:30",
      "merchantCustomerId": "DEMO-1234",
      "merchantRequestId": "eulb1a4418b4ac",
      "orgMandateId": "BJJMe5c9711f1ede1f5524e2f92648y03aa0",
      "payeeMcc": "4924",
      "payeeName": "GROWW",
      "payeeVpa": "growwuat@ypay",
      "payerName": "customer1",
      "payerRevocable": "true",
      "payerVpa": "customer1@ypay",
      "recurrencePattern": "WEEKLY",
      "recurrenceRule": "BEFORE",
      "recurrenceValue": "2",
      "refUrl": "https://www.google.com",
      "remarks": "Sample Remarks",
      "role": "PAYER",
      "shareToPayee": "true",
      "transactionType": "UPI_MANDATE",
      "umn": "uniqueMandateNumber@ypay",
      "validityEnd": "2022/09/20",
      "validityStart": "2022/01/20"
    }
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:onboardingAndCreateMandate-ClientAuthResp

// block:start:createMandateClientAuthReq

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiTxn",
    "shouldCreateMandate": true,
    "merchant_id": "stock",
    "customer_id": "abcde12345",
    "orderId ": "ABC123456789",
    "accountRefId" : "<Account reference taken from session>",
    "timestamp": "1668389349848",
    "amount": "200.00",
    "gatewayReferenceId": "ABC123",
    "order_id": "ABC1234567890",
    "clientAuthToken": "<clientAuthToken>",
    "authExpiry" : "2023-07-19T14:15:40Z",
    "accountRefId" : "ABC123456789",
    "amount": "2.00",
    "metadata.<issuing_psp>:mandate_name": "metadata.YES_BIZ:ABC",
    "options.create_mandate": "REQUIRED",
    "mandate.max_amount": "2000.00",
    "mandate.amount_rule": "FIXED",
    "mandate.frequency": "MONTHLY",
    "mandate.start_date": "166674893389237",
    "mandate.end_date": "16667389373820323",
    "mandate.block_funds" : "true",
    "mandate.rule_type" : "ON/BEFORE/AFTER",
    "mandate.rule_value" : "Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern." 
  
  }
}

// block:end:createMandateClientAuthReq

// block:start:createMandateClientAuthResp

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "upiTxn",
    "status": "SUCCESS",
    "mandate": {
      "amount": "10.00",
      "amountRule": "EXACT",
      "blockFund": "false",
      "expiry": "2022-01-02T14:17:06+05:30",
      "gatewayMandateId": "YJPMe5c9711f1ede1f5524e2fadb48003aa0",
      "gatewayReferenceId": "806115044725",
      "gatewayResponseCode": "00",
      "gatewayResponseMessage": "Your transaction is successful",
      "gatewayResponseStatus": "SUCCESS",
      "initiatedBy": "PAYER",
      "mandateName": "Test Mandate",
      "mandateTimestamp": "2021-12-30T14:17:06+05:30",
      "merchantCustomerId": "DEMO-1234",
      "merchantRequestId": "eulb1a4418b4ac",
      "orgMandateId": "BJJMe5c9711f1ede1f5524e2f92648y03aa0",
      "payeeMcc": "4924",
      "payeeName": "GROWW",
      "payeeVpa": "growwuat@ypay",
      "payerName": "customer1",
      "payerRevocable": "true",
      "payerVpa": "customer1@ypay",
      "recurrencePattern": "WEEKLY",
      "recurrenceRule": "BEFORE",
      "recurrenceValue": "2",
      "refUrl": "https://www.google.com",
      "remarks": "Sample Remarks",
      "role": "PAYER",
      "shareToPayee": "true",
      "transactionType": "UPI_MANDATE",
      "umn": "uniqueMandateNumber@ypay",
      "validityEnd": "2022/09/20",
      "validityStart": "2022/01/20"
    }
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:createMandateClientAuthResp
```

### expressonboarding.txt

```
// block:start:getSessionTokenReqexp

{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiGetSessionToken",
    "merchantKeyId": "<Merchant Key Id>",
    "customerMobileNumber": "918888888888",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848"
}

// block:end:getSessionTokenReqexp

// block:start:getSessionTokenRespexp

{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiGetSessionToken",
    "status": "LINKED",
    "isDeviceBound": "true",
    "isDeviceActivated": "true",
    "vpaAccounts": [{
      "account": {
        "bankCode": "11111",
        "bankName": "ABCD",
        "maskedAccountNumber": "XXXX203891",
        "mpinLength": "6",
        "mpinSet": "true",
        "referenceId": "A0760cb548bb4dda9d32e3030863dd5",
        "isInitialTopUpDone": "true",   //In case of UPI lite,
        "isPrimary": "true",
        "otpLength": "6",
        "atmPinLength": "6"
      },
      "vpa": "abc@xyz"
    }],
    "prefix": "XYZ"
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:getSessionTokenRespexp

// block:start:onboardingAndPayReqexp

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "onboardingAndPay",
    "merchantKeyId": "<Merchant Key Id>",
    "paymentMethod": "UPI_INAPP",
    "customerMobileNumber": "918888888888",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>",
    "accountRefId": "<Account reference Id>",
    "showStatusScreen": "true",
    "udfParameters": "{}"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848",
  "amount": "200.00",
  "metadata.<issuing_psp>:gateway_reference_id" : "ABC123",
  "order_id": "ABC1234567890"
}

// block:end:onboardingAndPayReqexp

// block:start:onboardingAndPayRespexp

{
  "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "onboardingAndPay",
    "txnUuid": "mozoghi9Z6PsanCGWK1V",
    "selectedAccount": {
      "vpa": "XXXX",
      "account": {
        "ifsc": "ABCD0000011",
        "mpinSet": "true",
        "bankCode": "123456",
        "referenceId": "A621542c281c4a20b8faf0ee1cb75d",
        "maskedAccountNumber": "XXXXXXX20000",
        "isPrimary": "true",
        "bankName": "Mybank"
      }
    },
    "orderId": "ABCDE12345",
    "status": "SUCCESS",
    "accountRefId": "A621542c281c4a20b8faf0ee1cb75d",
    "udfParameters": "{}"
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:onboardingAndPayRespexp
```


---

## See Also

- [Life Cycle Events](https://juspay.io/in/docs/upi-plugin-sdk/android/interaction-with-sdk/life-cycle-events)
- [Check Balance](https://juspay.io/in/docs/upi-plugin-sdk/android/process-payloads/check-balance)
