> ## 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.

# Tap

> Connect Tap Payments to Payrails for cards, Apple Pay and Google Pay, covering your merchant ID and Tap secret key.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Tap Payments** for card and wallet processing
  * Have an active Tap account
</Note>

***

## Create a Tap 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 **Tap**.
* Continue to the next step.

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

***

## Step 3: Configure your Tap integration

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

  Before you begin, ask your Payrails account partner for the Tap secret key for your account. Payrails connects to Tap as a technology partner, so this key comes through Payrails rather than from your Tap dashboard.
</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_tap`.

<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" />

***

### Account details

**In Payrails**

| Field | Value |
| :- | :- |
| **Merchant ID** | Your Tap merchant ID |

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

***

### Credentials

**In Payrails**

| Field | Value |
| :- | :- |
| **Secret Key** | The Tap secret key from your Payrails account partner. Payrails uses it to authenticate every request and to verify Tap's notifications. |

The key sets the mode: use a test key in test mode and a live key in live mode.

***

### Payment methods

**In Payrails**

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

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

***

### Webhooks or notifications

Payrails sends its notification URL to Tap with every payment, so you don't need to set one up in the Tap dashboard. Payrails verifies each notification with your secret key.

***

## Request fields for Tap

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 Tap when you include them. For more about meta fields, refer to [Meta fields](/docs/orchestration/meta-fields).

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Tap as the amount and currency. |
| `meta.customer.name` | Required | The first payment for a customer. Sent as the customer's first name when Payrails creates the customer at Tap. |
| `meta.customer.email` or `meta.customer.phone` | Required | The first payment for a customer. Send an email, or a phone `number` with its `countryCode`. |
| `meta.customer.lastName` | Optional | Sent as the customer's last name. |
| `meta.order.description` | Optional | Sent as the charge description. |
| `meta.order.softDescriptor` | Optional | Sent as the statement descriptor. |
| `meta.risk.threeDSMode` | Optional | Turns 3D Secure on or off for customer-initiated payments. |
| `merchantReference` | Optional | Sent as the order reference. |

***

## Enable the integration

**In Payrails**

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

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

***

## Next steps

1. Run a test payment using a Tap [test card](https://developers.tap.company/reference/testing-cards).
2. Verify that:
   * The payment appears in the Tap dashboard.
   * The payment status updates correctly in Payrails.
3. Once verified in test mode, repeat the setup with your live key.

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


## Related topics

- [Tap](/docs/analytics-and-reporting/getting-started/connect-your-data-sources/tap.md)
- [SDK Concepts](/docs/orchestration/checkout-sdks/ios/sdk-concepts.md)
- [How to Accept Redirect Payments](/docs/orchestration/checkout-sdks/android/how-to-accept-redirect-payments.md)


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