Payzone Cash via Payzone

Accept Payzone Cash payments with Payzone as the payment service provider (PSP).

Supported workflows

Before you begin

Complete these steps before you send your first Payzone Cash payment through Payzone:

Set up a Payzone integration in your workspace. Contact your Payrails account team if Payzone isn’t listed in your Payrails Portal yet.
Ask Payzone for your Payzone Cash account details: the merchant ID, the POS ID, the provider ID, and the four MAC keys.
In the Payrails Portal, go to Settings → Integrations, open your Payzone integration, and fill in the fields marked Required for Payzone Cash.
Select Payzone Cash under Payment methods, and save.
Add Payzone Cash as a payment option 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. 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 with payzoneCash as the paymentMethodCode. The response includes the redirect to the page that shows the payment code.

Authorize request

{
  "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 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. Payrails cancels the cash reservation with Payzone, and Payzone confirms a reversal through a callback.
Payzone can decline amounts below its minimum.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Payzone Cash via Payzone

Supported workflows

Before you begin

Request fields for Payzone

Authorize a Payzone Cash payment

How Payzone handles Payzone Cash

​Supported workflows

​Before you begin

​Request fields for Payzone

​Authorize a Payzone Cash payment

​How Payzone handles Payzone Cash

Supported workflows

Before you begin

Request fields for Payzone

Authorize a Payzone Cash payment

How Payzone handles Payzone Cash