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

# STC Pay via Checkout.com

> Accept STC Pay wallet payments from customers in Saudi Arabia through Checkout.com, including the SMS one-time code step.

<picture noZoom>
  ![STC Pay logo](https://assets.payrails.io/img/logos/stcpay/logo.svg)
</picture>

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

Accept [STC Pay](https://docs.payrails.com/docs/orchestration/payment-methods/stc-pay) payments from customers in Saudi Arabia with Checkout.com as the payment service provider (PSP). The customer enters the mobile number registered to their STC Pay wallet, then confirms the payment with the one-time code that STC Pay sends by SMS.

## 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 STC Pay 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/orchestration/integrations/checkout-com.md) if you don't have one yet.
2. Ask Checkout.com support to enable STC Pay on your Checkout.com account.
3. In the Payrails Portal, go to **Settings → Integrations**, open your Checkout.com integration, select **STC Pay** under **Payment methods**, and save.
4. Add STC Pay as a [payment option](https://docs.payrails.com/docs/orchestration/payment-methods/set-up-payment-methods.md) in your workflow.

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

STC Pay sends the one-time code to the phone number in the payer fields, so send the number there. The Payrails SDK collects it for you.

| Field | Status | Description |
| - | - | - |
| `paymentComposition[].paymentInstrumentData.payerFields.phoneCountryCode` | Required | The dialing code of the customer's phone, digits only, for example `966`. |
| `paymentComposition[].paymentInstrumentData.payerFields.phoneNumber` | Required | The mobile number registered to the customer's STC Pay wallet, without the dialing code, for example `512345678`. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent to Checkout.com as the customer name. |
| `meta.customer.email` | Optional | Sent to Checkout.com as the customer email. |
| `meta.customer.country.code` | Optional | Sent to Checkout.com as the customer country. |

To confirm the payment, send the code in the confirm request:

| Field | Status | Description |
| - | - | - |
| `data.otp` | Required | The one-time code the customer received by SMS, digits only. |

## Authorize an STC Pay payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `stcPay` as the `paymentMethodCode`.

```json Authorize request theme={null}
{
  "amount": {
    "value": "150.00",
    "currency": "SAR"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "stcPay",
      "amount": {
        "value": "150.00",
        "currency": "SAR"
      },
      "paymentInstrumentData": {
        "payerFields": {
          "phoneCountryCode": "966",
          "phoneNumber": "512345678"
        }
      }
    }
  ],
  "meta": {
    "customer": {
      "email": "noura.alqahtani@example.com",
      "name": "Noura",
      "lastName": "Al-Qahtani"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

STC Pay sends the customer a one-time code by SMS. The payment stays in `authorizePending`, and the execution's `requiredAction` has the type `collectInput` with the confirm link in `requiredAction.href`.

## Confirm the payment with the code

Ask the customer for the code, then [confirm the payment](https://docs.payrails.com/reference/confirmaction.md) with the code in `data.otp`. Send the request to the `requiredAction.href` link.

```json Confirm request theme={null}
{
  "data": {
    "otp": "123456"
  }
}
```

After you send the code, the payment stays in `authorizePending` until Checkout.com sends the final result. 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.

The [Web SDK](https://docs.payrails.com/docs/orchestration/checkout-sdks/web) shows STC Pay when your workflow returns it as a payment option. The SDK collects the customer's phone number, then shows a screen where the customer enters the code STC Pay sends by SMS and clicks **Confirm**. Follow [How to accept APMs without a redirect](https://docs.payrails.com/docs/orchestration/checkout-sdks/web/guides/how-to-accept-alternative-payment-methods-without-a-redirect.md) for the full integration, including how to change the form's appearance and texts.

> [!NOTE]
>
> STC Pay is supported in Web SDK version 6.10.0 onwards.

## How Checkout.com handles STC Pay

* Payrails creates the STC Pay payment through the Checkout.com Payment Setup API. Checkout.com needs no payment token for STC Pay.
* Payrails checks the phone number before it calls Checkout.com, and sends it to Checkout.com on the customer.
* The code is valid for 5 minutes.
* Payrails sends the merchant reference to Checkout.com, cut to 80 characters.
* Checkout.com sends the final result as a webhook notification.
* Each STC Pay payment is a new customer-initiated payment.


## Related topics

- [STC Pay](https://docs.payrails.com/docs/orchestration/payment-methods/stc-pay.md)
- [Przelewy24 via Checkout.com](https://docs.payrails.com/docs/orchestration/payment-methods/przelewy24/checkout-com.md)
- [Bancontact via Checkout.com](https://docs.payrails.com/docs/orchestration/payment-methods/bancontact/checkout-com.md)


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