Spécification OpenAPI

L'API v2 est décrite dans un fichier OpenAPI 3.1 : routes, paramètres, corps, réponses, objets et erreurs. Importez-le dans votre outil (Postman, Insomnia, Swagger Editor) ou générez un client dans votre langage.

Le fichier

https://cashchap.com/docs/openapi/v2.yaml

Télécharger v2.yaml Afficher le fichier

Le fichier est servi en lecture seule, sans cookie, et peut être chargé par un outil en ligne. Il suit les versions de l'API : son info.version (2.4.0) est celle de l'en-tête CashChap-Version, et chaque évolution de la v2 y est reportée (voir le journal des changements).

Ce qu'il contient

Les 29 opérations de l'API v2, regroupées par thème : catalogue, encaissements, transactions, retraits, terminaux, liens de paiement, QR codes de caisse, routes à venir (501).
Le schéma d'authentification Authorization: Bearer ; les routes publiques (activation d'un terminal, liens de paiement) sont marquées sans clé.
Les objets Transaction, Devis, MoyenPaiement, Terminal, LienPaiement et l'enveloppe d'erreur, avec les valeurs possibles des statuts, canaux et types d'erreur.
Les en-têtes Idempotency-Key, X-Request-Id, Retry-After, Location, Idempotent-Replayed et CashChap-Version (sur toutes les réponses).
Le format des numéros : phone au format international, sans « + » (2290197000000), et country facultatif.

Exemples d'utilisation

Terminal

# Générer un client TypeScript (openapi-generator)
npx @openapitools/openapi-generator-cli generate \
  -i https://cashchap.com/docs/openapi/v2.yaml \
  -g typescript-fetch -o ./cashchap-client

Postman : Import › Link, collez l'adresse du fichier, puis renseignez votre clé Sandbox dans l'autorisation « Bearer Token » de la collection.
Serveur : https://api.cashchap.com/v2 (Live et Sandbox, selon la clé).