---
title: "$viva->orders->create()"
method: POST
path: "/Orders/create"
tags: ["Orders"]
---

# $viva->orders->create()

`POST /Orders/create`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php/docs/Orders/create/post.ts> (a function with typed inputs; its response is checked against the schema)

Crée un ordre de paiement Smart Checkout. Le client est redirigé vers l'URL de checkout Viva pour finaliser le paiement.

```php
$order = $viva->orders->create(
    amount: 1500,                         // 15,00 EUR (centimes)
    customerDescription: 'Consultation',  // Affiché au client
    merchantReference: 'session_123',     // Référence interne
    allowRecurring: true,                 // Tokeniser la carte
    preauth: false,                       // Pré-autorisation ?
    maxInstallments: 3,                   // Paiement en 3x
);

echo $order['order_code'];   // 1234567890
echo $order['checkout_url']; // https://demo.vivapayments.com/web/checkout?ref=1234567890

// Rediriger le client :
header('Location: ' . $order['checkout_url']);
```

## Request body

- OrdersCreateParams
  - `amount` integer, required: Montant en centimes (`1500` = 15,00 EUR)
  - `customerDescription` string, nullable: Description affichée au client dans le checkout
  - `merchantReference` string, nullable: Référence interne (apparaît dans les exports)
  - `sourceCode` string, nullable: Code source de paiement (`null` = source par défaut)
  - `allowRecurring` boolean: Autoriser la tokenisation de la carte pour les charges récurrentes
  - `preauth` boolean: Pré-autorisation uniquement (capturer plus tard avec `transactions->capture()`)
  - `maxInstallments` integer: Nombre max de versements (`0` = désactivé)

## Response `200`

Ordre créé

- OrdersCreateResult
  - `order_code` integer: Code unique de l'ordre Viva
  - `checkout_url` string, uri: URL Smart Checkout pour rediriger le client

## Other responses

- `400`: `ApiException` — Erreur de création (montant invalide, source inconnue, etc.)

## Changes

- **2026-03-18** `b25ecb15a272`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php/changes/Orders/create/post.md)

---

[API](https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php.md) - [All operations](https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php/llms.txt) - [OpenAPI document](https://skmtc.dev/qrcommunication/apis/viva-wallet-merchant-sdk-re-fe-rence-php/revisions/bcafd06ce584?raw)