billing

POST `/v1/payment-methods/paypal`

Begin saving a PayPal account as a payment method.

Toute la documentation pour développeurs →

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.payment.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet endpoint prend org_id comme champ dans le corps JSON.

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 POST https://api.zinndigital.com/v1/payment-methods/paypal \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Opens a PayPal vault setup token and returns the approval_url the buyer must visit to consent. No payment method is created by this call — a mandate is consent, and the row is written only once PayPal confirms it, either through POST /v1/payment-methods/paypal/confirm when the buyer returns or through PayPal's own VAULT.PAYMENT-TOKEN.CREATED webhook (ADR 0011 §3). Requires billing.payment.manage in the target organization. A saved PayPal mandate is chargeable off-session, so it may be nominated as the account's primary or its backup — including as the backup behind a card primary, which the platform charges on PayPal's rail when the card declines.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`org_id`	`string`	Non	Organization to attach the mandate to. The caller must hold `billing.payment.manage` in that organization.

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`setup_token_id`	`string`	Oui	—
`approval_url`	`string`	Oui	Where to send the buyer to approve the mandate. `null` when PayPal returned no approval link, in which case the setup cannot be completed and the customer should try again.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 409 · 422 · 429 · 503