> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# Solidgate

> Connect Solidgate to Payrails for cards, Apple Pay and Google Pay, covering your channel API keys, webhook keys and notifications.

<Note>
  **Who should use this guide**

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Solidgate** to accept cards, Apple Pay or Google Pay
  * Have access to the Solidgate Hub with a channel for each environment
</Note>

***

## Create a Solidgate integration in Payrails

1. Log in to the **Payrails** portal.
2. Go to **Settings** → **Integrations**.
3. Select **Add instance** to create a new integration configuration.
4. Select the **workspaces** where this integration should be available.

<Note>
  **About workspaces**

  Workspaces determine where this integration is available. They let you isolate provider setups by region or business line, or share the same configuration across multiple workspaces.
</Note>

***

## Step 1: Choose the integration type

* Select **Payment**.
* Continue to the next step.

***

## Step 2: Choose the provider

* Select **Solidgate**.
* Continue to the next step.

<img src="https://mintcdn.com/payrails-42074109/5bgwNQYa4BxIPDBd/images/docs/solidgate-image-01.png?fit=max&auto=format&n=5bgwNQYa4BxIPDBd&q=85&s=ceef496a7907644fef8e053ee4fc25e8" alt="A screenshot showing Solidgate selected as the provider." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/solidgate-image-01.png" />

***

## Step 3: Configure your Solidgate integration

<Tip>
  **What you'll need from Solidgate**

  Before you begin, make sure you can log in to the Solidgate Hub. You'll copy the API keys and webhook keys of the channel for your environment.
</Tip>

***

### Integration instance name

> An integration instance is a specific payment provider setup in Payrails. You can create multiple instances for different regions, currencies, or business needs. Choose a clear, consistent name, as it is used in routing.

**In Payrails**

* Enter an **Instance name** for your integration, for example `merchant_solidgate`.

<img src="https://mintcdn.com/payrails-42074109/145W1v58K5wnDMNC/images/docs/orchestration/integrations/shared/integration-instance-name.png?fit=max&auto=format&n=145W1v58K5wnDMNC&q=85&s=470be58979509680650b0cbf8b5eecc4" alt="A screenshot showing the integration instance name field." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/orchestration/integrations/shared/integration-instance-name.png" />

***

### Payment methods

**In Payrails**

* Select **Card**, **Apple Pay**, **Google Pay** or any combination.

<img src="https://mintcdn.com/payrails-42074109/5bgwNQYa4BxIPDBd/images/docs/solidgate-image-02.png?fit=max&auto=format&n=5bgwNQYa4BxIPDBd&q=85&s=c8af93fd0ff4e2b33fd4d875fefe7c13" alt="A screenshot showing the Solidgate payment method selection." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/solidgate-image-02.png" />

***

### Credentials

**In Solidgate**

1. In the Solidgate Hub, go to **Developers** → **Channels**.
2. Open the channel for your environment. Use a test channel for test mode and a live channel for live mode.
3. Under **API Keys**, copy the **Public** and **Secret** keys.
4. Under **Webhook Keys**, copy the **Public** and **Secret** keys.

**In Payrails**

| Field | Value |
| :- | :- |
| **API Public Key** | The channel's API public key |
| **API Secret Key** | The channel's API secret key. Payrails signs every request with it. |
| **Webhook Public Key** | The channel's webhook public key |
| **Webhook Secret Key** | The channel's webhook secret key. Payrails uses it to verify notifications from Solidgate. |

<img src="https://mintcdn.com/payrails-42074109/5bgwNQYa4BxIPDBd/images/docs/solidgate-image-03.png?fit=max&auto=format&n=5bgwNQYa4BxIPDBd&q=85&s=c74be6d7228455be874500ca1a1198fe" alt="A screenshot showing the Solidgate credential fields." className="mx-auto block rounded-lg object-cover border border-gray-200" width="80%" data-path="images/docs/solidgate-image-03.png" />

***

### Webhooks or notifications

<Info>
  Payrails uses provider webhooks or notifications to receive asynchronous
  payment status updates.
</Info>

<Warning>
  Set up the webhook on the same Solidgate channel whose keys you entered in Payrails.
</Warning>

**In Payrails**

* Copy the **Notification URL** shown under **Account configuration** at the top of the integration form.

**In Solidgate**

1. Open the same channel in the Solidgate Hub.
2. Add the Payrails notification URL as the channel's webhook URL for order and transaction status updates.
3. Save the changes.

Solidgate notifies Payrails of authorizations, captures, refunds and voids.

***

## Request fields for Solidgate

Send these fields in the [authorize request](/reference/authorizeaction) for card payments, in addition to the standard authorize fields. **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to Solidgate when you include them. For more about meta fields, refer to [Meta fields](/docs/orchestration/meta-fields).

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Solidgate as the order amount and currency. |
| `meta.order.description` | Required | Sent as the order description. |
| `meta.customer.email` | Required | A valid email address. Sent as the customer email. |
| `meta.clientContext.ipAddress` | Required | A valid IP address. Sent as the customer's IP address. |
| `meta.clientContext.osType` | Required | Sets the platform: `iOS` and `Android` are sent as app payments, anything else as web. |
| `meta.clientContext.userAgent`, `acceptHeader`, `language`, `colorDepth`, `screenHeight`, `screenWidth` | Required | Only when you force 3D Secure with `meta.risk.threeDSMode` set to `Force`. Sent as browser details for 3D Secure. |
| `instrument.networkTransactionReference` | Required | Merchant-initiated payments only. Sent as the scheme transaction ID. Payrails stores it from the first payment. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent as the customer's first and last name. Payrails also uses them as the card holder name when the instrument has none. |
| `meta.customer.phone.number` | Optional | Sent as the customer phone. |
| `meta.customer.birthDate` | Optional | Sent as the customer's date of birth. |
| `meta.customer.identityCardNumber` | Optional | Sent as the customer account ID. |
| `meta.customer.country.iso3` | Optional | Sent as the customer's country. |
| `meta.clientContext.origin`, `host`, `clientType`, `javaEnabled`, `timeZoneOffset` | Optional | Sent as the traffic source, website, device and browser details. |
| `meta.order.billingAddress` | Optional | Sent as the purchase country, postal code, state, city and address. |
| `meta.order.deliveryAddress` | Optional | Sent as the shipping address. |
| `meta.order.reference` | Optional | Sent with the order items. |
| `merchantReference` | Optional | Sent in the order metadata. |

***

## Enable the integration

**In Payrails**

* Select **Save account** to enable the integration.
* Confirm the integration shows as **Enabled**.

Your **Solidgate** integration is now ready to process payments.

***

## Next steps

1. Run a test payment using a Solidgate [test card](https://docs.solidgate.com/payments/testing/).
2. Verify that:
   * The payment appears in the Solidgate Hub.
   * The payment status updates correctly in Payrails.
3. Once verified in test mode, repeat the setup with your live channel.

→ Continue to: [Test a payment](/docs/orchestration/payment-acceptance/test-payments)


## Related topics

- [Integrations](/docs/orchestration/integrations.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.