Additional Info for Partner Integration APIs

Response parameters description for Get Token API

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.

Response parameters for Refresh Token API

ParametersDescription
access_tokenIndicates the Security Token used to get access in Payouts API calls.
token_typeType of authorization token
expire_inIndicates the TTL i.e., the time limit (in seconds) after which the Security Token will expire
refresh_tokenUsed to refresh the access_token. To know more, read Refresh Token section
scopeRepresents the allowed scopes in generated security token. For e.g., the generated token can be used only for Payouts API requests
created_atIndicates the Time of Creation in milliseconds
user_uuidIndicates the Unique Identifier for the user.

Response parameters for Create Merchant and Get Merchant APIs

ParameterDescription
merchantThis parameter contains the following details of the merchant in an array format.
business_entityThis parameter contains the business entity of the merchant that was provided while onboarding.
statusThis parameter contains any of the following statuses:
• documents_pending • bank_verified • document_upload_in_progress • account_created • document_verification_in_progress • website_verification_in_progress • documents_rejected • live • settlement_on_hold • agreement_pending • agreement_rejected • not_available • website_error • profile_rejected • documents_pending • bank_verified • document_upload_in_progress • account_created • document_verification_in_progress • website_verification_in_progress • documents_rejected • live • settlement_on_hold • agreement_pending • agreement_rejected • not_available • website_error • profile_rejected
partner_sourceThis parameter returns the source through which the merchant joined or onboarded.
pan_verification_statusThis parameter contains any of the following PAN verification statuses:


• Success
• Pending
• Failed
website_approval_statusThis parameter contains any of the following website approval statuses:


• Website Not live
• Website Incomplete
• Website Under Construction
• Website Error
• Website OK
• Verification in Process
notification_emailThis parameter contains the email to which the notification was sent to the merchant on onboarding.
settlement_statusThis parameter contains any of the following settlement statuses:
• Risk Hold • Thirdparty Hold • Active • Suspended • Risk & Thirdparty hold • NEFT Return • Terminate
is_service_agreement_acceptedThis parameter contains the flag whether the service agreement was accepted or not.
is_authorisation_letter_requiredThis parameter contains the flag whether the authorization letter is required or not required.
monthly_expected_volumeThis parameter contains the monthly expected volume from the merchant.
business_categoryThis parameter contains the business category of the merchant that was provided while onboarding.
business_sub_categoryThis parameter contains the business sub-category of the merchant that was provided while onboarding.
bank_verification_statusThis parameter contains any of the following bank verification statuses:
• Pending • Success • Verification Attempts Exhausted • Failed
penny_deposit_statusThis parameter contains any of the following penny deposit statuses when bank account verification was performed:
• Not Initiated • Pending • SENT_TO_BANK • Success • Failed
uuidThis parameter contains the Universal Unique Identifier (UUID).
document_statusThis parameter contains the document status and can be any of the following:


• Pending: It indicates that document not yet submitted
• Docs Received: It indicates that documents are submitted
• Docs Approved: It indicates that documents are approved
• Docs Error: It indicates that mismatch in data or wrong document