> ## Documentation Index
> Fetch the complete documentation index at: https://docs.i-pay.money/llms.txt
> Use this file to discover all available pages before exploring further.

# Référence API

La Référence API centralise les contrats techniques vérifiés contre l'application Rails iPayMoney : routes, méthodes HTTP, en-têtes, paramètres, réponses et erreurs.

[Ouvrir la Référence API complète](/api-reference)

* [Télécharger la spécification OpenAPI](/openapi.yaml)
* [Télécharger la collection Postman](/ipaymoney-postman-collection.json)

## Contrat public principal

| Méthode | Endpoint                                | Usage                                                              |
| ------- | --------------------------------------- | ------------------------------------------------------------------ |
| `POST`  | `/api/v1/payments`                      | Créer un paiement.                                                 |
| `GET`   | `/api/v1/payments/{reference}`          | Vérifier un paiement par référence iPayMoney ou référence externe. |
| `GET`   | `/api/v1/payments`                      | Lister les paiements du compte.                                    |
| `POST`  | `/api/v1/external_payments`             | Créer un lien de paiement hébergé.                                 |
| `GET`   | `/api/v1/external_payments/{reference}` | Consulter un lien de paiement.                                     |

Les endpoints partenaires utilisent des autorisations supplémentaires et ne font pas partie du Quick Start marchand. Les routes v2 non opérationnelles ne doivent pas être utilisées en production.

> **Sécurité :** la consultation d'un lien de paiement est actuellement accessible sans clé API et peut retourner des données client. Omettez `reference` à la création pour laisser iPayMoney générer une valeur aléatoire, gardez-la privée et n'utilisez jamais un numéro de commande séquentiel.
