JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Manage Activation

This API is used to activate the international account for international payments for the selected time period. International activation is a pre-requisite for UPI International transaction. The UPI enabled customer apps shall provide for customer activation flow in their apps. Activation can be done for specific time period e.g. for travel duration or enabled till disabled again. The maximum activation period can be of 90 days.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{uri}/merchants/international/manageActivation

                      content-type
                      *
                      

String

Mandatory

application/json

                      accept
                      *
                      

String

Mandatory

application/json

                      x-merchant-id	
                      *
                      

String

Mandatory

Will be shared while onboarding.

                      x-merchant-channel-id	
                      *
                      

String

Mandatory

Will be shared while onboarding.

                      x-timestamp	
                      *
                      

String

Mandatory

This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.

                      x-merchant-signature	
                      *
                      

String

Mandatory

This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.

Body

Request Schema: application/json

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer
Constraints: Alphanumeric string with dot(.). Maximum length is 256.

                      deviceFingerPrint
                      *
                      

String

Mandatory

Device fingerprint of the customer

                      bankAccountUniqueId
                      *
                      

String

Mandatory

Unique id for the payer selected bank account
Constraints: bankAccountUniqueId in the response of Fetch Accounts api call

                      credBlock
                      *
                      

String

Mandatory

Encrypted credblock containing user mpin
Constraints: As returned by Common Library

                      startDate
                      
                      

String

optional

Start date of the International Activation yyyy-MM- ddTHH:mm:ss+05:30
Constraints: String, Should only be populated in case of action = ACTIVATE

                      endDate
                      
                      

String

optional

End date of the International Activation yyyy-MM- ddTHH:mm:ss+05:30
Constraints: String, Should only be populated in case of action = ACTIVATE (if not passed in action = ACTIVATE, by default activation request will be executed with 90 days endDate)

                      action
                      *
                      

String

Mandatory

Action to be performed like ACTIVATE, QUERY, DEACTIVATE

                      udfParameters
                      
                      

JSON String

Optional

Stringified JSON for udf parameters

                      clVersion
                      
                      

String

Optional

Common Library Version of the UPI application clVersion
Constraints: Common Library Version of the UPI application (Mandatory for BioAuth payments)

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API

Values: SUCCESS, FAILURE

                      responseCode
                      *
                      

String

Mandatory

PSP response code for the API
Values: Refer error code section

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API
Values: Refer error code section

                      payload
                      *
                      

Json

Mandatory

                      status
                      *
                      

String

Mandatory

International Status
Values: ACTIVE, INACTIVE

                      startDate
                      *
                      

String

Mandatory

Start date of the International Activation received from bank
Values: String, Should only be populated in case of status = ACTIVE

                      endDate
                      *
                      

String

Mandatory

End date of the International Activation received from bank
Values: String, Should only be populated in case of status = ACTIVE

                      gatewayResponseStatus
                      *
                      

String

Mandatory

Response status returned by gateway

Values: SUCCESS, FAILURE

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message for code returned by gateway

                      udfParameters
                      
                      

JSON String

optional

Stringified JSON for udf parameters