Create and manage API credentials

Introduction

This documentation guides you through the process of obtaining API credentials for your merchant account using the Payrails Merchant Portal. API credentials, including Client ID and Client Secret, are essential for integrating and interacting with the Payrails API in your application.

Prerequisites

• You must have a valid Payrails merchant account.
• Access to the Payrails Merchant Portal with the necessary permissions to manage API credentials.

Obtaining API Credentials

Step 1: Login to Portal

1. Open your web browser and navigate to the Payrails Merchant Portal.
2. Enter your credentials to log in to your merchant account.

Step 2: Navigate to API Credentials Page

1. Once logged in, navigate to the API credentials section within the Merchant Portal.

Step 3: Create API Credentials

1. On the API credentials page, locate and click on the "Create credentials" button.
2. Provide a name for your API credentials.
3. Click on the "Create" button.

Step 4: Retrieve Client ID and Client Secret

1. After creating credentials, you will be redirected to a new screen displaying the Client ID and Client Secret.
2. Important: Copy both the Client ID and Client Secret immediately.
3. Note: The Client Secret is revealed only once and will not be displayed again if the page is refreshed.

Step 5: Use Credentials in Your Application

1. Integrate the copied Client ID and Client Secret into your application that will be using the Payrails API.

Rotating API Secret

Step 1: Navigate to API Credentials Page

1. In the Merchant Portal, go to the API credentials section.

Step 2: Select API Key to Rotate

1. Identify the API key that you want to rotate.

Step 3: Rotate API Secret

1. Click on the "Rotate" button for the selected API key.
2. Confirm the rotation action.

Step 4: Retrieve New Client Secret

1. After rotation, the previous Client Secret becomes invalid immediately.
2. Copy the new Client Secret as it will only be displayed once.

Step 5: Update Your Application

1. Save the newly rotated Client Secret.
2. Update your application with the new Client Secret to ensure uninterrupted access to the Payrails API.

Important Notes

• Pay attention to the one-time display of the Client Secret during the creation and rotation process.
• Ensure to update your application immediately with the new Client Secret to avoid any disruption in API access.
• The previous Client Secret becomes invalid once rotated and should not be used for further API requests.

Congratulations! You have successfully obtained and managed API credentials for your merchant account using the Payrails Merchant Portal.