commerce
GET /v1/payment-options
The payment rails a purchase in this currency may be settled on.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/payment-options?currency=<currency> \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
What the checkout screen offers before anything is bought, so a customer picks how to pay instead of discovering after the fact that only a card was tried. Filtered exactly as getOrderPaymentOptions is, by the same function: a rail the operator has switched off is absent; a rail that cannot present currency is absent (PayPal presents 24 currencies and Indonesian rupiah is not among them); and a reseller's client receives exactly one entry — their reseller's connected gateway — because that is the only merchant account their money may land in. A customer who is suspended or overdue is deliberately not filtered: paying us is how an account stops being suspended. checkoutCart refuses any gateway that is not in this list, so the picker and the charge path read one source.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
currency (query) | CurrencyCode | Oui | ISO 4217 code the purchase is priced in. |
org_id (query) | Uuid | Non | The organization buying. Omit it and the engine uses the one organization where you hold billing.payment.manage, and refuses when you hold it in more than one — guessing which… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
gateways | string[] | Oui | Provider codes (stripe, paypal, nowpayments). Never empty — stripe is always present, because an unreadable provider registry must not be reported as "nothing is enabled". |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429