reseller

PATCH `/v1/reseller/currencies`

Choose the currencies, the default, and what you sell in.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.manage; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X PATCH https://api.zinndigital.com/v1/reseller/currencies \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

`currencies` replaces the list your clients may be quoted in; send an empty array to go back to offering every currency we can charge. `default_currency` is what a client is quoted in before they choose and must be one you offer. `sell_in_currency` is what you are settled in and is deliberately **not** required to be one of them — a reseller may be paid in one currency and sell in others. `switcher: false` hides the control from your clients. A currency no payment gateway can capture is refused rather than dropped, because a currency we can display and cannot charge is a checkout that fails at the last step. Requires `reseller.manage`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`org_id (query)`	`Uuid`	Não	Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r…

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`currencies`	`string[]`	Não	Replaces the list your clients may be quoted in. An empty array returns you to offering every currency we can charge.
`default_currency`	`string`	Não	Empty returns to the platform answer. Must be one you offer.
`sell_in_currency`	`string`	Não	Empty returns to the platform base currency. Deliberately not required to be one of `currencies`.
`switcher`	`boolean`	Não	Whether the currency control renders in your clients' panel.

Resposta

Nome	Tipo	Obrigatório	O que é
`currencies`	`ResellerCurrency[]`	Sim	—
`offers_all`	`boolean`	Sim	You have made no choice, so your clients get every currency.
`offered_count`	`integer`	Sim	—
`total_count`	`integer`	Sim	—
`default_currency`	`string`	Sim	What a client is quoted in before they choose. Empty means the platform answer — their own inference, then USD.
`sell_in_currency`	`string`	Sim	What you are priced and settled in, resolved — never empty, and never disclosed to your clients.
`switcher`	`boolean`	Sim	Whether the currency control renders in your clients' panel at all. `false` quotes every client in `default_currency`.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429