Get Token API - Partner Integration

The Get Token API returns the authentication token generated using the client ID and client secret for the following products:

Environment

Additional information for request parameters

Parameters

Description

client_id

For getting your client ID, refer to Download Client Credentials.

client_secret

For getting your client secret, refer to Download Client Credentials.

scope

The scopes to be used for various use cases in Parter Integration are:

  • Refer Merchant, Verify Link Merchant, Get Merchant, and Update Merchant: refer_merchant
  • Send Sign In OTP: send_sign_in_otp
  • Verify Sign In OTP: verify_sign_in_otp
  • Client Manage Agreement (Used in E-Sign flow): client_manage_agreement
  • Client Manage KYC Details (Used in managing KYC documents): client_manage_kyc_details
  • Create Bank Details: create_bank_details
  • Penny Verify - user_token
  • Manage Payment Links: create_payment_links

grant_type

This parameter contains a constant value used to get the access token. The grant_type used across the partner integration is client_credentials.

Response parameters
ParameterDescription
access_tokenThe access token to be used in Partner Integration APIs.
token_typeThe token type of the access token.
expires_inThe expiry time in seconds of the access token.
scopeThe scope of the access token.
created_atThe UNIX time stamp when the access token was created.

📘

Note:

The expiry period of the token generated using this API is configurable by you (partner). The expiry period (in seconds) of the token is displayed in the expires_in parameter of the response. For example, in the following response, the value of the expires_in is 7200 seconds:

{
  "access_token": "82c38b64e072f3d64da6e4e6efee9789ffe1250f0cd04c20753d6e6f25df9cc7",
  "token_type": "Bearer",
  "expires_in": 7200,
  "scope": "send_sign_in_otp",
  "created_at": 1595411399
}

Request parameters

Language
URL
Click Try It! to start a request and see the response here!