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

# Payzone Cash via Payzone

> Accept Payzone Cash payments from customers in Morocco, who pay in cash with a payment code, and see the fields Payzone needs.

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

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

Accept [Payzone Cash](https://docs.payrails.com/docs/integrations/payment-methods/payzone-cash) payments with Payzone as the payment service provider (PSP).

## 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 Payzone Cash payment through Payzone:

1. Set up a Payzone integration in your workspace. Follow the [Payzone integration setup guide](https://docs.payrails.com/docs/integrations/payment-providers/payzone.md) if you don't have one yet.
2. Ask Payzone for your Payzone Cash account details: the merchant ID, the POS ID, the provider ID, and the four MAC keys.
3. In the Payrails Portal, go to **Settings → Integrations**, open your Payzone integration, and fill in the fields marked **Required for Payzone Cash**.
4. Select **Payzone Cash** under **Payment methods**, and save.
5. Add Payzone Cash as a [payment option](https://docs.payrails.com/docs/integrations/payment-methods/set-up-payment-methods.md) in a workflow that uses instant capture.

## Request fields for Payzone

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 |
| - | - | - |
| `meta.customer` | Required | The customer object. Send it on every Payzone Cash request. |
| `meta.customer.reference` | Optional | Up to 16 characters. Payrails returns an error for a longer value. Sent to Payzone as the customer ID. |
| `meta.customer.name`, `meta.customer.lastName` | Optional | Sent to Payzone as the customer name. |
| `meta.customer.language` | Optional | Send a code that starts with `fr` for French or `ar` for Arabic. Payrails uses English for any other value or when the field is missing. |
| `meta.order.billingAddress.city` | Optional | Sent to Payzone as the customer city. Payrails uses `meta.order.deliveryAddress.city` when the billing city is missing. |

## Authorize a Payzone Cash payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `payzoneCash` as the `paymentMethodCode`. The response includes the redirect to the page that shows the payment code.

```json Authorize request theme={null}
{
  "amount": {
    "value": "150.00",
    "currency": "MAD"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "payzoneCash",
      "amount": {
        "value": "150.00",
        "currency": "MAD"
      }
    }
  ],
  "meta": {
    "customer": {
      "reference": "customer-1234",
      "name": "Youssef",
      "lastName": "Benali",
      "language": "fr"
    },
    "order": {
      "billingAddress": {
        "city": "Casablanca",
        "country": {
          "code": "MA"
        }
      }
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}
```

Show the payment code page to the customer, or redirect them to it. The payment stays pending until the customer pays at a payment point. Confirm the result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) before you fulfill the order.

## How Payzone handles Payzone Cash

* Payzone sends a callback when the customer pays, and Payrails moves the payment from pending to captured. Payrails can't query the payment status with Payzone, so the callback is the only source of the result.
* To stop a payment the customer hasn't paid yet, [cancel the payment](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md). Payrails cancels the cash reservation with Payzone, and Payzone confirms a reversal through a callback.
* Payzone can decline amounts below its minimum.


## Related topics

- [Payzone Cash](https://docs.payrails.com/docs/integrations/payment-methods/payzone-cash.md)
- [Payzone](https://docs.payrails.com/docs/integrations/payment-providers/payzone.md)
- [GCash](https://docs.payrails.com/docs/integrations/payment-methods/gcash.md)


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