billing

PATCH /v1/payment-methods/{paymentMethodId}

Nominate a stored payment method as primary or backup.

सर्व billing एंडपॉइंट्स

प्रमाणीकरण

बेअरर टोकन म्हणून API की पाठवा. या एंडपॉईंटने स्पष्टीकरणामध्ये ठराविक परवानगी नमूद केलेली नाही, त्यामुळे तुमच्या कीला आवश्यक तेवढाच कमीत कमी ॲक्सेस द्या आणि गृहीत धरण्याऐवजी प्रतिसाद तपासा.

या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

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.

विनंती मुख्य भाग

नावप्रकारआवश्यकहे काय आहे
rolestring<, 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 s…

प्रतिसाद

नावप्रकारआवश्यकहे काय आहे
idstringहोय
gatewaystring<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).
statusstring<pending, active, expired, revoked>होयOnly `active` is chargeable; `pending` means the gateway has not confirmed it yet.
rolestring<, 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 `is_…
removal_blocked_bystring<, 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_typestringहोय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_renewbooleanहोय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…
brandstringहोय
last4stringहोय
exp_monthintegerनाही
exp_yearintegerनाही
holder_namestringनाही
confirmed_atstringनाहीWhen the gateway confirmed the mandate. Null while `pending`.
created_atstringहोय

ही एंडपॉइंट परत करू शकेल अशा त्रुटी

401 · 403 · 404 · 422