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

# Garanti BBVA

> Connect Garanti BBVA to Payrails for card payments in Türkiye, covering your switch ID and switch password.

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

  This guide is intended for merchants who:

  * Use **Payrails** as a payment orchestrator
  * Use **Garanti BBVA** for card processing in Türkiye
  * Have an active Garanti BBVA virtual POS account
</Note>

***

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

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

***

## Step 3: Configure your Garanti BBVA integration

<Tip>
  **What you'll need from Garanti BBVA**

  Before you begin, make sure you have your Garanti BBVA switch ID and switch password. Garanti BBVA 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_garanti`.

<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 |
| :- | :- |
| **Switch ID** | Your Garanti BBVA switch ID |

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

***

### Credentials

**In Payrails**

| Field | Value |
| :- | :- |
| **Switch Password** | Your Garanti BBVA switch password. Payrails signs every request with it. |

Payrails sends requests to the Garanti BBVA integration environment in test mode and to the live environment in live mode, so use the credentials for the matching environment.

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

***

### Payment methods

**In Payrails**

* Select **Card**.

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

***

### Payment status updates

Garanti BBVA returns the result of each request straight away, and Payrails checks the result of 3D Secure payments with Garanti BBVA, so there's no webhook to set up.

***

## Request fields for Garanti BBVA

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

| Field | Status | Description |
| :- | :- | :- |
| `amount` | Required | Sent to Garanti BBVA as the amount and currency. |
| `meta.customer.email` | Required | Sent as the card holder's email. |
| `meta.clientContext.ipAddress` | Required | An IPv4 address. Sent as the card holder's IP. |
| `merchantReference` | Optional | Sent as the order ID, up to 32 characters. Use a new value for every payment. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent as the card holder's name. |
| `meta.customer.identityCardNumber` | Optional | Sent as the national ID number. |
| `meta.customer.phone.number` | Optional | Sent as the card holder's mobile number. |
| `meta.order.billingAddress`, `meta.order.deliveryAddress` | Optional | Sent as the billing and shipping addresses. |
| `installments.count` | Optional | Sent as the number of installments. |
| `meta.risk.threeDSMode` | Optional | `Force` runs 3D Secure. |

***

## Enable the integration

**In Payrails**

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

Your **Garanti BBVA** integration is now ready to process payments.

***

## Next steps

1. Run a test card payment in TRY in the Garanti BBVA integration 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.