Sign in

v9

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-05-05502770.7 KB
Orders

$viva->orders->create()

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

$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']);
post/Orders/create

Request body

amountinteger required

Montant en centimes (1500 = 15,00 EUR)

customerDescriptionstring nullable

Description affichée au client dans le checkout

merchantReferencestring nullable

Référence interne (apparaît dans les exports)

sourceCodestring nullable

Code source de paiement (null = source par défaut)

allowRecurringboolean

Autoriser la tokenisation de la carte pour les charges récurrentes

preauthboolean

Pré-autorisation uniquement (capturer plus tard avec transactions->capture())

maxInstallmentsinteger

Nombre max de versements (0 = désactivé)

Example request

{
  "amount": 1500,
  "customerDescription": "Consultation naturopathie",
  "merchantReference": "session_123"
}

Response

Ordre créé

order_codeinteger

Code unique de l'ordre Viva

checkout_urlstring uri

URL Smart Checkout pour rediriger le client

Example response

{
  "order_code": 1234567890,
  "checkout_url": "https://demo.vivapayments.com/web/checkout?ref=1234567890"
}