MangoPay

This guide will help you to obtain API credentials to ingest settlement and payout data from MangoPay into your Payrails account.

Prerequisites

• A MangoPay account.
• Role: Administrator or Developer (required to view/generate API keys and configure permissions).
• Access to the MangoPay Dashboard.
• Contact: You must identify the MangoPay account admin to coordinate permissions and report scheduling.

Environment Selection

When generating your API keys, ensure you are targeting the correct MangoPay environment. Payrails supports both:

• Sandbox (Test): https://api.sandbox.mangopay.com
• Production (Live): https://api.mangopay.com

Note: MangoPay uses separate credentials for each environment. You can configure both in Payrails if needed.

Step-by-step instructions

Step 1: Create API keys and Configure Scopes

To create a set of API keys, log in to your MangoPay Dashboard and navigate to the API or Developer section.

1. Gather Credentials

• Client ID: Locate your unique MangoPay Client ID.
• API Key: Generate a new API Key (often referred to as the "Passphrase" or "Client Password" in some MangoPay contexts).
• Sandbox Access: If you have a sandbox account, repeat this process to gather the test credentials for initial integration testing.

2. Configure Permissions (Scopes) Ensure your API key is configured with the following specific scopes to allow Payrails to ingest data:

• Clients: READ and WRITE permissions.
• Reports: Reports scope (Required for both POST and GET calls to the reports endpoint).
• Disputes: READ permission on the Disputes.General scope (Required if dispute processing is needed).

3. Verify Reporting Requirements

• Data Range: Confirm availability of historical data (typically 24 to 36 months).

Step 2: Share credentials with Payrails

1. Share your API credentials in a secured way with Payrails.
2. You can use your preferred secrets manager or vault tool like 1Password Shared Vaults, AWS Secrets Manager or GCP Secrets Manager.
3. If a shared vault is not possible, you can also share credentials over PGP-encrypted file.