Référentiels

Lister les moyens de paiement

GET /v1/payment-methods
vpn_key Toute clé valide Compte comme une lecture

Renvoie les moyens de paiement du compte : ceux d'origine (espèces, carte bancaire, chèque, avoir, crédit) et ceux que le commerçant a créés. Toute clé valide peut l'appeler.

actif dit si le moyen de paiement est proposé au moment d'encaisser. Les moyens archivés sont listés aussi, en fin de liste.

La liste est courte et renvoyée en une seule fois, sans paramètre.

Exemple d'appel

curl "https://api.wanapos.com/v1/payment-methods" \
  -H "Authorization: Bearer VOTRE_CLE"

Réponse en cas de succès (statut 200)

Les moyens de paiement du compte.

Champ Type Description
data liste Moyens de paiement du compte, dans l'ordre d'affichage, archivés en fin de liste.
data[].id entier Identifiant du moyen de paiement.
data[].name texte Nom du moyen de paiement.
data[].actif booléen true si le moyen de paiement est proposé au moment d'encaisser.
data[].is_default booléen true pour un moyen de paiement d'origine (espèces, carte bancaire, chèque, avoir, crédit), false pour un moyen créé par le commerçant.
data[].position entier Ordre d'affichage dans l'application.
data[].archived booléen true si le moyen de paiement a été archivé par le commerçant.
meta objet
meta.request_id texte Identifiant de l'appel.
meta.count entier Nombre d'éléments renvoyés.
{
    "data": [
        {
            "id": 1,
            "name": "Espèces",
            "actif": true,
            "is_default": true,
            "position": 1,
            "archived": false
        },
        {
            "id": 2,
            "name": "Carte bancaire",
            "actif": true,
            "is_default": true,
            "position": 2,
            "archived": false
        },
        {
            "id": 6,
            "name": "Virement",
            "actif": true,
            "is_default": false,
            "position": 6,
            "archived": false
        }
    ],
    "meta": {
        "request_id": "3f9a1c0b7d2e4a61",
        "count": 3
    }
}

Erreurs possibles

  • 401 Clé absente, inconnue ou révoquée. Codes : missing_key, invalid_key.
  • 403 Appel refusé pour ce compte ou cette clé. Codes : api_not_activated, account_not_eligible, access_blocked, missing_scope.
  • 422 Un paramètre est absent, inconnu ou invalide. Code : invalid_parameter. Le champ field nomme le paramètre.
  • 429 Quota dépassé. Codes : rate_limited, daily_quota_exceeded, too_many_failed_attempts. L'en-tête Retry-After indique combien de secondes attendre.

Voir toutes les erreurs

Une question ? contact@wanapos.com