billing

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

Nominate a stored payment method as primary or backup.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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

Параметри

Назва	Тип	Обов'язкове	Що це таке
`paymentMethodId (path)`	`string`	Так	The stored payment method's id.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`role`	`string<, primary, backup>`	Так	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…

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`string`	Так	—
`gateway`	`string<stripe, paypal>`	Так	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>`	Так	Only `active` is chargeable; `pending` means the gateway has not confirmed it yet.
`role`	`string<, primary, backup>`	Так	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>`	Так	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`	Так	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`	Так	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`	Так	—
`last4`	`string`	Так	—
`exp_month`	`integer`	Ні	—
`exp_year`	`integer`	Ні	—
`holder_name`	`string`	Ні	—
`confirmed_at`	`string`	Ні	When the gateway confirmed the mandate. Null while `pending`.
`created_at`	`string`	Так	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422

PATCH /v1/payment-methods/{paymentMethodId}