Tap

Who should use this guideThis 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

Create a Tap integration in Payrails

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

About workspacesWorkspaces 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.

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.

A screenshot showing Tap selected as the provider.

Step 3: Configure your Tap integration

What you’ll need from TapBefore 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.

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.

A screenshot showing the integration instance name field.

Account details

In Payrails

Field	Value
Merchant ID	Your Tap merchant ID

A screenshot showing the Tap account details fields.

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.

A screenshot showing the Tap payment method selection.

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

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

Run a test payment using a Tap test card.
Verify that:
- The payment appears in the Tap dashboard.
- The payment status updates correctly in Payrails.
Once verified in test mode, repeat the setup with your live key.

→ Continue to: Test a payment

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Create a Tap integration in Payrails

Step 1: Choose the integration type

Step 2: Choose the provider