billing

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

Nominate a stored payment method as primary or backup.

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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>> }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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).

Parametry

Nazwa	Typ	Wymagane	Co to jest
`paymentMethodId (path)`	`string`	Tak	The stored payment method's id.

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`role`	`string<, primary, backup>`	Tak	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…

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`string`	Tak	—
`gateway`	`string<stripe, paypal>`	Tak	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>`	Tak	Only `active` is chargeable; `pending` means the gateway has not confirmed it yet.
`role`	`string<, primary, backup>`	Tak	Which job this mandate does for the organisation. `primary` is charged first; `backup` is charged immediately if the primary declines; `""` is simply stored. ⛔ Replaced…
`removal_blocked_by`	`string<, subscription, adhoc_charge, reseller_programme>`	Tak	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`	Tak	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`	Tak	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…
`brand`	`string`	Tak	—
`last4`	`string`	Tak	—
`exp_month`	`integer`	Nie	—
`exp_year`	`integer`	Nie	—
`holder_name`	`string`	Nie	—
`confirmed_at`	`string`	Nie	When the gateway confirmed the mandate. Null while `pending`.
`created_at`	`string`	Tak	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422

PATCH /v1/payment-methods/{paymentMethodId}