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

# Craftgate

> Connect Craftgate to Payrails for cards and YKB WorldPay in Türkiye, covering your API keys, callback keys and webhook.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Craftgate** for cards or [YKB WorldPay](/docs/orchestration/payment-methods/ykb-worldpay/craftgate) in Türkiye
  * Have access to the Craftgate merchant panel
</Note>

***

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

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

***

## Step 3: Configure your Craftgate integration

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

  Before you begin, make sure you can log in to the Craftgate merchant panel. You'll copy your API keys and callback keys there and set up a webhook. To add a payment method such as YKB WorldPay to your Craftgate account, contact Craftgate.
</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_craftgate`.

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

***

### Credentials

**In Craftgate**

1. In the Craftgate merchant panel, go to **Settings** → **API Keys** and copy the API key and secret key.
2. Go to **Settings** → **Merchant Settings** and copy the 3DS callback key and the merchant callback key.

**In Payrails**

| Field | Value |
| :- | :- |
| **API Key** | Your Craftgate API key |
| **Secret Key** | Your Craftgate secret key. Payrails signs every request with it. |
| **3DS Callback Key** | Your 32-character 3DS callback key. Payrails uses it to verify 3D Secure callbacks. |
| **APM Callback Key** | Your merchant callback key. Payrails uses it to verify YKB WorldPay callbacks. |
| **Webhook Key** | Your Craftgate webhook key. Fill it in after you set up the webhook in the next section. |

Fill in all the keys, so that Payrails verifies every callback and webhook from Craftgate. Payrails sends requests to the Craftgate sandbox in test mode and to the live environment in live mode, so use the keys for the matching environment.

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

***

### Payment methods

**In Payrails**

* Select **Card**, **YKB WorldPay** or both.

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

***

### Webhooks or notifications

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

<Warning>
  Create webhooks in the same mode (test or live) as your Payrails integration.
</Warning>

**In Payrails**

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

**In Craftgate**

1. In the Craftgate merchant panel, go to **Settings** → **Merchant Settings** → **Webhook**.
2. Add the Payrails notification URL.
3. Copy the webhook key into the **Webhook Key** field in Payrails, and save both sides.

***

## Request fields for Craftgate

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

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Craftgate as the price, paid price and currency. |
| `instrument.data.bin` | Required | When `installments.count` is more than 1. Payrails uses it to price the installment plan. |
| `merchantReference` | Optional | Sent as the conversation ID. |
| `meta.order.description` | Optional | Sent as the item name. |
| `meta.clientContext.ipAddress` | Optional | Sent as the client IP. |
| `instrument.holderName` | Optional | Sent as the card holder. If you don't send it, Payrails uses `meta.customer.name` and `meta.customer.lastName`. |
| `meta.customer.reference`, `meta.customer.email`, `meta.customer.phone` | Optional | Sent as buyer details for Craftgate fraud checks. |
| `meta.risk.merchantDefinedData.customFraudVariable` | Optional | Sent as the custom fraud variable. |
| `meta.risk.threeDSMode` | Optional | `Force` runs 3D Secure. Craftgate can also ask for 3D Secure when the bank requires it. |
| `installments.count` | Optional | Sent as the number of installments. Installment plans with interest need instant capture. |
| `instrument.storeInstrument` | Optional | Stores the card with Craftgate for later payments. |

***

## Enable the integration

**In Payrails**

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

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

***

## Next steps

1. Run a test card payment in TRY in the Craftgate sandbox.
2. Verify that:
   * The payment appears in the Craftgate merchant panel.
   * The payment status updates correctly in Payrails.
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

- [YKB WorldPay via Craftgate](/docs/orchestration/payment-methods/ykb-worldpay/craftgate.md)
- [YKB WorldPay](/docs/orchestration/payment-methods/ykb-worldpay.md)
- [Integrations](/docs/orchestration/integrations.md)


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