v9

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

new VivaClient(...)

Instancie le client SDK. L'authentification OAuth2 est automatique au premier appel API.

use QrCommunication\VivaMerchant\VivaClient;
use QrCommunication\VivaMerchant\Enums\Environment;

$viva = new VivaClient(
    merchantId: 'votre-merchant-uuid',
    apiKey: 'votre-api-key',
    clientId: 'xxx.apps.vivapayments.com',
    clientSecret: 'votre-client-secret',
    environment: 'demo', // string ou Environment enum
);

Où trouver les identifiants ?

  • merchantId + apiKey → Viva Dashboard > Settings > API Access
  • clientId + clientSecret → Viva Dashboard > Settings > API Access > OAuth Clients
post/VivaClient/__construct

Request body

merchantIdstring uuid required

Merchant UUID — Dashboard Viva > Settings > API Access

apiKeystring required

API Key — Dashboard Viva > Settings > API Access

clientIdstring required

OAuth Client ID — format xxx.apps.vivapayments.com

clientSecretstring required

OAuth Client Secret

environment'demo' | 'production'

Environnement ('demo' ou 'production', ou Environment enum)

Response

Instance VivaClient créée

ordersstring

Orders$viva->orders

transactionsstring

Transactions$viva->transactions

sourcesstring

Sources$viva->sources

walletsstring

Wallets$viva->wallets

bankAccountsstring

BankAccounts$viva->bankAccounts

webhooksstring

Webhooks$viva->webhooks

accountstring

Account$viva->account

nativeCheckoutstring

NativeCheckout$viva->nativeCheckout

dataServicesstring

DataServices$viva->dataServices

All 50 operations