Payplug

Obtain Payplug Technical account API credentials and connect Payplug as a Payrails data source for settlement, processing activity, payout, and dispute data.

Use the self-service flow to configure the integration in the Payrails portal.

Prerequisites

• Confirm that you have an active Payplug merchant account.
• Identify a contact who can provision Technical account API access, such as your Payplug account manager.

Configure the integration

Payrails ingests Payplug data through the Report API with Technical account credentials. These OAuth2 client credentials provide read-only access to your Payplug reports. A Payplug account spans every processing account (ledger) you hold, so one credential pair covers all your currencies and processing accounts.

1. Request Technical account API credentials from Payplug

1. Contact your Payplug account manager.
2. Request a Technical account with read-only Report API access. Ask for these three values:
   a. Client ID
   b. Client Secret
   c. Scope (your account's realm path)
3. Store the credentials securely after Payplug provisions them. Treat the Client Secret like a password, as you typically cannot retrieve it again later.

2. Add the Payplug integration in the Payrails portal

1. Log in to the Payrails dashboard and open Settings → Integrations → Data.
2. Click Add instance.
3. In New instance, select Payplug as the provider and click Continue.
4. On the Configure account screen, fill in:
   • Integration instance name: a unique label.
   • Start Date: today. Payrails cannot backfill data through the self-service flow. Contact your Payrails account manager if you need historical data.
   • Client ID: your Payplug Technical account Client ID.
   • Client Secret: your Payplug Technical account Client Secret. Payrails stores this value masked.
   • Scope: your Payplug Technical account realm path.
5. Click Save account. The instance appears in the Data integrations list, and Payrails begins ingesting data the next day.