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

# OmanNet via Checkout.com

> Set up OmanNet debit card payments through Checkout.com in Payrails, with the cardholder name and OMR amounts it needs.

<picture noZoom>
  ![OmanNet logo](https://assets.payrails.io/img/logos/omannet/logo-full-bleed.svg)
</picture>

<picture noZoom>
  ![Checkout.com logo](https://assets.payrails.io/img/logos/checkout/logo-full-bleed.svg)
</picture>

Accept [OmanNet](https://docs.payrails.com/docs/integrations/payment-methods/omannet) debit card payments in OMR with Checkout.com as the payment service provider (PSP). You send an OmanNet card as a regular card payment, Checkout.com recognizes the card from its number, and the customer confirms the payment with their bank.

## Supported workflows

<table>
  <thead>
    <tr><th>Workflow</th><th>Supported</th></tr>
  </thead>

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td></tr>
    <tr><td>Payrails API</td><td>✔</td></tr>
    <tr><td>[Delayed / Manual Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✖</td></tr>
    <tr><td>[Instant Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✔</td></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</td><td>✖</td></tr>
    <tr><td>[Refund / Reverse](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md)</td><td>✔</td></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</td><td>✖</td></tr>
    <tr><td>[Merchant Initiated Transaction (MIT)](https://docs.payrails.com/docs/resources/payments/authorization-flags.md)</td><td>✖</td></tr>
  </tbody>
</table>

## Before you begin

Complete these steps before you send your first OmanNet payment through Checkout.com:

1. Set up a Checkout.com integration in your workspace. Follow the [Checkout.com integration setup guide](https://docs.payrails.com/docs/integrations/payment-providers/checkout-com.md) if you don't have one yet, including the webhook setup. Checkout.com confirms OmanNet payments only through webhooks.
2. Ask Checkout.com to enable OmanNet on the processing channel of your Checkout.com account.
3. In the Payrails Portal, go to **Settings → Integrations**, open your Checkout.com integration, select **Card** under **Payment methods**, and save.
4. Add cards as a [payment option](https://docs.payrails.com/docs/integrations/payment-methods/set-up-payment-methods.md) in your workflow, and route OMR card payments to your Checkout.com integration.

## Request fields for Checkout.com

Send these fields in the authorize request, in addition to the standard [authorize fields](https://docs.payrails.com/reference/authorizeaction.md). **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to the PSP when you include them.

| Field | Status | Description |
| - | - | - |
| `amount.currency` | Required | `OMR`. Send the amount with three decimal places, such as `"12.500"`. |
| `paymentComposition[].paymentInstrumentData` | Required | The card data you collected with Payrails secure fields or client-side encryption, or use `paymentInstrumentId` for a card the customer already saved. |
| Cardholder name (`holderName` in the card data) | Required | Checkout.com declines OmanNet payments without it. With the Web SDK, set `showCardHolderName: true` on the card form. With client-side encryption, include `holderName` in the encrypted card data. Payrails sends it to Checkout.com as the card name. |
| `returnInfo.success`, `returnInfo.error` | Required | Where the customer lands after confirming the payment with their bank. |
| `meta.risk.threeDSMode` | Optional | Set to `Skip` so Payrails tells Checkout.com not to run 3D Secure. OmanNet payments use the bank confirmation step instead of 3D Secure. |
| `meta.customer.email` | Optional | Sent to Checkout.com as the customer email. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent to Checkout.com as the customer name. |
| `meta.customer.phone` | Optional | Sent to Checkout.com as the customer phone number. |

## Authorize an OmanNet payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `card` as the `paymentMethodCode`. In this example, the card data comes from Payrails secure fields as encrypted data. The response includes a redirect to the page where the customer confirms the payment with their bank.

```json Authorize request theme={null}
{
  "amount": {
    "value": "12.500",
    "currency": "OMR"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "card",
      "amount": {
        "value": "12.500",
        "currency": "OMR"
      },
      "paymentInstrumentData": {
        "encryptedData": "<encrypted-card-data>",
        "vaultProviderConfigId": "<vault-provider-config-id>"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Salim",
      "lastName": "Al Harthy",
      "email": "salim@example.com"
    },
    "risk": {
      "threeDSMode": "Skip"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

After the customer confirms the payment, they return to your `success` or `error` URL. Confirm the result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status before you fulfill the order.

## How Checkout.com handles OmanNet

* Payrails sends OmanNet cards to Checkout.com as standard card payments. Checkout.com identifies OmanNet cards from the card number, so you don't send a separate payment method code.
* Checkout.com authorizes and captures OmanNet payments in one step. Configure your workflow for instant capture.
* Payrails sends the cardholder name to Checkout.com whenever the card data includes it. When Checkout.com declines a payment for a missing cardholder name, Payrails returns an invalid instrument result with the account holder name as the reason.
* Depending on the bank, the customer confirms the payment with a one-time password (OTP) on the bank page.
* Checkout.com refunds OmanNet payments for the full payment amount, through the standard Checkout.com refund flow.


## Related topics

- [OmanNet](https://docs.payrails.com/docs/integrations/payment-methods/omannet.md)
- [Przelewy24 via Checkout.com](https://docs.payrails.com/docs/integrations/payment-methods/przelewy24/checkout-com.md)
- [Bancontact via Checkout.com](https://docs.payrails.com/docs/integrations/payment-methods/bancontact/checkout-com.md)


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