billing

PATCH `/v1/payment-methods/{paymentMethodId}`

Nominate a stored payment method as primary or backup.

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.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

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 PATCH https://api.zinndigital.com/v1/payment-methods/{paymentMethodId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "role": <string<, primary, backup>> }'

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

Sets the mandate's account-wide `role`, demoting whichever method held that slot. A method that is not usable (unconfirmed, revoked, or past its printed expiry) is rejected with 422 rather than silently accepted — the customer must not believe their renewals are covered when they are not. Nominating the current primary as backup (or the reverse) **swaps** them atomically, so the account is never left holding two of one slot and none of the other. Promoting a method that currently has **no role** demotes the outgoing primary to `backup` when — and only when — the backup slot is empty (owner ruling 2026-08-24, #3798). A backup the customer nominated deliberately is never overwritten; the outgoing primary simply loses its role, as before. Without this the account could end up with a primary and no fallback without being told, and the automatic backup-on-decline charge could not fire. ⛔ This operation described a field named `is_default` until 2026-08-25. No such field has existed since roles replaced it — the request schema has required `role` throughout — so the published description named a parameter no client could send (D13613).

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`paymentMethodId (path)`	`string`	Oui	The stored payment method's id.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`role`	`string<, primary, backup>`	Oui	Nominate this mandate as the account's `primary` or `backup`, or send `""` to clear its role. Roles are account-wide: promoting a method demotes whichever method held that s…

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`id`	`string`	Oui	—
`gateway`	`string<stripe, paypal>`	Oui	The rail holding the mandate. Crypto (NOWPayments) is absent by design — it has no mandate primitive, so those customers are invoiced ahead rather than rebilled (ADR 0011 §6).
`status`	`string<pending, active, expired, revoked>`	Oui	Only `active` is chargeable; `pending` means the gateway has not confirmed it yet.
`role`	`string<, primary, backup>`	Oui	Which job this mandate does for the organisation. `primary` is charged first; `backup` is charged immediately if the primary declines; `""` is simply stored. ⛔ Replaced `is_…
`removal_blocked_by`	`string<, subscription, adhoc_charge, reseller_programme>`	Oui	Empty when this method may be removed. Otherwise the obligation that keeps the floor binding: this is the account's last operational way to pay and the named thing is still…
`method_type`	`string`	Oui	The gateway's own name for what kind of mandate this is — Stripe's `PaymentMethod.type` (`card`, `sepa_debit`, `klarna`, `kakao_pay`, …). Empty on a rail that does not type its…
`can_auto_renew`	`boolean`	Oui	Whether this mandate can be charged off-session, i.e. whether a renewal can be taken without the customer present. `false` means the subscription renews manually: the cu…
`brand`	`string`	Oui	—
`last4`	`string`	Oui	—
`exp_month`	`integer`	Non	—
`exp_year`	`integer`	Non	—
`holder_name`	`string`	Non	—
`confirmed_at`	`string`	Non	When the gateway confirmed the mandate. Null while `pending`.
`created_at`	`string`	Oui	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422

PATCH /v1/payment-methods/{paymentMethodId}