Surface publique /v1, authentification par clé d'API
(Authorization: Bearer vrv_…). Base : https://app.virevo.fr.
Pour les exemples pas à pas, voir le guide d'intégration.
Créer, lister et suivre les paiements (clé d'API).
/v1/paymentsLister les paiements (curseur) 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
status | query | enum(pending | succeeded | failed | canceled) | non | |
from | query | string (date-time) | non | |
to | query | string (date-time) | non | |
limit | query | integer | non | |
starting_after | query | string (uuid) | non |
Réponses
200 : Default Response { object, data, has_more }/v1/paymentsCréer un paiement 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
idempotency-key | header | string | non |
Corps de la requête (JSON)
| Champ | Type | Requis | Détails |
|---|---|---|---|
amount_cents | integer | oui | min 0, max 10000000 |
currency | enum(EUR) | non | défaut : "EUR" |
reference | string | non | ≥ 1 car., ≤ 140 car. |
return_url | string (uri) | non | ≤ 2048 car. |
cancel_url | string (uri) | non | ≤ 2048 car. |
payer_email | string (email) | non | ≤ 254 car. |
due_date | string | non | |
send_email | boolean | non | défaut : false |
payer_is_business | boolean | non | défaut : false |
Réponses
201 : Default Response { id, status, amount_cents, currency, reference, payment_url, test, created_at, expires_at, payer_email, due_date, payer_is_business, send_email, emails_sent, settled_elsewhere }/v1/payments/{id}Récupérer un paiement 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
id | path | string (uuid) | oui |
Réponses
200 : Default Response { id, status, amount_cents, currency, reference, payment_url, test, created_at, expires_at, payer_email, due_date, payer_is_business, send_email, emails_sent, settled_elsewhere }/v1/payments/{id}/cancelAnnuler un paiement en attente 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
id | path | string (uuid) | oui |
Corps de la requête (JSON)
| Champ | Type | Requis | Détails |
|---|---|---|---|
settled_elsewhere | boolean | non |
Réponses
200 : Default Response { id, status, amount_cents, currency, reference, payment_url, test, created_at, expires_at, payer_email, due_date, payer_is_business, send_email, emails_sent, settled_elsewhere }/v1/payments/{id}/simulateSimuler un règlement (mode test) 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
id | path | string (uuid) | oui |
Réponses
200 : Default Response { id, status, amount_cents, currency, reference, payment_url, test, created_at, expires_at, payer_email, due_date, payer_is_business, send_email, emails_sent, settled_elsewhere }Créer et lire les remboursements (clé d'API).
/v1/payments/{id}/refundRembourser un paiement (total ou partiel) 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
id | path | string (uuid) | oui | |
idempotency-key | header | string | non |
Corps de la requête (JSON)
| Champ | Type | Requis | Détails |
|---|---|---|---|
amount_cents | integer | non | min 0, max 9007199254740991 |
reason | string | non | ≤ 255 car. |
Réponses
201 : Default Response { id, payment_id, amount_cents, status, reason, test, created_at }/v1/payments/{id}/refundsLister les remboursements d'un paiement 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
id | path | string (uuid) | oui |
Réponses
200 : Default Response { object, data }/v1/refunds/{id}Récupérer un remboursement 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
id | path | string (uuid) | oui |
Réponses
200 : Default Response { id, payment_id, amount_cents, status, reason, test, created_at }/v1/installment_plansLister les échéanciers (pagination par curseur) 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
limit | query | integer | non | |
starting_after | query | string (uuid) | non |
Réponses
200 : Default Response { object, data, has_more }/v1/installment_plansCréer un échéancier (paiement en plusieurs fois) 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
idempotency-key | header | string | non |
Corps de la requête (JSON)
| Champ | Type | Requis | Détails |
|---|---|---|---|
reference | string | oui | ≥ 1 car., ≤ 140 car. |
payer | object | oui | |
currency | enum(EUR) | non | défaut : "EUR" |
installments | array<object> | oui |
Réponses
201 : Default Response { id, status, reference, payer, total_cents, paid_cents, currency, created_at, installments }/v1/installment_plans/{id}Lire un échéancier 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
id | path | string (uuid) | oui |
Réponses
200 : Default Response { id, status, reference, payer, total_cents, paid_cents, currency, created_at, installments }/v1/installment_plans/{id}/cancelAnnuler un échéancier 🔒 clé d'API
Paramètres
| Nom | Dans | Type | Requis | Description |
|---|---|---|---|---|
id | path | string (uuid) | oui |
Réponses
200 : Default Response { id, status, reference, payer, total_cents, paid_cents, currency, created_at, installments }