--- page_title: International Activation product: UPI TPAP SDK platform: Android page_source: https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/international-activation llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt --- # International Activation The UPI enabled customer apps shall provide for customer activation flow in their apps. Activation can be done for a specific time period e.g. for travel duration or enabled till disabled again. The maximum activation period can be of 3 months. > **Note** > This function is used to capture the activation of UPI International by the user on PSP/Application. > > > ### 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: upiInternationalActivation > - Tags: String, Mandatory > - **AccountReferenceId**: > - Description: reference id for selected accounts > - Tags: String, Mandatory > - **UpiRequestId**: > - Description: Unique merchant id shared during onboarding > - Tags: String, Mandatory > - **Ifsc**: > - Description: Account IFSC > - Tags: String, Mandatory > - **StartDate**: > - Description: Start date of the Activation (yyyy/mm/dd) > - Value: 2023/12/10 > - Tags: String, Optional > - **EndDate**: > - Description: End date of the Activation (yyyy/mm/dd) > - Value: 2023/12/20 > - Tags: String, Optional > - **MerchantKeyId**: > - Description: Key ID to identify the public-private key pair used for signature generation > - Tags: String, Mandatory > - **Signature**: > - Description: Signature generated for the signaturePayload > - Value: > - 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 > - 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 > - **RequestType**: > - Description: Action to be performed for the International account of the user. > - Value: ACTIVATE/DEACTIVATE/FORCE_QUERY > - 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 to be performed in the SDK. > - Value: upiInternationalActivation > - Tags: String, Mandatory > - **Status**: > - Description: International Status - ACTIVATE / DEACTIVATE > - Value: ACTIVATE / DEACTIVATE / QUERY > - Tags: String, Mandatory > - **MerchantId**: > - Description: Unique merchant id shared during onboarding > - **AccountreferenceId**: > - Description: reference id for selected accounts > - **GatewayResponseStatus**: > - Description: SUCCESS/FAILURE > - **GatewayResponseCode**: > - Description: Response Code received from NPCI > - **GatewayResponseMessage**: > - Description: Response Message received from NPCI > - **StartDate**: > - Description: Start date of the Activation (yyyy/mm/dd) > - **EndDate**: > - Description: End date of the Activation (yyyy/mm/dd) > - 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":"Failed to fetch snippet"} > ``` > > #### Kotlin Code Snippet: > > ```kotlin > { > "requestId": "f9432fad-a575-451a-956c-3369a6ff6b01", > "service": "in.juspay.hyperapi", > "payload": { > "action": "upiInternationalActivation", > "requestType": "ACTIVATE/DEACTIVATE/QUERY", > "accountReferenceId": "A14d7765b0134c9ebc1a0ec9428ghy", > "upiRequestId": "ABC1234567890", > "ifsc": "AABC0876543", > "startDate": "2023/12/10", > "endDate": "2023/12/15", > "signaturePayload": "", > "signature": "EDe...==" > } > } > > "signaturePayload": { > "merchant_id": "ABCD", > "customer_id": "1234567", > "timestamp": "234562345" > } > ``` > ## Sample Code Snippets: ### Request snippets: #### Request Code Snippet: ```request // block:start:internationalActivationReqH { "requestId": "f9432fad-a575-451a-956c-3369a6ff6b01", "service": "in.juspay.hyperapi", "payload": { "action": "upiInternationalActivation", "requestType": "ACTIVATE/DEACTIVATE/QUERY", "accountReferenceId": "A14d7765b0134c9ebc1a0ec9428ghy", "upiRequestId": "ABC1234567890", "ifsc": "AABC0876543", "startDate": "2023/12/10", "endDate": "2023/12/15", "signaturePayload": "", "signature": "EDe...==" } } "signaturePayload": { "merchant_id": "ABCD", "customer_id": "1234567", "timestamp": "234562345" } // block:end:internationalActivationReqH // block:start:internationalActivationRespH { "requestId": "f9432fad-a575-451a-956c-3369a6ff6b01", "service": "in.juspay.hyperapi", "payload": { "action": "upiInternationalActivation", "status": "SUCCESS", "activationStatus": "ACTIVE/INACTIVE", "merchantId": "ABCD", "accountReferenceId": "A14d7765b0134c9ebc1a0ec9428ghy", "gatewayResponseStatus": "SUCCESS/FAILURE", "gatewayResponseCode": "00", "gatewayResponseMessage": "SUCCESS", "startDate": "2023/12/10", "endDate": "2023/12/15" }, "status": "SUCCESS/FAILURE", "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:internationalActivationRespH // block:start:validateQRReqH { "requestId": "f9432fad-a575-451a-956c-3369a6ff6b01", "service": "in.juspay.hyperapi", "payload": { "action": "upiInternationalValidateQr", "merchantKeyId": "1234", "initiationMode": "12", "upiRequestId": "ABC1234567890", "qrPayLoad": "", "signaturePayload": "", "signature": "EDe...==" } } "signaturePayload": { "merchant_id": "ABCD", "customer_id": "1234567", "timestamp": "234562345" } // block:end:validateQRReqH // block:start:validateQRRespH { "requestId": "f9432fad-a575-451a-956c-3369a6ff6b01", "service": "in.juspay.hyperapi", "payload": { "action": "upiInternationalValidateQr", "txnId": "ABC123456", "PayeeType": "SMALL", "PayeeName": "XYZ", "PayeeCode": "5678", "PayeeAddr": "xyz@krs", "gatewayResponseStatus": "SUCCESS/FAILURE", "gatewayResponseCode": "00", "gatewayResponseMessage": "SUCCESS", "fxList":[{ "mkup":"0.00", "fx":"1.00", "convertedAmount":"36.00", "baseCurr":"SGD", "baseAmount":"36.00", "active":"Y" }], }, "status": "SUCCESS/FAILURE", "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:validateQRRespH // block:start:fxConversionReqH { "requestId": "f9432fad-a575-451a-956c-3369a6ff6b01", "service": "in.juspay.hyperapi", "payload": { "action": "UpiInternationalFxConversion", "baseCurrency":"SGD", "baseAmount":"36.00", "fxRate": "1.00", "markupPercentage": "1.00" } } // block:end:fxConversionReqH // block:start:fxConversionRespH { "requestId": "f9432fad-a575-451a-956c-3369a6ff6b01", "service": "in.juspay.hyperapi", "payload": { "action": "UpiInternationalFxConversion", "responseCode": "SUCCESS", "responseMessage": "SUCCESS", "Amount": "36.00" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:fxConversionRespH ``` ### Response snippets: #### Response: ```plaintext {"success":false,"message":"Failed to fetch snippet"} ``` --- ## See Also - [Signed Intent/QR Signature Verification](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/signed-intent-qr-signature-verification) - [Validate QR/Fx Conversion](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/validate-qr)