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

Vendor Sub-Account Management via Oauth 2.0

Use this API to make a server-to-server call to onboard vendors for split settlement for a particular gateway configured on your account.

Steps to Integrate:

1. Juspay will create and share an access token

2. Merchant to pass this access token for authorization (as explained below)

3. The shared token can only be used to call this particular endpoint and would not work with any other endpoint, until explicitly whitelisted

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.portal.juspay.in/ec/oauth/v2/merchantGatewayAccountSubInfo/vendors

Production Link

POST

https://portal.juspay.in/ec/oauth/v2/merchantGatewayAccountSubInfo/vendors

                      Authorization
                      *
                      

String

Mandatory

Pass the token as a Bearer Token

Example:- example: Bearer

                      Content-Type
                      
                      

String

application/json

Body

Request Schema: application/json

                      gatewayId
                      *
                      

Integer

Required

The unique identifier for the payment gateway.

Gateway ID mapping can be found here

                      gatewayRefId
                      
                      

String

The reference ID of the gateway assigned to the merchant account.

                      vendors
                      *
                      

Array of Objects

Required

An array of vendor sub-account mappings.

                      juspaySubAccountId
                      *
                      

String

Required

The Juspay sub-account identifier for the vendor.

                      gatewaySubAccountId
                      *
                      

String

Required

The corresponding sub-account identifier in the payment gateway system.

Response Body

                      Response
                      
                      

String

Success

Response Body

                      status
                      
                      

string

Bad Request

                      error_code
                      
                      

string

Details of keys missing

Example:-
Mandatory fields are missing

                      error_message
                      
                      

string

Further Details of keys missing