commerce
GET /v1/payment-options
The payment rails a purchase in this currency may be settled on.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/payment-options?currency=<currency> \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
What the checkout screen offers before anything is bought, so a customer picks how to pay instead of discovering after the fact that only a card was tried. Filtered exactly as getOrderPaymentOptions is, by the same function: a rail the operator has switched off is absent; a rail that cannot present currency is absent (PayPal presents 24 currencies and Indonesian rupiah is not among them); and a reseller's client receives exactly one entry — their reseller's connected gateway — because that is the only merchant account their money may land in. A customer who is suspended or overdue is deliberately not filtered: paying us is how an account stops being suspended. checkoutCart refuses any gateway that is not in this list, so the picker and the charge path read one source.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
currency (query) | CurrencyCode | Yes | ISO 4217 code the purchase is priced in. |
org_id (query) | Uuid | No | The organization buying. Omit it and the engine uses the one organization where you hold billing.payment.manage, and refuses when you hold it in more than one — guessing which… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
gateways | string[] | Yes | Provider codes (stripe, paypal, nowpayments). Never empty — stripe is always present, because an unreadable provider registry must not be reported as "nothing is enabled". |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429