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

# Planet

> Connect Planet to Payrails for card payments, covering your merchant, application and terminal IDs, password and settlement currency.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Planet** for card processing
  * Have an active Planet merchant account
</Note>

***

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

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

***

## Step 3: Configure your Planet integration

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

  Before you begin, make sure you have your Planet merchant ID, terminal ID and password, and your application ID. Planet provides them when it sets up your account.
</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_planet`.

<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 Planet merchant or user ID |
| **Application ID** | Your application ID for Planet: your company name and software version, up to 50 letters and numbers |
| **Terminal ID** | Your Planet terminal ID, up to 12 characters |
| **Settlement Currency** | Optional. Refer to [Configure Planet settings](#configure-planet-settings). |

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

***

### Credentials

**In Payrails**

| Field | Value |
| :- | :- |
| **Password** | The password Planet gives you. Payrails sends it with your merchant ID and terminal ID on every request. |

Payrails sends requests to the Planet UAT environment in test mode and to the live environment in live mode, so use the account details for the matching environment.

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

***

### Payment methods

**In Payrails**

* Select **Card**.

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

***

### Payment status updates

Planet returns the result of each request straight away, so there's no webhook to set up. If Planet doesn't answer an authorization in time, Payrails reverses it and marks the payment as canceled.

***

## Request fields for Planet

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

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Planet as the amount and currency. Planet accepts USD, EUR, GBP, CAD, HKD, CHF, INR, KWD, JPY, ARS, BRL, CLP and MXN. An amount of `0` runs an address verification. |
| `merchantReference` | Required | For manual-capture payments in a currency other than your settlement currency. Optional otherwise. Payrails sends the first 14 characters as the request identifier and order number. |
| `instrument.networkTransactionReference` | Required | For card-on-file and merchant-initiated payments. Sent as the scheme trace ID. Payrails stores it from the first payment. |
| `meta.customer.email` | Optional | Sent as the billing and shipping email. |
| `meta.customer.reference`, `meta.customer.identityCardNumber` | Optional | Sent as merchant-defined data. |
| `meta.order.billingAddress` | Optional | Sent as the billing name, address, city, state, postal code and country. |
| `meta.order.deliveryAddress` | Optional | Sent as the shipping address when you also send a billing address. |
| `meta.order.softDescriptor` | Optional | Sent as the soft descriptor that appears on the customer's statement. |
| `meta.order.description` | Optional | Sent as the descriptive information. |
| `instrument.storeInstrument` | Optional | Marks the payment as the first in a card-on-file series. |

***

## Configure Planet settings

Some Planet integration settings change how Payrails processes your payments. The portal shows the same description when you hover over each setting.

| Setting | What it does |
| :- | :- |
| **Settlement Currency** | The currency your Planet account settles in. Payments in this currency use Planet's standard payment API. Payments in any other currency use Planet's Multi-Currency Pricing (MCP) API, which converts them to your settlement currency. If you don't select one, Payrails uses USD. |

***

## Enable the integration

**In Payrails**

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

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

***

## Next steps

1. Run a test card payment in the Planet UAT environment.
2. Verify that:
   * The payment succeeds and its status updates correctly in Payrails.
   * Capture, refund and cancel work for your capture mode.
3. Once verified in test mode, repeat the setup in live mode.

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