Récupérer les fournisseurs et méthodes de paiement

  • Payments
  • Paiement
  • 2 routes
Comment lister les fournisseurs de paiement et les moyens proposés ?

Ce scénario explique comment lister les fournisseurs de paiement exposés par l'API puis récupérer les moyens de paiement disponibles pour un fournisseur sélectionné.

Vue d'ensemble

Ce scénario aide une application à découvrir les fournisseurs de paiement exposés pour une locale puis à inspecter les moyens de paiement disponibles pour l'un d'eux.

Prérequis

  • Un header accept-language valide.
  • Une x-api-key valide.
  • Un provider_id retourné par la première étape pour lire les moyens de paiement détaillés.

Résultat attendu

L'application peut lister les fournisseurs disponibles, en sélectionner un puis récupérer les moyens de paiement supportés avec leurs conditions de paiement.

Process workflow

Legend:
Obligatoire
Optionnel
1

Lister les fournisseurs de paiement

Obligatoire

Utilisez GET/v1/payment_providers pour lister les fournisseurs de paiement disponibles pour la locale courante avant d'en sélectionner un pour le parcours de paiement.

Prerequis

  • Envoyez accept-language et x-api-key.
  • Appelez cette étape avant de créer un paiement.
  • Gardez la même locale sur tout le flux pour conserver un catalogue cohérent.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v1/payment_providers' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

[
  {
    "id": "EOGONE",
    "label": "Ogone",
    "connection_type": "E-Commerce",
    "payment_methods": [
      {
        "id": "AE",
        "label": "American Express",
        "category": "CreditCard",
        "time_payment_conditions": [
          {
            "id": "A1",
            "payment_count": 3,
            "required_delay_before_departure": 45
          }
        ]
      }
    ]
  }
]

info: v1 embarque déjà payment_methods dans chaque fournisseur, ce qui suffit pour alimenter le sélecteur de provider et préparer l'étape suivante.

Codes de reponse

  • OK Response (200): retourne les fournisseurs de paiement disponibles pour la locale demandée.
  • Error (400): la requête est mal formée ou une valeur d'entrée est invalide.
  • Error (401): l'authentification ou la validation de la clé API a échoué.
  • Error (403): l'accès au catalogue des fournisseurs est interdit dans le contexte courant.
  • Error (404): non documente dans le Swagger.
GET/v1/payment_providers
Voir plus
2

Inspecter les moyens de paiement du fournisseur sélectionné

Obligatoire

Utilisez GET/v1/payment_providers pour inspecter les payment_methods exposés par le fournisseur sélectionné à l'étape précédente.

Prerequis

  • Réutilisez le fournisseur choisi dans la réponse précédente de GET/v1/payment_providers.
  • Envoyez accept-language et x-api-key.
  • Appelez cette étape avant POST/v0/payments pour sélectionner un moyen et une condition de paiement compatibles.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v1/payment_providers' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

[
  {
    "id": "EOGONE",
    "label": "Ogone",
    "payment_methods": [
      {
        "id": "AE",
        "label": "American Express",
        "category": "CreditCard",
        "time_payment_conditions": [
          {
            "id": "A1",
            "payment_count": 3,
            "required_delay_before_departure": 45
          }
        ]
      }
    ]
  }
]

info: il n'y a plus de second endpoint dédié en v1 : lisez directement le tableau payment_methods sur l'objet fournisseur retenu et réutilisez ces identifiants dans le payload de paiement.

Codes de reponse

  • OK Response (200): retourne les fournisseurs et leurs moyens de paiement embarqués pour la locale demandée.
  • Error (400): la requête est mal formée ou une valeur d'entrée est invalide.
  • Error (401): l'authentification ou la validation de la clé API a échoué.
  • Error (403): l'accès au catalogue des fournisseurs est interdit dans le contexte courant.
  • Error (404): non documente dans le Swagger.
GET/v1/payment_providers
Voir plus