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

# Amex

> Connect American Express to Payrails, covering account and acceptor details plus the raw card data approval it requires.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Amex Payments**
  * Are approved to process **raw card data**

  *We use a server-to-server integration with Amex, so your account must be enabled to process raw card data. If this isn't enabled, payments won't work in production. Please contact your Amex account manager or support team to activate it.*
</Note>

> If you accept American Express through another PSP (for example Adyen or Checkout.com), no special setup is required. Amex is supported by default as part of that provider's card schemes. This guide covers **Amex Direct** only.

## Create and Configure an American Express Integration in Payrails

1. Log in to the Payrails portal
2. Go to **Settings → Integrations**
3. Select **Add instance** to create a new American Express 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 **and** **continue to the next step
  <img src="https://mintcdn.com/payrails-42074109/zqk7oWHZbW3YniA1/images/docs/amex-image-01.png?fit=max&auto=format&n=zqk7oWHZbW3YniA1&q=85&s=99ce7767f4367877c1a5b342106091c4" alt="Payrails integration type selection with Payment selected" className="mx-auto block rounded-lg object-cover" width="80%" data-path="images/docs/amex-image-01.png" />

## Step 2: Choose the Provider

* Select **Amex **and** **continue to the next step
  <img src="https://mintcdn.com/payrails-42074109/zqk7oWHZbW3YniA1/images/docs/amex-image-02.png?fit=max&auto=format&n=zqk7oWHZbW3YniA1&q=85&s=e602d7de8a3c64dca9ca0a93be495579" alt="Payrails provider selection with Amex selected" className="mx-auto block rounded-lg object-cover" width="100%" data-path="images/docs/amex-image-02.png" />

## Step 3: Configure Your American Express Integration

<Tip>
  **What you'll need from American Express**

  American Express provides your affiliation configuration values directly. Because Payrails is already certified as a gateway to American Express, there is **no API key, client secret, or bearer token** — the credentials are the merchant and terminal identifiers below.

  Before beginning, ensure you have:

  * Merchant ID (SE number)
  * Merchant Category Code (MCC)
  * Acquirer Country Code
  * Merchant Terminal ID
  * Contact info (Merchant's telephone number, email, or web (URL) address)
  * Card acceptor (business) name and address details (found on cardholder statement)
</Tip>

### Integration Instance Name

An integration instance is a specific payment provider setup in Payrails. Multiple instances can be created per provider based on region, currency, or business needs (for example, one per entity or region). Choose a clear, consistent name for routing purposes.

**In Payrails:**

* Enter an **Instance name** for your integration
  <img src="https://mintcdn.com/payrails-42074109/zqk7oWHZbW3YniA1/images/docs/amex-image-03.png?fit=max&auto=format&n=zqk7oWHZbW3YniA1&q=85&s=faa0cd21c12e103c0cbafba6beff83e4" alt="Payrails Amex integration instance name field" className="mx-auto block rounded-lg object-cover" width="80%" data-path="images/docs/amex-image-03.png" />

### Account Details

**In Payrails:**

* Enter the following values, provided by American Express:

| Field | Required | Description |
| - | - | - |
| Merchant ID | Required | Merchant ID (SE number) provided by American Express |
| Merchant Category Code | Required | Amex-specific MCC for the merchant (minimum 4 digits) |
| Acquiring Institution Identification Code | Optional | Not required for Amex-acquired processing. Leave blank. |
| Acquirer Country Code | Required | 3-digit ISO numeric code for the acquirer / merchant country - (see the American Express Global Codes & Information Guide) |
| Forwarding Institution Identification Code | Optional | Not required for Amex-acquired processing. Leave blank. |
| Merchant Terminal ID | Required | Terminal identifier for the e-commerce point of sale -assigned by the processor |
| Contact Info | Required | Merchant's telephone number, email, or web (URL) address (max 40 characters) |

<img src="https://mintcdn.com/payrails-42074109/zqk7oWHZbW3YniA1/images/docs/amex-image-04.png?fit=max&auto=format&n=zqk7oWHZbW3YniA1&q=85&s=6017114338a95497c2997fa40ec377a2" alt="Payrails Amex account details fields including merchant and acquirer values" className="mx-auto block rounded-lg object-cover" width="80%" data-path="images/docs/amex-image-04.png" />

### Acceptor Details

**In Payrails:**

* Enter the card acceptor (business) details that appear on the cardholder's statement:

| Field | Required | Description |
| - | - | - |
| Card Acceptor Name | Required | Alphanumeric, upper case. Becomes part of the descriptive bill on the cardholder's statement |
| Card Acceptor Street Name | Required | Street address of the card acceptor |
| Card Acceptor City Name | Required | Associated with the SE number for the market |
| Card Acceptor Country Code | Required | Must correspond to the Country code (see the American Express Global Codes & Information Guide) |
| Card Acceptor Region Code | Required | Must correspond to the Region code (see the American Express Global Codes & Information Guide) |
| Card Acceptor Postal Code | Optional | Associated with the SE number for the market |
| Submitter Code | Required | Configured by Payrails; used to capture payments. Merchants do not need to provide this. |

<img src="https://mintcdn.com/payrails-42074109/zqk7oWHZbW3YniA1/images/docs/amex-image-05.png?fit=max&auto=format&n=zqk7oWHZbW3YniA1&q=85&s=cc23f74fcb4cba9676fe955eb74561f6" alt="Payrails Amex card acceptor details fields" className="mx-auto block rounded-lg object-cover" width="80%" data-path="images/docs/amex-image-05.png" />

### Payment Methods

**In Payrails:**

* Select **Card** to enable American Express card payments for this integration

## Enable the Integration

**In Payrails:**

* Select **Save account** to enable the integration

The **Enabled** status indicates that the American Express integration is active. Your American Express integration is now ready to process payments.

## Next Steps

1. Run a test payment using a supported American Express [test card](https://gateway-na.americanexpress.com/api/documentation/integrationGuidelines/supportedFeatures/testAndGoLive.html?locale=en_US)
2. Verify that:
   * The payment appears in your American Express reporting
   * The payment status updates correctly in Payrails
3. Once verified in test mode, repeat the setup in live mode


## Related topics

- [Amex](/docs/analytics-and-reporting/getting-started/connect-your-data-sources/amex.md)
- [Conditions and Branching](/docs/orchestration/workflow-studio/conditions/index.md)
- [Provider Routing with Conditions](/docs/orchestration/workflow-studio/examples/provider-routing.md)