Pre-Requisites

Before you start payout integration, make sure you have the below details handy:

  • Juspay Payouts Dashboard - Merchants are required to procure the Juspay merchant dashboard access by creating an account (Sandboxlink icon / Productionlink icon) or from Juspay Business SPOC.

    • This dashboard can be used for gateway setup, payment instruments enablement/disablements, Security key generation, Webhook URL Configuration, traffic monitoring and analytics.

  • Merchant Id - This is your identifier in the Juspay systems. It will be created during the dashboard account creation and provided to you by the Juspay team. This is used in all API Calls to associate requests made from your account.

  • API Key - Juspay uses HTTP Basic Auth for authentication. API Key is used to authenticate the Server-to-Server API Calls.

    • API Key can be generated through Juspay Dashboard. Navigate to Login > Payout Management > Settings > Security > API Keys > Create API Key

  • Webhooks - After completion of an order, Juspay provides direct notification to your server. Refer Webhookslink icon.

  • Weblabs - You may choose to pause transaction basis account balance or specific time period. Refer Weblabslink icon for the same.

Warning
  • Detailed the API request expects a Basic Authorization header. The header value can be obtained by concatenating your API Key with a colon (:) and doing a base-64 encode on it

    • Sample Authorization Header:

      • API Key: 1cc33A5F5D6aa54AB20CF6FbbC8558

      • Encoding Format: 1cc33A5F5D6aa54AB20CF6FbbC8558:

      • Authorization Header / Base64encoded API Key:
        Basic MWNjMzNBNUY1RDZhYTU0QUIyMENGNkZiYkM4NTU4Og==

  • API Key is like password to your account. You must never send this information to browser or application clients. Do not publish your API Key in publicly accessible areas such as Git repositories, Android/iOS clients, support forums, etc.

Last updated 10 months ago