Référence API v0.1.0

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.

Paiements (v1)

Créer, lister et suivre les paiements (clé d'API).

GET `/v1/payments`

Lister les paiements (curseur) 🔒 clé d'API

Paramètres

Nom	Dans	Type	Requis
`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 }

POST `/v1/payments`

Cré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.

Réponses

201 : Default Response { id, status, amount_cents, currency, reference, payment_url, test, created_at }

GET `/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 }

POST `/v1/payments/{id}/simulate`

Simuler 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 }

Remboursements (v1)

Créer et lire les remboursements (clé d'API).

POST `/v1/payments/{id}/refund`

Rembourser 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
`reason`	string	non	≤ 255 car.

Réponses

201 : Default Response { id, payment_id, amount_cents, status, reason, test, created_at }

GET `/v1/payments/{id}/refunds`

Lister 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 }

GET `/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 }

Comptes (v1)

Onboarder et gérer les marchands connectés (clé plateforme).

GET `/v1/accounts/`

Lister les comptes connectés (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 }

POST `/v1/accounts/`

Créer un compte connecté (marchand) 🔒 clé d'API

Corps de la requête (JSON)

Champ	Type	Requis	Détails
`external_id`	string	oui	≥ 1 car., ≤ 255 car.
`email`	string (email)	oui
`business_name`	string	oui	≥ 1 car., ≤ 255 car.
`iban`	string	non	≥ 15 car., ≤ 34 car.

Réponses

201 : Default Response { id, external_id, business_name, email, status, charges_enabled, iban_last4, created_at }

GET `/v1/accounts/{id}`

Récupérer un compte connecté 🔒 clé d'API

Paramètres

Nom	Dans	Type	Requis	Description
`id`	path	string (uuid)	oui

Réponses

200 : Default Response { id, external_id, business_name, email, status, charges_enabled, iban_last4, created_at }

PATCH `/v1/accounts/{id}`

Mettre à jour un compte connecté 🔒 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
`iban`	string	non	≥ 15 car., ≤ 34 car.
`business_name`	string	non	≥ 1 car., ≤ 255 car.

Réponses

200 : Default Response { id, external_id, business_name, email, status, charges_enabled, iban_last4, created_at }

Plateforme (v1)

Relevé de rétrocession revenue-share (clé plateforme).

GET `/v1/platform/fees`

Détail des rétrocessions (lignes, 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 }

GET `/v1/platform/statement`

Relevé mensuel de rétrocession (revenue-share) 🔒 clé d'API

Paramètres

Nom	Dans	Type	Requis	Description
`period`	query	string	oui

Réponses

200 : Default Response { object, period, currency, fee_model, payments_count, gross_amount_cents, virevo_fee_cents, share_cents }

GET `/v1/platform/webhook_endpoints/`

Lister les endpoints webhook plateforme 🔒 clé d'API

Réponses

200 : Default Response

POST `/v1/platform/webhook_endpoints/`

Créer un endpoint webhook plateforme 🔒 clé d'API

Corps de la requête (JSON)

Champ	Type	Requis	Détails
`url`	string (uri)	oui	≤ 1024 car.

Réponses

201 : Default Response { id, url, enabled, createdAt, secret }

DELETE `/v1/platform/webhook_endpoints/{id}`

Supprimer un endpoint webhook plateforme 🔒 clé d'API

Paramètres

Nom	Dans	Type	Requis	Description
`id`	path	string (uuid)	oui

Réponses

200 : Default Response

POST `/v1/platform/webhook_endpoints/{id}/ping`

Tester un endpoint webhook plateforme 🔒 clé d'API

Paramètres

Nom	Dans	Type	Requis	Description
`id`	path	string (uuid)	oui

Réponses

202 : Default Response { ok, delivery_id }

Référence API v0.1.0

Paiements (v1)

GET /v1/payments

POST /v1/payments

GET /v1/payments/{id}

POST /v1/payments/{id}/simulate

Remboursements (v1)

POST /v1/payments/{id}/refund

GET /v1/payments/{id}/refunds

GET /v1/refunds/{id}

Comptes (v1)

GET /v1/accounts/

POST /v1/accounts/

GET /v1/accounts/{id}

PATCH /v1/accounts/{id}

Plateforme (v1)

GET /v1/platform/fees

GET /v1/platform/statement

GET /v1/platform/webhook_endpoints/

POST /v1/platform/webhook_endpoints/

DELETE /v1/platform/webhook_endpoints/{id}

POST /v1/platform/webhook_endpoints/{id}/ping

GET `/v1/payments`

POST `/v1/payments`

GET `/v1/payments/{id}`

POST `/v1/payments/{id}/simulate`

POST `/v1/payments/{id}/refund`

GET `/v1/payments/{id}/refunds`

GET `/v1/refunds/{id}`

GET `/v1/accounts/`

POST `/v1/accounts/`

GET `/v1/accounts/{id}`

PATCH `/v1/accounts/{id}`

GET `/v1/platform/fees`

GET `/v1/platform/statement`

GET `/v1/platform/webhook_endpoints/`

POST `/v1/platform/webhook_endpoints/`

DELETE `/v1/platform/webhook_endpoints/{id}`

POST `/v1/platform/webhook_endpoints/{id}/ping`