{"info":{"title":"Selectwin Public API","contact":{"url":"https://selectwin.io","name":"Selectwin","email":"help@selectwin.io"},"license":{"url":"https://selectwin.io","name":"Proprietary"},"summary":"API REST para pagamentos, clientes, assinaturas, carteiras, recebíveis, webhooks e integrações; autenticação via cabeçalho `selectkey`.","version":"2.0.0","description":"## Introdução\n\nA **Selectwin Public API** segue boas práticas REST: você chama os endpoints com os verbos HTTP corretos,\nenvia e recebe **JSON** e interpreta o resultado pelos códigos de status. Funciona em qualquer linguagem ou stack.\n\nOferecemos chaves de **sandbox** e **produção**. No ambiente de testes você valida fluxos sem impacto financeiro\nreal (sem cobrança real em cartão) antes de ir para produção.\n\n---\n\n## Autenticação\n\nA maioria das requisições é autenticada por **API key** no cabeçalho **`selectkey`** (o nome HTTP é\ncase-insensitive). Fluxos de painel/usuário usam um **Bearer JWT** no cabeçalho `Authorization`.\n\n```bash\ncurl -sS \"https://api.selectwin.io/v1/transactions\" \\\n  -H \"selectkey: sk_live_...\" \\\n  -H \"Content-Type: application/json\"\n```\n\nEndpoints de login (`POST /v1/authentication/token`), cadastro e o JWKS público **não** exigem credencial.\n\n---\n\n## Códigos de status\n\n**2xx** sucesso · **4xx** erro do cliente (validação, permissão, recurso inexistente) · **5xx** erro no servidor.\n\n| Código | Significado | Quando ocorre |\n| --- | --- | --- |\n| 200 | OK | Sucesso com corpo de resposta. |\n| 201 | Created | Recurso criado. |\n| 400 | Bad Request | Validação da requisição falhou (detalhes por campo em `error.params`). |\n| 401 | Unauthorized | Chave/Token inválido ou ausente. |\n| 402 | Payment Required | Cobrança recusada pelo emissor (transações/assinaturas). Veja `error.code` / `error.displayMessage`. |\n| 403 | Forbidden | Autenticado, mas sem permissão (escopo, restrição de IP). |\n| 404 | Not Found | Recurso não encontrado. |\n| 409 | Conflict | Conflito de idempotência (replay em andamento ou corpo divergente). |\n| 422 | Unprocessable Entity | Payload válido, mas regra de negócio impede o processamento. |\n| 429 | Too Many Requests | Limite de taxa excedido. |\n| 500 | Internal Server Error | Erro inesperado no servidor. |\n\n### Envelope de erro\n\nTodo erro retorna `{ \"error\": { ... } }`. Use **`error.code`** (estável, legível por máquina) para\ntratar o erro; `message`/`details` são texto humano e podem ser localizados.\n\n---\n\n## Idempotência\n\nOperações de criação aceitam o cabeçalho **`X-Idempotency-Key`**. Reenviar a mesma chave com o mesmo\ncorpo retorna a resposta original (sem duplicar a cobrança); com corpo diferente retorna **409**.\n\n---\n\n## Paginação\n\nListagens aceitam **`sort`**, **`offset`** e **`limit`**. O envelope traz `offset`, `limit`, `total`,\n`hasMore` e `data[]` (o formato de cada item depende do recurso).\n\n---\n\n## Webhooks\n\nEm vez de **polling**, assine **webhooks** para mudanças de status. Configure em `/v1/webhooks` e acompanhe\nas entregas em `/v1/webhooks/dispatches`. O modelo do payload enviado **à sua URL** está na seção\n**Webhooks** (`eventDelivery`). Consideramos entrega bem-sucedida apenas respostas HTTP **200** ou **201**.\n\n---\n\n## Segurança (TLS)\n\nIntegre pelo **FQDN** `api.selectwin.io` sobre **TLS 1.2+** (recomendado 1.3). Não recomendamos\ncertificate pinning pela chave pública."},"tags":[{"name":"Addresses","description":"Gerencie endereços vinculados a clientes e demais contextos compatíveis: criar, listar, consultar, atualizar e excluir."},{"name":"Cards","description":"Cadastre e mantenha cartões tokenizados para cobrança."},{"name":"Checkout","description":"Funil de checkout: sessões, links de pagamento, templates, order bumps, upsells, pixels e reviews."},{"name":"Coupons","description":"Crie e administre cupons de desconto para checkouts e campanhas."},{"name":"Customers","description":"Clientes: criar, listar, consultar, atualizar e remover, com filtros para integrar CRM, cobrança e suporte."},{"name":"Finance","description":"Consultas financeiras da conta: saldo disponível/pendente/bloqueado e histórico de movimentos."},{"name":"Marketplace","description":"Sub-contas de uma plataforma (Connect): cadastre vendedores sob a sua conta, emita o link de credenciamento (KYC) de cada um, defina a taxa da plataforma ou um plano de taxas e cobre em nome deles com onBehalfOf. Recurso habilitado por conta."},{"name":"Pricing","description":"Preços públicos da Selectwin: os planos ativos de cada produto da plataforma, sem autenticação (a taxa de cada conta segue a da conta)."},{"name":"Products","description":"Gerencie o catálogo de produtos: criar, listar, consultar, atualizar e excluir, com paginação."},{"name":"Products - Variants","description":"Gerencie variantes de produto (preços, SKU, recorrência): criação/listagem por produto, leitura e exclusão por variante."},{"name":"Receivables","description":"Consulte recebíveis (valores a receber, liquidações) com filtros e paginação."},{"name":"Simulators","description":"Simuladores de parcelamento e meios de pagamento para exibir valores antes da cobrança real."},{"name":"Subscriptions","description":"Gerencie assinaturas recorrentes (catálogo-strict): criação, ciclos, itens, splits, thresholds, pausa e cancelamento."},{"name":"Transactions","description":"Crie e acompanhe transações (cartão, Pix, boleto): captura, estorno, disputa. Cobrança assíncrona em duas fases."},{"name":"Utils","description":"Utilitários públicos: validação de BIN, CEP, tipos de empresa, referências de webhooks e helpers."},{"name":"Wallets","description":"Administre carteiras e dados bancários para recebimentos e saques."},{"name":"Webhooks","description":"Configure webhooks: em `paths`, gerencie endpoints/eventos/entregas; na seção Webhooks está o payload que enviamos à sua URL."},{"name":"Withdrawals","description":"Solicite e acompanhe saques para contas bancárias cadastradas."},{"name":"tokenization","description":"Operações do grupo tokenization."}],"paths":{"/v1/cards":{"get":{"tags":["Cards"],"summary":"Lista os cartões","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","holderName","brand","firstDigits","lastDigits","expirationMonth","expirationYear","primary","active","valid","verified","associated","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(card)_.+$","description":"Identificador público (card_…)"},"brand":{"type":"string","description":"Bandeira do cartão (ex.: `visa`, `mastercard`)."},"valid":{"type":"boolean","description":"Se o cartão passou na validação."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"active":{"type":"boolean","description":"Se o cartão pode ser cobrado."},"primary":{"type":"boolean","description":"Se é o cartão principal do cliente."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"verified":{"type":"boolean","description":"Se o cartão foi verificado com o emissor."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"associated":{"type":"boolean","nullable":true,"description":"Se o cartão está vinculado ao cliente para cobrança. `null` = pendente: o cartão entrou por uma tela do comprador e ainda não tem cobrança aprovada."},"holderName":{"type":"string","nullable":true,"description":"Nome impresso no cartão."},"lastDigits":{"type":"string","description":"Quatro últimos dígitos do cartão."},"firstDigits":{"type":"string","description":"Seis primeiros dígitos do cartão (BIN)."},"expirationYear":{"type":"string","description":"Ano de validade (`YYYY`)."},"expirationMonth":{"type":"string","description":"Mês de validade (`MM`)."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"card_0a1b2c3d4e5f60718293","brand":"string","valid":true,"_links":{},"active":true,"primary":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"verified":true,"createdAt":"string","updatedAt":"string","associated":true,"holderName":"JOAO SILVA","lastDigits":"string","firstDigits":"string","expirationYear":"string","expirationMonth":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"limit","schema":{"type":"integer","default":10,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"enum":["ascending","descending"],"type":"string","default":"ascending"},"required":false,"description":"Ordem pela data de criação."},{"in":"query","name":"holderid","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":false,"description":"Só os cartões deste cliente."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(card)_.+$"},"required":false,"description":"Só este cartão."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listCards"},"post":{"tags":["Cards"],"summary":"Cria um cartão","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","holderName","brand","firstDigits","lastDigits","expirationMonth","expirationYear","primary","active","valid","verified","associated","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(card)_.+$","description":"Identificador público (card_…)"},"brand":{"type":"string","description":"Bandeira do cartão (ex.: `visa`, `mastercard`)."},"valid":{"type":"boolean","description":"Se o cartão passou na validação."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"active":{"type":"boolean","description":"Se o cartão pode ser cobrado."},"primary":{"type":"boolean","description":"Se é o cartão principal do cliente."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"verified":{"type":"boolean","description":"Se o cartão foi verificado com o emissor."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"associated":{"type":"boolean","nullable":true,"description":"Se o cartão está vinculado ao cliente para cobrança. `null` = pendente: o cartão entrou por uma tela do comprador e ainda não tem cobrança aprovada."},"holderName":{"type":"string","nullable":true,"description":"Nome impresso no cartão."},"lastDigits":{"type":"string","description":"Quatro últimos dígitos do cartão."},"firstDigits":{"type":"string","description":"Seis primeiros dígitos do cartão (BIN)."},"expirationYear":{"type":"string","description":"Ano de validade (`YYYY`)."},"expirationMonth":{"type":"string","description":"Mês de validade (`MM`)."}},"additionalProperties":false},"example":{"id":"card_0a1b2c3d4e5f60718293","brand":"string","valid":true,"_links":{},"active":true,"primary":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"verified":true,"createdAt":"string","updatedAt":"string","associated":true,"holderName":"JOAO SILVA","lastDigits":"string","firstDigits":"string","expirationYear":"string","expirationMonth":"string"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createCard","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["customerId"],"properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_.:-]+$","maxLength":128,"minLength":8,"description":"Token de cartão de uso único emitido no navegador do comprador por `POST /v1/tokenization/tokens` (válido por uma hora)."},"primary":{"type":"boolean","description":"Tornar este o cartão principal do cliente."},"numbering":{"type":"string","description":"Número do cartão (PAN), só dígitos — espaços e traços são removidos. Tokenizado ao chegar, nunca guardado."},"customerId":{"type":"string","pattern":"^(cus)_.+$","description":"O cliente a quem o cartão pertence."},"holderName":{"type":"string","maxLength":255,"minLength":3,"description":"Nome impresso no cartão (só no cartão inline)."},"securityCode":{"type":"string","pattern":"^\\d{3,4}$","description":"Código de segurança do cartão (CVV/CVC), 3 ou 4 dígitos."},"expirationYear":{"allOf":[{"type":"integer","minimum":0},{"type":"integer","maximum":2100,"minimum":2026}],"description":"Ano de validade, 4 dígitos — 2 dígitos são aceitos (só no cartão inline)."},"expirationMonth":{"type":"integer","maximum":12,"minimum":1,"description":"Mês de validade, 1 a 12 (só no cartão inline)."}},"additionalProperties":false},"example":{"token":"id_0a1b2c3d4e5f60718293","primary":true,"numbering":"string","customerId":"cus_0a1b2c3d4e5f60718293","holderName":"JOAO SILVA","securityCode":"id_0a1b2c3d4e5f60718293","expirationYear":{},"expirationMonth":1}}},"required":true}}},"/v1/balance":{"get":{"tags":["Finance"],"summary":"Consulta o saldo da conta","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["availableBalance","pendingBalance","blockedBalance","refundedBalance","currency","warrantyBalance","updatedAt"],"properties":{"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"blockedBalance":{"type":"integer","description":"O que está retido (disputas, análise de fraude, retenção da Selectwin), em centavos."},"pendingBalance":{"type":"integer","description":"O que aguarda a data de liberação, em centavos."},"refundedBalance":{"type":"integer","description":"O que foi estornado a compradores, em centavos."},"warrantyBalance":{"type":"integer","description":"O que está retido como garantia (liberado depois do prazo de garantia de cada venda), em centavos."},"availableBalance":{"type":"integer","description":"O que você pode sacar agora, em centavos."}},"additionalProperties":false},"example":{"currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"updatedAt":"string","blockedBalance":5000,"pendingBalance":5000,"refundedBalance":5000,"warrantyBalance":5000,"availableBalance":5000}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getBalance"}},"/v1/coupons":{"get":{"tags":["Coupons"],"summary":"Lista os cupons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","name","code","type","value","enabled","minCartAmount","maxCartAmount","minCartItems","maxCartItems","usageLimit","usageQuantity","limitOneUsePerCustomer","isCumulative","initDate","endDate","allowedItemIds","allowedCustomerIds","scope","recurringCycles","redemptionsCount","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(dis|coup)_.+$","description":"Identificador público (dis_/coup_…)"},"code":{"type":"string","nullable":true,"description":"O código que o comprador digita."},"name":{"type":"string","nullable":true,"description":"Nome do cupom."},"type":{"enum":["flat","percentage"],"type":"string","description":"`flat` (um valor fixo) ou `percentage`."},"scope":{"enum":["firstCharge","recurring"],"type":"string","description":"Numa assinatura: `firstCharge` (só a primeira cobrança) ou `recurring` (todo ciclo, até `recurringCycles`)."},"value":{"type":"number","description":"Em `percentage`, o percentual (0–100); em `flat`, o valor em reais (decimal)."},"enabled":{"type":"boolean","description":"Se o cupom pode ser usado."},"endDate":{"type":"string","nullable":true,"description":"Até quando o cupom vale; `null` = sem fim."},"initDate":{"type":"string","nullable":true,"description":"A partir de quando o cupom vale; `null` = sem início."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"usageLimit":{"type":"integer","nullable":true,"description":"Número total de usos permitidos; `null` ou 0 = ilimitado."},"isCumulative":{"type":"boolean","description":"Se pode ser combinado com outros cupons."},"maxCartItems":{"type":"integer","nullable":true,"description":"Número máximo de itens; `null` = sem limite."},"minCartItems":{"type":"integer","nullable":true,"description":"Número mínimo de itens; `null` = sem mínimo."},"maxCartAmount":{"type":"integer","nullable":true,"description":"Valor máximo do carrinho (centavos); `null` = sem limite."},"minCartAmount":{"type":"integer","nullable":true,"description":"Valor mínimo do carrinho (centavos); `null` = sem mínimo."},"usageQuantity":{"type":"integer","nullable":true,"description":"Usos permitidos por cliente; `null` ou 0 = ilimitado."},"allowedItemIds":{"type":"array","items":{},"nullable":true,"description":"Ids das variantes a que o cupom se restringe; `null` = qualquer item."},"recurringCycles":{"type":"integer","nullable":true,"description":"Com `scope=recurring`: quantos ciclos ganham o desconto; `null` = todos os ciclos."},"redemptionsCount":{"type":"integer","description":"Quantas vezes o cupom foi usado (reservas e confirmados). Esgota quando `usageLimit > 0` e isto chega lá."},"allowedCustomerIds":{"type":"array","items":{},"nullable":true,"description":"Ids dos clientes a que o cupom se restringe; `null` = qualquer cliente."},"limitOneUsePerCustomer":{"type":"boolean","description":"Cada cliente pode usar o cupom uma vez."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."}},"additionalProperties":false},"example":{"data":[{"id":"dis_0a1b2c3d4e5f60718293","code":"string","name":"Acme Ltda","type":"flat","scope":"firstCharge","value":5000,"enabled":true,"endDate":"string","initDate":"string","createdAt":"string","updatedAt":"string","usageLimit":0,"isCumulative":true,"maxCartItems":0,"minCartItems":0,"maxCartAmount":5000,"minCartAmount":5000,"usageQuantity":0,"allowedItemIds":[],"recurringCycles":0,"redemptionsCount":0,"allowedCustomerIds":[],"limitOneUsePerCustomer":true}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"offset":0,"hasMore":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":50,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(dis|coup)_.+$"},"required":false,"description":"Só este cupom."},{"in":"query","name":"name","schema":{"type":"string","maxLength":80},"required":false,"description":"Cupons cujo nome contém este texto."},{"in":"query","name":"code","schema":{"type":"string","maxLength":50},"required":false,"description":"Só o cupom com este código."},{"in":"query","name":"type","schema":{"enum":["flat","percentage"],"type":"string"},"required":false,"description":"Só cupons deste tipo."},{"in":"query","name":"status","schema":{"enum":["active","inactive"],"type":"string"},"required":false,"description":"`active` (ligado) ou `inactive` (desligado)."},{"in":"query","name":"dir","schema":{"enum":["ascending","descending"],"type":"string"},"required":false,"description":"Ordem pela data de criação."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listCoupons"},"post":{"tags":["Coupons"],"summary":"Cria um cupom","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","code","type","value","enabled","minCartAmount","maxCartAmount","minCartItems","maxCartItems","usageLimit","usageQuantity","limitOneUsePerCustomer","isCumulative","initDate","endDate","allowedItemIds","allowedCustomerIds","scope","recurringCycles","redemptionsCount","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(dis|coup)_.+$","description":"Identificador público (dis_/coup_…)"},"code":{"type":"string","nullable":true,"description":"O código que o comprador digita."},"name":{"type":"string","nullable":true,"description":"Nome do cupom."},"type":{"enum":["flat","percentage"],"type":"string","description":"`flat` (um valor fixo) ou `percentage`."},"scope":{"enum":["firstCharge","recurring"],"type":"string","description":"Numa assinatura: `firstCharge` (só a primeira cobrança) ou `recurring` (todo ciclo, até `recurringCycles`)."},"value":{"type":"number","description":"Em `percentage`, o percentual (0–100); em `flat`, o valor em reais (decimal)."},"enabled":{"type":"boolean","description":"Se o cupom pode ser usado."},"endDate":{"type":"string","nullable":true,"description":"Até quando o cupom vale; `null` = sem fim."},"initDate":{"type":"string","nullable":true,"description":"A partir de quando o cupom vale; `null` = sem início."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"usageLimit":{"type":"integer","nullable":true,"description":"Número total de usos permitidos; `null` ou 0 = ilimitado."},"isCumulative":{"type":"boolean","description":"Se pode ser combinado com outros cupons."},"maxCartItems":{"type":"integer","nullable":true,"description":"Número máximo de itens; `null` = sem limite."},"minCartItems":{"type":"integer","nullable":true,"description":"Número mínimo de itens; `null` = sem mínimo."},"maxCartAmount":{"type":"integer","nullable":true,"description":"Valor máximo do carrinho (centavos); `null` = sem limite."},"minCartAmount":{"type":"integer","nullable":true,"description":"Valor mínimo do carrinho (centavos); `null` = sem mínimo."},"usageQuantity":{"type":"integer","nullable":true,"description":"Usos permitidos por cliente; `null` ou 0 = ilimitado."},"allowedItemIds":{"type":"array","items":{},"nullable":true,"description":"Ids das variantes a que o cupom se restringe; `null` = qualquer item."},"recurringCycles":{"type":"integer","nullable":true,"description":"Com `scope=recurring`: quantos ciclos ganham o desconto; `null` = todos os ciclos."},"redemptionsCount":{"type":"integer","description":"Quantas vezes o cupom foi usado (reservas e confirmados). Esgota quando `usageLimit > 0` e isto chega lá."},"allowedCustomerIds":{"type":"array","items":{},"nullable":true,"description":"Ids dos clientes a que o cupom se restringe; `null` = qualquer cliente."},"limitOneUsePerCustomer":{"type":"boolean","description":"Cada cliente pode usar o cupom uma vez."}},"additionalProperties":false},"example":{"id":"dis_0a1b2c3d4e5f60718293","code":"string","name":"Acme Ltda","type":"flat","scope":"firstCharge","value":5000,"enabled":true,"endDate":"string","initDate":"string","createdAt":"string","updatedAt":"string","usageLimit":0,"isCumulative":true,"maxCartItems":0,"minCartItems":0,"maxCartAmount":5000,"minCartAmount":5000,"usageQuantity":0,"allowedItemIds":[],"recurringCycles":0,"redemptionsCount":0,"allowedCustomerIds":[],"limitOneUsePerCustomer":true}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createCoupon","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","code","type","value","enabled"],"properties":{"code":{"type":"string","maxLength":50,"minLength":1,"description":"O código que o comprador digita."},"name":{"type":"string","maxLength":80,"minLength":1,"description":"Nome do cupom, para a sua referência."},"type":{"enum":["flat","percentage"],"type":"string","description":"`flat` (um valor fixo) ou `percentage`."},"scope":{"enum":["firstCharge","recurring"],"type":"string","description":"Numa assinatura: `firstCharge` desconta só a primeira cobrança (padrão); `recurring` é reaplicado a cada ciclo, até `recurringCycles`."},"value":{"type":"number","maximum":20000000,"minimum":0,"description":"Em `percentage`, o percentual (0–100); em `flat`, o valor em reais (decimal, ex.: `12.30`)."},"enabled":{"type":"boolean","description":"Se o cupom pode ser usado."},"endDate":{"type":"string","format":"date-time","description":"Até quando o cupom vale."},"initDate":{"type":"string","format":"date-time","description":"A partir de quando o cupom vale."},"usageLimit":{"type":"integer","minimum":0,"description":"Número total de usos permitidos (0 = ilimitado)."},"isCumulative":{"type":"boolean","description":"Se pode ser combinado com outros cupons."},"maxCartItems":{"type":"integer","maximum":100000,"minimum":0,"description":"Número máximo de itens no carrinho."},"minCartItems":{"type":"integer","maximum":100000,"minimum":0,"description":"Número mínimo de itens no carrinho."},"maxCartAmount":{"type":"integer","maximum":20000000,"minimum":0,"description":"Valor máximo do carrinho para o cupom valer (centavos)."},"minCartAmount":{"type":"integer","maximum":20000000,"minimum":0,"description":"Valor mínimo do carrinho para o cupom valer (centavos)."},"usageQuantity":{"type":"integer","minimum":0,"description":"Usos permitidos por cliente (0 = ilimitado)."},"allowedItemIds":{"type":"array","items":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"maxItems":1000,"description":"Só estas variantes ganham o desconto (ids de variante)."},"recurringCycles":{"type":"integer","maximum":999,"minimum":1,"nullable":true,"description":"Com `scope=recurring`: quantos ciclos ganham o desconto; `null` = todos os ciclos."},"allowedCustomerIds":{"type":"array","items":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"maxItems":1000,"description":"Só estes clientes podem usar o cupom."},"limitOneUsePerCustomer":{"type":"boolean","description":"Cada cliente pode usar o cupom uma vez."}},"additionalProperties":false},"example":{"code":"string","name":"Acme Ltda","type":"flat","scope":"firstCharge","value":5000,"enabled":true,"endDate":"2026-01-15T12:00:00.000Z","initDate":"2026-01-15T12:00:00.000Z","usageLimit":0,"isCumulative":true,"maxCartItems":0,"minCartItems":0,"maxCartAmount":5000,"minCartAmount":5000,"usageQuantity":0,"allowedItemIds":["var_0a1b2c3d4e5f60718293"],"recurringCycles":1,"allowedCustomerIds":["cus_0a1b2c3d4e5f60718293"],"limitOneUsePerCustomer":true}}},"required":true}}},"/v1/wallets":{"get":{"tags":["Wallets"],"summary":"Lista as carteiras de recebimento","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","name","holderName","bankName","bankCode","routingNumber","accountNumber","accountType","pixKey","primary","enabled","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(wall)_.+$","description":"Identificador público (wall_…)"},"name":{"type":"string","description":"Nome da conta bancária."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"pixKey":{"type":"string","nullable":true,"description":"Chave Pix do destino; `null` quando é conta bancária."},"enabled":{"type":"boolean","description":"Se a conta bancária pode receber saques (`false` depois de arquivada)."},"primary":{"type":"boolean","description":"Se é o destino principal dos saques."},"bankCode":{"type":"string","nullable":true,"description":"Código do banco."},"bankName":{"type":"string","nullable":true,"description":"Nome do banco."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"holderName":{"type":"string","description":"Nome do titular da conta — sempre o dono da conta (a sua empresa)."},"accountType":{"type":"string","description":"Tipo da conta (ex.: `checking`)."},"accountNumber":{"type":"string","nullable":true,"description":"Número da conta."},"routingNumber":{"type":"string","nullable":true,"description":"Agência."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"wall_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"pixKey":"string","enabled":true,"primary":true,"bankCode":"string","bankName":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","updatedAt":"string","holderName":"JOAO SILVA","accountType":"string","accountNumber":"string","routingNumber":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(wall)_.+$"},"required":false,"description":"Só esta conta bancária."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listWallets"},"post":{"tags":["Wallets"],"summary":"Cria uma carteira de recebimento","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","holderName","bankName","bankCode","routingNumber","accountNumber","accountType","pixKey","primary","enabled","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(wall)_.+$","description":"Identificador público (wall_…)"},"name":{"type":"string","description":"Nome da conta bancária."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"pixKey":{"type":"string","nullable":true,"description":"Chave Pix do destino; `null` quando é conta bancária."},"enabled":{"type":"boolean","description":"Se a conta bancária pode receber saques (`false` depois de arquivada)."},"primary":{"type":"boolean","description":"Se é o destino principal dos saques."},"bankCode":{"type":"string","nullable":true,"description":"Código do banco."},"bankName":{"type":"string","nullable":true,"description":"Nome do banco."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"holderName":{"type":"string","description":"Nome do titular da conta — sempre o dono da conta (a sua empresa)."},"accountType":{"type":"string","description":"Tipo da conta (ex.: `checking`)."},"accountNumber":{"type":"string","nullable":true,"description":"Número da conta."},"routingNumber":{"type":"string","nullable":true,"description":"Agência."}},"additionalProperties":false},"example":{"id":"wall_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"pixKey":"string","enabled":true,"primary":true,"bankCode":"string","bankName":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","updatedAt":"string","holderName":"JOAO SILVA","accountType":"string","accountNumber":"string","routingNumber":"string"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createWallet","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","bankCode","routingNumber","accountNumber"],"properties":{"name":{"type":"string","maxLength":50,"minLength":4,"description":"Nome da conta bancária, para a sua referência."},"primary":{"type":"boolean","description":"Tornar este o destino principal dos saques."},"bankCode":{"type":"string","maxLength":10,"minLength":1,"description":"Código do banco (ver `GET /v1/utils/types-of-bankaccounts`)."},"accountNumber":{"type":"string","maxLength":60,"minLength":1,"description":"Número da conta, com o dígito verificador."},"routingNumber":{"type":"string","maxLength":60,"minLength":1,"description":"Agência, com o dígito verificador se houver."}},"additionalProperties":false},"example":{"name":"Acme Ltda","primary":true,"bankCode":"string","accountNumber":"string","routingNumber":"string"}}},"required":true}}},"/v1/products":{"get":{"tags":["Products"],"summary":"Lista os produtos","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","name","slug","salesPage","description","language","enabled","salesQty","type","category","externalReference","warrantyDays","images","fiscal","createdAt","updatedAt","variants"],"properties":{"id":{"type":"string","pattern":"^(prd|pro)_.+$","description":"Identificador público (prd_/pro_…)"},"name":{"type":"string","description":"Nome do produto."},"slug":{"type":"string","nullable":true,"description":"Slug, derivado do nome."},"type":{"enum":["physical","digital","other"],"type":"string","description":"`physical`, `digital` ou `other`."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"Perfil fiscal do produto; `null` quando não há.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o produto está à venda."},"category":{"type":"string","description":"Categoria."},"language":{"type":"string","nullable":true,"description":"Idioma do produto."},"salesQty":{"type":"integer","nullable":true,"description":"Número de vendas do produto; `null` quando desconhecido."},"variants":{"type":"array","items":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"description":"As variantes do produto."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"salesPage":{"type":"string","nullable":true,"description":"URL da página de vendas; `null` quando não há."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"warrantyDays":{"type":"integer","description":"Garantia oferecida ao comprador, em dias."},"imageAssetIds":{"nullable":true,"description":"Ids dos arquivos de imagem; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do produto; `null` quando não há."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."}},"additionalProperties":false},"example":{"data":[{"id":"prd_0a1b2c3d4e5f60718293","name":"Acme Ltda","slug":"string","type":"physical","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"category":"string","language":"string","salesQty":0,"variants":[{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}],"createdAt":"string","salesPage":"string","updatedAt":"string","description":"string","warrantyDays":0,"externalReference":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"offset":0,"hasMore":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":false,"description":"Só este produto."},{"in":"query","name":"slug","schema":{"type":"string","maxLength":100,"minLength":1},"required":false,"description":"Só o produto com este slug."},{"in":"query","name":"name","schema":{"type":"string","maxLength":40,"minLength":1},"required":false,"description":"Produtos cujo nome contém este texto."},{"in":"query","name":"language","schema":{"type":"string","maxLength":10},"required":false,"description":"Só produtos neste idioma."},{"in":"query","name":"category","schema":{"type":"string","maxLength":100},"required":false,"description":"Só produtos desta categoria."},{"in":"query","name":"enabled","schema":{"type":"boolean"},"required":false,"description":"Só produtos à venda (`true`) ou não (`false`)."},{"in":"query","name":"externalreference","schema":{"type":"string","maxLength":255,"minLength":1},"required":false,"description":"Só o produto com esta referência externa sua."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listProducts"},"post":{"tags":["Products"],"summary":"Cria um produto","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","slug","salesPage","description","language","enabled","salesQty","type","category","externalReference","warrantyDays","images","fiscal","createdAt","updatedAt","variants"],"properties":{"id":{"type":"string","pattern":"^(prd|pro)_.+$","description":"Identificador público (prd_/pro_…)"},"name":{"type":"string","description":"Nome do produto."},"slug":{"type":"string","nullable":true,"description":"Slug, derivado do nome."},"type":{"enum":["physical","digital","other"],"type":"string","description":"`physical`, `digital` ou `other`."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"Perfil fiscal do produto; `null` quando não há.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o produto está à venda."},"category":{"type":"string","description":"Categoria."},"language":{"type":"string","nullable":true,"description":"Idioma do produto."},"salesQty":{"type":"integer","nullable":true,"description":"Número de vendas do produto; `null` quando desconhecido."},"variants":{"type":"array","items":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"description":"As variantes do produto."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"salesPage":{"type":"string","nullable":true,"description":"URL da página de vendas; `null` quando não há."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"warrantyDays":{"type":"integer","description":"Garantia oferecida ao comprador, em dias."},"imageAssetIds":{"nullable":true,"description":"Ids dos arquivos de imagem; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do produto; `null` quando não há."}},"additionalProperties":false},"example":{"id":"prd_0a1b2c3d4e5f60718293","name":"Acme Ltda","slug":"string","type":"physical","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"category":"string","language":"string","salesQty":0,"variants":[{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}],"createdAt":"string","salesPage":"string","updatedAt":"string","description":"string","warrantyDays":0,"externalReference":"string"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createProduct","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","type","category","warrantyDays","variants"],"properties":{"name":{"type":"string","maxLength":40,"minLength":1,"description":"Nome do produto (o `slug` é derivado dele)."},"type":{"enum":["physical","digital","other"],"type":"string","description":"`physical` (enviado), `digital` ou `other`."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","pattern":"^\\d{9}$","description":"Código NBS, 9 dígitos (serviço)."},"ncm":{"type":"string","pattern":"^\\d{8}$","description":"Código NCM, 8 dígitos (mercadoria)."},"cest":{"type":"string","pattern":"^\\d{7}$","description":"Código CEST, 7 dígitos (mercadoria com substituição tributária)."},"gtin":{"type":"string","pattern":"^(\\d{8}|\\d{12,14})$","description":"GTIN/EAN — 8, 12, 13 ou 14 dígitos."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` emite NFS-e, `goods` emite NF-e. Omitido: um produto `physical` é mercadoria, os outros são serviço."},"unit":{"type":"string","maxLength":6,"minLength":1,"description":"Unidade comercial (UN, KG, CX…)."},"origin":{"type":"integer","maximum":8,"minimum":0,"description":"Origem da mercadoria (tabela A do ICMS, 0 a 8; 0 = nacional)."},"cClassTrib":{"type":"string","pattern":"^\\d{6}$","description":"Classificação tributária do IBS/CBS (cClassTrib, 6 dígitos)."},"serviceCode":{"type":"string","pattern":"^\\d{1,2}\\.?\\d{2}$","description":"Item da lista de serviços da LC 116 (`01.07` ou `0107`)."},"cityServiceCode":{"type":"string","maxLength":20,"minLength":1,"description":"Código do serviço na sua prefeitura."}},"description":"Perfil fiscal do produto; `null` limpa.","additionalProperties":false},"images":{"type":"array","items":{"type":"string","format":"uri","description":"URL absoluta."},"maxItems":10,"description":"URLs de imagem. Para anexar um arquivo, envie-o antes (`POST /v1/assets/uploads` e depois a confirmação) e mande a URL do arquivo."},"enabled":{"type":"boolean","default":true,"description":"Se o produto está à venda."},"category":{"type":"string","maxLength":100,"minLength":1,"description":"Categoria, texto livre."},"language":{"type":"string","default":"pt-BR","maxLength":10,"description":"Idioma do produto (ex.: `pt-BR`)."},"variants":{"type":"array","items":{"type":"object","required":["name","pricing"],"properties":{"sku":{"type":"string","maxLength":50,"description":"O seu SKU."},"name":{"type":"string","maxLength":255,"minLength":1,"description":"Nome da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","pattern":"^\\d{9}$","description":"Código NBS, 9 dígitos (serviço)."},"ncm":{"type":"string","pattern":"^\\d{8}$","description":"Código NCM, 8 dígitos (mercadoria)."},"cest":{"type":"string","pattern":"^\\d{7}$","description":"Código CEST, 7 dígitos (mercadoria com substituição tributária)."},"gtin":{"type":"string","pattern":"^(\\d{8}|\\d{12,14})$","description":"GTIN/EAN — 8, 12, 13 ou 14 dígitos."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` emite NFS-e, `goods` emite NF-e. Omitido: um produto `physical` é mercadoria, os outros são serviço."},"unit":{"type":"string","maxLength":6,"minLength":1,"description":"Unidade comercial (UN, KG, CX…)."},"origin":{"type":"integer","maximum":8,"minimum":0,"description":"Origem da mercadoria (tabela A do ICMS, 0 a 8; 0 = nacional)."},"cClassTrib":{"type":"string","pattern":"^\\d{6}$","description":"Classificação tributária do IBS/CBS (cClassTrib, 6 dígitos)."},"serviceCode":{"type":"string","pattern":"^\\d{1,2}\\.?\\d{2}$","description":"Item da lista de serviços da LC 116 (`01.07` ou `0107`)."},"cityServiceCode":{"type":"string","maxLength":20,"minLength":1,"description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` limpa.","additionalProperties":false},"images":{"type":"array","items":{"type":"string","format":"uri","description":"URL absoluta."},"maxItems":1,"description":"URLs de imagem. Para anexar um arquivo, envie-o antes (`POST /v1/assets/uploads` e depois a confirmação) e mande a URL do arquivo."},"enabled":{"type":"boolean","default":true,"description":"Se a variante está à venda."},"pricing":{"type":"object","properties":{"type":{"enum":["oneTime","recurring"],"type":"string","default":"oneTime","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"type":"array","items":{"type":"object","required":["unitPrice"],"properties":{"upTo":{"type":"integer","maximum":1000000000,"minimum":1,"nullable":true,"description":"Limite superior da faixa (unidades); `null` = sem limite (a última faixa)."},"flatPrice":{"type":"integer","maximum":200000000,"minimum":0,"nullable":true,"description":"Valor fixo somado quando a faixa é atingida, em centavos."},"unitPrice":{"type":"integer","maximum":200000000,"minimum":0,"description":"Preço unitário dentro da faixa, em centavos."}},"additionalProperties":false},"maxItems":50,"description":"As faixas de preço (`schema=tiered`), em ordem crescente de `upTo`."},"cycles":{"type":"integer","maximum":999,"minimum":1,"nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","default":"unit","description":"Como o preço é calculado: `unit` (preço × quantidade), `tiered` (por faixas de quantidade) ou `package` (por bloco de unidades)."},"currency":{"type":"string","default":"BRL","description":"Código de moeda ISO 4217"},"oldPrice":{"type":"integer","maximum":200000000,"minimum":1,"description":"O preço antes de um desconto, em centavos — mostrado riscado."},"daysTrial":{"type":"integer","maximum":365,"minimum":1,"description":"Duração do período de teste de um plano recorrente, em dias."},"tiersMode":{"enum":["graduated","volume"],"type":"string","description":"`graduated`: cada faixa precifica as próprias unidades; `volume`: a faixa atingida precifica todas as unidades."},"unitPrice":{"type":"integer","maximum":200000000,"minimum":1,"description":"Preço unitário, em centavos (mínimo 500 em `unit`; não usado em `tiered`)."},"usageType":{"enum":["licensed","metered"],"type":"string","default":"licensed","description":"`licensed` (quantidade fixa) ou `metered` (cobrado pelo uso que você reporta)."},"billingType":{"enum":["prepaid","postpaid","exactday"],"type":"string","description":"Quando um ciclo é cobrado: `prepaid` (no início), `postpaid` (no fim) ou `exactday` (em `billingExactDay`)."},"costPerItem":{"type":"integer","maximum":200000000,"minimum":0,"description":"O seu custo por unidade, em centavos (para os seus relatórios de margem)."},"trialInterval":{"enum":["day","week","month","year"],"type":"string","description":"Unidade da duração do teste."},"meterEventName":{"type":"string","maxLength":64,"minLength":1,"description":"Nome do medidor de uso que você reporta (só `metered`)."},"billingExactDay":{"type":"integer","maximum":31,"minimum":1,"description":"Dia do mês em que o ciclo é cobrado (`billingType=exactday`)."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: cobrar o frete cotado no checkout em CADA renovação (padrão `true`)."},"billingFrequency":{"enum":["daily","weekly","monthly","yearly"],"type":"string","description":"Unidade do intervalo de cobrança."},"usageAggregation":{"enum":["sum","max","lastDuringPeriod","lastEver"],"type":"string","description":"Como os registros de uso de um ciclo são agregados: `sum`, `max`, `lastDuringPeriod` ou `lastEver`."},"transformQuantity":{"type":"object","required":["divideBy"],"properties":{"round":{"enum":["up","down"],"type":"string","default":"up","description":"Como um bloco parcial é arredondado."},"divideBy":{"type":"integer","maximum":1000000000,"minimum":1,"description":"Unidades por bloco."}},"description":"Em `schema=package`: quantas unidades formam um bloco, e como um bloco parcial é arredondado.","additionalProperties":false},"trialIntervalCount":{"type":"integer","maximum":365,"minimum":1,"description":"Duração do teste, em unidades de `trialInterval`."},"billingFrequencyCount":{"type":"integer","maximum":999,"minimum":1,"description":"Quantas unidades de `billingFrequency` por ciclo."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: estender o desconto do meio de pagamento do checkout às renovações cobradas pelo mesmo meio (padrão `false`)."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"attributes":{"type":"object","description":"Atributos livres da variante (tamanho, cor…).","additionalProperties":{}},"description":{"type":"string","maxLength":255,"description":"Descrição."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador da variante."}},"additionalProperties":false},"maxItems":100,"minItems":1,"description":"As variantes (1 a 100). A primeira é a principal."},"salesPage":{"type":"string","maxLength":255,"description":"URL da página de vendas."},"description":{"type":"string","maxLength":400,"description":"Descrição."},"warrantyDays":{"type":"integer","maximum":3650,"minimum":7,"description":"Garantia oferecida ao comprador, em dias (7 a 3650)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador do produto."}},"additionalProperties":false},"example":{"name":"Acme Ltda","type":"physical","fiscal":{"nbs":"id_0a1b2c3d4e5f60718293","ncm":"id_0a1b2c3d4e5f60718293","cest":"id_0a1b2c3d4e5f60718293","gtin":"id_0a1b2c3d4e5f60718293","kind":"service","unit":"string","origin":0,"cClassTrib":"id_0a1b2c3d4e5f60718293","serviceCode":"id_0a1b2c3d4e5f60718293","cityServiceCode":"string"},"images":["https://example.com"],"enabled":true,"category":"string","language":"pt-BR","variants":[{"sku":"string","name":"Acme Ltda","fiscal":{"nbs":"id_0a1b2c3d4e5f60718293","ncm":"id_0a1b2c3d4e5f60718293","cest":"id_0a1b2c3d4e5f60718293","gtin":"id_0a1b2c3d4e5f60718293","kind":"service","unit":"string","origin":0,"cClassTrib":"id_0a1b2c3d4e5f60718293","serviceCode":"id_0a1b2c3d4e5f60718293","cityServiceCode":"string"},"images":["https://example.com"],"enabled":true,"pricing":{"type":"oneTime","tiers":[{"upTo":1,"flatPrice":5000,"unitPrice":5000}],"cycles":1,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":1,"tiersMode":"graduated","unitPrice":5000,"usageType":"licensed","billingType":"prepaid","costPerItem":0,"trialInterval":"day","meterEventName":"string","billingExactDay":1,"renewalShipping":true,"billingFrequency":"daily","usageAggregation":"sum","transformQuantity":{"round":"up","divideBy":1},"trialIntervalCount":1,"billingFrequencyCount":1,"renewalMethodDiscount":true},"metadata":{},"attributes":{},"description":"string","externalReference":"string"}],"salesPage":"string","description":"string","warrantyDays":7,"externalReference":"string"}}},"required":true}}},"/v1/variants":{"get":{"tags":["Products - Variants"],"summary":"Lista todas as variantes de produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false}},"example":[{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}]}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":2000,"maximum":2000,"minimum":1},"required":false,"description":"Número máximo de variantes devolvidas (sem paginação)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"enum":["ascending","descending"],"type":"string","default":"ascending"},"required":false,"description":"Ordem pela data de criação."},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(var|prv)_.+$"},"required":false,"description":"Só esta variante."},{"in":"query","name":"sku","schema":{"type":"string","maxLength":50,"minLength":1},"required":false,"description":"Só a variante com este SKU."},{"in":"query","name":"currency","schema":{"type":"string"},"required":false,"description":"Código de moeda ISO 4217"},{"in":"query","name":"enabled","schema":{"type":"boolean"},"required":false,"description":"Só variantes à venda (`true`) ou não (`false`)."},{"in":"query","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":false,"description":"Só as variantes deste produto."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listAllVariants"}},"/v1/webhooks":{"get":{"tags":["Webhooks"],"summary":"Lista os endpoints de webhook","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","name","endpoint","enabled","disabledReason","disabledAt","disabledCanceledDispatches","events","forceActive","shotsQty","failedShotsQty","lastDeliveryAt","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(wbe|wbh)_.+$","description":"Identificador público (wbe_/wbh_…)"},"name":{"type":"string","description":"Nome do endpoint."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"events":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Os tipos de evento entregues; `null` com `forceActive`."},"enabled":{"type":"boolean","description":"Se o endpoint recebe entregas."},"endpoint":{"type":"string","description":"A URL que recebe os eventos."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shotsQty":{"type":"integer","description":"Total de entregas tentadas."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"disabledAt":{"type":"string","nullable":true,"description":"Quando foi desativado; `null` enquanto ativo."},"forceActive":{"type":"boolean","description":"Se todos os tipos de evento são entregues."},"disabledReason":{"enum":["seller","circuitBreaker","staff"],"type":"string","nullable":true,"description":"Quem desativou: `seller` (você), `circuitBreaker` (a proteção automática, depois de falhas seguidas) ou `staff`; `null` enquanto ativo."},"failedShotsQty":{"type":"integer","description":"Entregas que falharam."},"lastDeliveryAt":{"type":"string","nullable":true,"description":"Quando a última entrega foi feita; `null` quando não houve."},"disabledCanceledDispatches":{"type":"integer","nullable":true,"description":"Quantas entregas pendentes a desativação cancelou; `null` quando você mesmo desativou."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"wbe_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"events":["string"],"enabled":true,"endpoint":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shotsQty":0,"createdAt":"string","updatedAt":"string","disabledAt":"string","forceActive":true,"disabledReason":"seller","failedShotsQty":0,"lastDeliveryAt":"string","disabledCanceledDispatches":0}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"name","schema":{"type":"string","maxLength":100},"required":false,"description":"Endpoints cujo nome contém este texto."},{"in":"query","name":"endpoint","schema":{"type":"string","maxLength":255},"required":false,"description":"Só o endpoint com esta URL exata."},{"in":"query","name":"status","schema":{"type":"string","maxLength":50},"required":false,"description":"`active` ou `inactive`."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listWebhookEndpoints"},"post":{"tags":["Webhooks"],"summary":"Cadastra um endpoint de webhook","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","endpoint","enabled","disabledReason","disabledAt","disabledCanceledDispatches","events","forceActive","shotsQty","failedShotsQty","lastDeliveryAt","metadata","createdAt","updatedAt","secret"],"properties":{"id":{"type":"string","pattern":"^(wbe|wbh)_.+$","description":"Identificador público (wbe_/wbh_…)"},"name":{"type":"string","description":"Nome do endpoint."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"events":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Os tipos de evento entregues; `null` com `forceActive`."},"secret":{"type":"string","description":"O segredo de assinatura do endpoint — mostrado UMA vez, aqui. Use-o para verificar a assinatura de cada entrega."},"enabled":{"type":"boolean","description":"Se o endpoint recebe entregas."},"endpoint":{"type":"string","description":"A URL que recebe os eventos."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shotsQty":{"type":"integer","description":"Total de entregas tentadas."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"disabledAt":{"type":"string","nullable":true,"description":"Quando foi desativado; `null` enquanto ativo."},"forceActive":{"type":"boolean","description":"Se todos os tipos de evento são entregues."},"disabledReason":{"enum":["seller","circuitBreaker","staff"],"type":"string","nullable":true,"description":"Quem desativou: `seller` (você), `circuitBreaker` (a proteção automática, depois de falhas seguidas) ou `staff`; `null` enquanto ativo."},"failedShotsQty":{"type":"integer","description":"Entregas que falharam."},"lastDeliveryAt":{"type":"string","nullable":true,"description":"Quando a última entrega foi feita; `null` quando não houve."},"disabledCanceledDispatches":{"type":"integer","nullable":true,"description":"Quantas entregas pendentes a desativação cancelou; `null` quando você mesmo desativou."}},"additionalProperties":false},"example":{"id":"wbe_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"events":["string"],"secret":"string","enabled":true,"endpoint":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shotsQty":0,"createdAt":"string","updatedAt":"string","disabledAt":"string","forceActive":true,"disabledReason":"seller","failedShotsQty":0,"lastDeliveryAt":"string","disabledCanceledDispatches":0}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createWebhookEndpoint","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","endpoint"],"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"description":"Nome do endpoint, para a sua referência."},"events":{"type":"array","items":{"enum":["transaction.created","transaction.pending","transaction.failed","transaction.approved","transaction.canceled","transaction.chargeback","transaction.refunded","transaction.fraud-review","transaction.pre-authorized","transaction.unauthorized","transaction.awaiting","transaction.dispute","customer.created","customer.updated","customer.deleted","customer.address.created","customer.address.updated","customer.address.deleted","card.created","card.updated","card.deleted","card.expired","subscription.created","subscription.pending","subscription.active","subscription.canceled","subscription.pastdue","subscription.unpaid","subscription.trialing","subscription.paused","subscription.updated","receivable.created","receivable.pending","receivable.paid","receivable.canceled","receivable.chargeback","receivable.refunded","receivable.dispute","receivable.scheduled","receivable.fraud-hold","wallet.created","wallet.deleted","wallet.pending","wallet.disabled","wallet.enabled","seller.created","seller.updated","seller.analyzing","seller.approved","seller.refused","seller.blocked","seller.disabled","seller.reinstated","seller.kycRequired","withdrawal.created","withdrawal.pending","withdrawal.confirmed","withdrawal.canceled","withdrawal.refused","withdrawal.processing","withdrawal.analysis","webhook.created","webhook.updated","webhook.deleted","webhook.disabled","checkout.session.created","checkout.session.updated","checkout.session.abandoned","checkout.session.recovered","checkout.session.reactivated","checkout.session.expired","checkout.session.completed","product.created","product.updated","product.deleted","variant.created","variant.updated","variant.deleted","coupon.created","coupon.updated","coupon.disabled","anticipation.requested","anticipation.executed","anticipation.rejected","anticipation.canceled","webhook.ping"],"type":"string"},"maxItems":200,"description":"Os tipos de evento a entregar (ver `GET /v1/utils/types-of-webhooks`). Obrigatório sem `forceActive`."},"enabled":{"type":"boolean","description":"Se o endpoint recebe entregas."},"endpoint":{"type":"string","format":"uri","description":"A URL `https://` que recebe os eventos."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"forceActive":{"type":"boolean","description":"Entregar TODOS os tipos de evento, os de agora e os futuros, no lugar da lista `events`."},"headerAuthorization":{"type":"string","maxLength":1000,"description":"Valor enviado no cabeçalho `Authorization` de cada entrega."},"headerAuthorizationType":{"type":"string","maxLength":50,"description":"Esquema do cabeçalho `Authorization` (ex.: `Bearer`)."}},"additionalProperties":false},"example":{"name":"Acme Ltda","events":["transaction.created"],"enabled":true,"endpoint":"https://example.com","metadata":{},"forceActive":true,"headerAuthorization":"string","headerAuthorizationType":"string"}}},"required":true}}},"/v1/addresses":{"get":{"tags":["Addresses"],"summary":"Lista os endereços","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","ownerType","ownerId","street","number","complement","district","city","state","country","postcode","latitude","longitude","primary","line","line1","line2","line3","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$","description":"Identificador público (addr_/cad_/cadm_/add_…)"},"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"ownerId":{"type":"string","description":"Id público do dono."},"primary":{"type":"boolean","description":"Se é o endereço principal do dono."},"district":{"type":"string","nullable":true,"description":"Bairro."},"latitude":{"type":"string","nullable":true,"description":"Latitude, em graus decimais como texto; `null` quando desconhecida."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"postcode":{"type":"string","description":"CEP, só dígitos."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"longitude":{"type":"string","nullable":true,"description":"Longitude, em graus decimais como texto; `null` quando desconhecida."},"ownerType":{"enum":["vendor","customer","company","user"],"type":"string","description":"Quem é dono do endereço: um `customer`, a própria `company`, um `user` ou um `vendor`."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"addr_0a1b2c3d4e5f60718293","city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","_links":{},"number":"1000","street":"string","country":"string","ownerId":"string","primary":true,"district":"string","latitude":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"postcode":"string","createdAt":"string","longitude":"string","ownerType":"vendor","updatedAt":"string","complement":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"enum":["ascending","descending"],"type":"string","default":"ascending"},"required":false,"description":"Ordem pela data de criação."},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"customerid","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":false,"description":"Só os endereços deste cliente."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listAddresses"},"post":{"tags":["Addresses"],"summary":"Cria um endereço","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","ownerType","ownerId","street","number","complement","district","city","state","country","postcode","latitude","longitude","primary","line","line1","line2","line3","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$","description":"Identificador público (addr_/cad_/cadm_/add_…)"},"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"ownerId":{"type":"string","description":"Id público do dono."},"primary":{"type":"boolean","description":"Se é o endereço principal do dono."},"district":{"type":"string","nullable":true,"description":"Bairro."},"latitude":{"type":"string","nullable":true,"description":"Latitude, em graus decimais como texto; `null` quando desconhecida."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"postcode":{"type":"string","description":"CEP, só dígitos."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"longitude":{"type":"string","nullable":true,"description":"Longitude, em graus decimais como texto; `null` quando desconhecida."},"ownerType":{"enum":["vendor","customer","company","user"],"type":"string","description":"Quem é dono do endereço: um `customer`, a própria `company`, um `user` ou um `vendor`."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."}},"additionalProperties":false},"example":{"id":"addr_0a1b2c3d4e5f60718293","city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","_links":{},"number":"1000","street":"string","country":"string","ownerId":"string","primary":true,"district":"string","latitude":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"postcode":"string","createdAt":"string","longitude":"string","ownerType":"vendor","updatedAt":"string","complement":"string"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createAddress","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["country","postcode","customerId"],"properties":{"city":{"type":"string","maxLength":100,"description":"Cidade."},"state":{"type":"string","maxLength":100,"description":"Estado (sigla de duas letras, ex.: `SP`)."},"number":{"type":"string","maxLength":100,"description":"Número."},"street":{"type":"string","maxLength":255,"description":"Logradouro."},"country":{"type":"string","maxLength":3,"minLength":2,"description":"Código do país (ISO 3166-1, ex.: `BR`)."},"primary":{"type":"boolean","description":"Tornar este o endereço principal do cliente."},"district":{"type":"string","maxLength":100,"description":"Bairro."},"latitude":{"type":"string","maxLength":16,"description":"Latitude, em graus decimais como texto."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"postcode":{"type":"string","pattern":"^\\d{5}-?\\d{3}$","description":"CEP, 8 dígitos — o hífen é aceito."},"longitude":{"type":"string","maxLength":16,"description":"Longitude, em graus decimais como texto."},"complement":{"type":"string","maxLength":255,"description":"Complemento (apartamento, sala, bloco…)."},"customerId":{"type":"string","pattern":"^(cus)_.+$","description":"O cliente dono do endereço."}},"additionalProperties":false},"example":{"city":"string","state":"string","number":"1000","street":"string","country":"string","primary":true,"district":"string","latitude":"string","metadata":{},"postcode":"id_0a1b2c3d4e5f60718293","longitude":"string","complement":"string","customerId":"cus_0a1b2c3d4e5f60718293"}}},"required":true}}},"/v1/customers":{"get":{"tags":["Customers"],"summary":"Lista os clientes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","firstName","lastName","email","document","telephone","birthdate","gender","available","delinquent","externalReference","additionalEmails","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail; `null` quando não há."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"gender":{"type":"string","nullable":true,"description":"Gênero (`male`, `female`, `other`); `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","nullable":true,"description":"Tipo do documento; `null` quando não há."},"number":{"type":"string","nullable":true,"description":"Número do documento (dígitos em CPF/CNPJ); `null` quando não há."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","description":"Sobrenome."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails do comprador; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador deste cliente; `null` quando não há."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"cus_0a1b2c3d4e5f60718293","email":"buyer@example.com","_links":{},"gender":"string","document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":false,"description":"Só este cliente."},{"in":"query","name":"email","schema":{"type":"string","format":"email"},"required":false,"description":"Só o cliente com este e-mail."},{"in":"query","name":"name","schema":{"type":"string","minLength":1},"required":false,"description":"Clientes cujo nome contém este texto."},{"in":"query","name":"telephoneline","schema":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":7},"required":false,"description":"Só o cliente com esta linha de telefone (número inteiro, só dígitos)."},{"in":"query","name":"document","schema":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":11},"required":false,"description":"Só o cliente com este documento (dígitos do CPF/CNPJ)."},{"in":"query","name":"externalreference","schema":{"type":"string","maxLength":255,"minLength":1},"required":false,"description":"Só o cliente com esta referência externa sua."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listCustomers"},"post":{"tags":["Customers"],"summary":"Cria um cliente","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","firstName","lastName","email","document","telephone","birthdate","gender","available","delinquent","externalReference","additionalEmails","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail; `null` quando não há."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"gender":{"type":"string","nullable":true,"description":"Gênero (`male`, `female`, `other`); `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","nullable":true,"description":"Tipo do documento; `null` quando não há."},"number":{"type":"string","nullable":true,"description":"Número do documento (dígitos em CPF/CNPJ); `null` quando não há."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","description":"Sobrenome."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails do comprador; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador deste cliente; `null` quando não há."}},"additionalProperties":false},"example":{"id":"cus_0a1b2c3d4e5f60718293","email":"buyer@example.com","_links":{},"gender":"string","document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["firstName","lastName","email"],"properties":{"email":{"type":"string","format":"email","description":"Endereço de e-mail do comprador."},"gender":{"enum":["male","female","other"],"type":"string","description":"Gênero: `male`, `female` ou `other`."},"document":{"type":"object","properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","description":"Tipo do documento: `cpf`, `cnpj` ou `passport`."},"number":{"type":"string","maxLength":20,"minLength":5,"description":"Número do documento: dígitos do CPF ou CNPJ, ou o número do passaporte."}},"description":"Documento do comprador (CPF, CNPJ ou passaporte). As duas partes são opcionais: pode vir depois, ou com a cobrança.","additionalProperties":false},"lastName":{"type":"string","maxLength":255,"minLength":1,"description":"Sobrenome."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"birthdate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data de nascimento, `YYYY-MM-DD`."},"firstName":{"type":"string","maxLength":255,"minLength":2,"description":"Nome."},"telephone":{"type":"object","properties":{"line":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":7,"description":"O número inteiro com código do país e DDD (ex.: `5511987654321`). O único telefone que chega ao provedor de pagamento."},"number":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":6,"description":"Número local, só dígitos."},"areaCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"DDD (ex.: `11`)."},"countryCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"Código do país (ex.: `55`)."}},"description":"Telefone do comprador, em partes. Cada parte é opcional; `line` é o número inteiro.","additionalProperties":false},"additionalEmails":{"type":"array","items":{"type":"string","format":"email","description":"Endereço de e-mail (normalizado em minúsculas)."},"maxItems":20,"description":"Outros e-mails do comprador (até 20)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador deste cliente (texto livre, devolvido como veio)."}},"additionalProperties":false},"example":{"email":"buyer@example.com","gender":"male","document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","metadata":{},"birthdate":"1990-05-20","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"additionalEmails":["buyer@example.com"],"externalReference":"string"}}},"required":true}}},"/v1/marketplace":{"get":{"tags":["Marketplace"],"summary":"Consulta o status de marketplace da sua conta","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["enabled","subAccountCount","subAccountLimit","isSubAccount","approvalStatus"],"properties":{"enabled":{"type":"boolean","description":"Se a função de marketplace está ligada na sua conta."},"isSubAccount":{"type":"boolean","description":"`true` quando a sua conta é ela mesma uma sub-conta de uma plataforma."},"approvalStatus":{"enum":["pending","approved","rejected"],"type":"string","nullable":true,"description":"A aprovação de compliance da sua plataforma: criar sub-contas exige `approved`; `null` enquanto o marketplace nunca foi ligado."},"subAccountCount":{"type":"integer","description":"Quantas sub-contas você tem."},"subAccountLimit":{"type":"integer","description":"Quantas sub-contas você pode ter."}},"additionalProperties":false},"example":{"enabled":true,"isSubAccount":true,"approvalStatus":"pending","subAccountCount":0,"subAccountLimit":0}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"getMarketplaceStatus"}},"/v1/receivables":{"get":{"tags":["Receivables"],"summary":"Lista os recebíveis","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","transactionId","recipient","split","status","amount","grossAmount","antecipationFee","installmentNumber","currency","description","authorizationCode","liable","released","expectedOn","paidAt","refundedAt","canceledAt","chargedBackAt","disputedAt","fraudChekingAt","chargeProcessingFee","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(rec)_.+$","description":"Identificador público (rec_…)"},"split":{"type":"string","nullable":true,"description":"O split de que vem; `null` quando é do próprio vendedor."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","description":"Valor líquido, em centavos (o que chega ao saldo)."},"liable":{"type":"boolean","nullable":true,"description":"Se o recebedor arca com os chargebacks dele."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi liberado para o saldo; `null` até lá."},"status":{"type":"string","description":"Status: `pending` (aguardando a data de liberação), `paid` (liberado para o saldo), `canceled`, `refunded`, `chargeback`…"},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"released":{"type":"boolean","nullable":true,"description":"Se foi liberado para o saldo disponível."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que o recebe (`bus_…`)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando foi cancelado; `null` quando não foi."},"disputedAt":{"type":"string","nullable":true,"description":"Quando entrou em disputa; `null` quando não entrou."},"expectedOn":{"type":"string","nullable":true,"description":"Data prevista de liberação."},"refundedAt":{"type":"string","nullable":true,"description":"Quando foi estornado; `null` quando não foi."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"grossAmount":{"type":"integer","description":"Valor bruto, em centavos (antes das taxas)."},"chargedBackAt":{"type":"string","nullable":true,"description":"Quando sofreu chargeback; `null` quando não sofreu."},"transactionId":{"type":"string","pattern":"^(tra|trx)_.+$","nullable":true,"description":"A cobrança de que o recebível vem."},"fraudChekingAt":{"type":"string","nullable":true,"description":"Quando foi retido para análise de fraude; `null` quando não foi. O nome mantém a grafia histórica."},"antecipationFee":{"type":"number","nullable":true,"description":"Taxa cobrada para antecipá-lo, em centavos; `null` quando não foi antecipado. O nome mantém a grafia histórica."},"authorizationCode":{"type":"string","nullable":true,"description":"Código de autorização da cobrança; `null` em Pix/boleto."},"installmentNumber":{"type":"integer","nullable":true,"description":"Parcela da cobrança a que pertence; `null` em pagamento à vista."},"chargeProcessingFee":{"type":"boolean","nullable":true,"description":"Se o recebedor paga a taxa de processamento dele."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"rec_0a1b2c3d4e5f60718293","split":"string","_links":{},"amount":5000,"liable":true,"paidAt":"string","status":"string","currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"released":true,"createdAt":"string","recipient":"string","updatedAt":"string","canceledAt":"string","disputedAt":"string","expectedOn":"string","refundedAt":"string","description":"string","grossAmount":5000,"chargedBackAt":"string","transactionId":"tra_0a1b2c3d4e5f60718293","fraudChekingAt":"string","antecipationFee":5000,"authorizationCode":"string","installmentNumber":0,"chargeProcessingFee":true}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"status","schema":{"type":"string","maxLength":50},"required":false,"description":"Só recebíveis com este status (ex.: `pending`, `paid`, `canceled`)."},{"in":"query","name":"transactionId","schema":{"type":"string","pattern":"^(tra|trx)_.+$"},"required":false,"description":"Só os recebíveis desta cobrança."},{"in":"query","name":"released","schema":{"enum":["yes","no"],"type":"string"},"required":false,"description":"`yes`: só recebíveis liberados; `no`: só os ainda pendentes."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(rec)_.+$"},"required":false,"description":"Só este recebível."},{"in":"query","name":"expectedOnrangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Limite inferior (inclusivo, instante ISO) de `expectedOnAt`"},{"in":"query","name":"expectedOnrangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Limite superior (inclusivo, instante ISO) de `expectedOnAt`"},{"in":"query","name":"orderBy","schema":{"enum":["createdAt","expectedOn"],"type":"string"},"required":false,"description":"A ordem da lista: `createdAt` (padrão) ou `expectedOn`"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listReceivables"}},"/v1/withdrawals":{"get":{"tags":["Withdrawals"],"summary":"Lista os saques","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","walletId","amount","fee","status","method","currency","transferCode","paidAt","approvedAt","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(cash)_.+$","description":"Identificador público (cash_…)"},"fee":{"type":"integer","description":"Taxa do saque, em centavos."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","description":"Valor sacado, em centavos."},"method":{"type":"string","nullable":true,"description":"Como é pago (ex.: `pix`, `ted`)."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi pago; `null` até lá."},"status":{"type":"string","description":"Status: `pending`, `processing`, `paid`, `canceled`, `failed`…"},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"walletId":{"type":"string","pattern":"^(wall)_.+$","nullable":true,"description":"A conta bancária em que é pago; `null` quando pago na sua chave Pix."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"approvedAt":{"type":"string","nullable":true,"description":"Quando foi aprovado para pagamento; `null` até lá."},"transferCode":{"type":"string","nullable":true,"description":"Identificador da transferência no banco; `null` até ser pago."},"receivingBankAccount":{"type":"object","nullable":true,"required":["holderName","document","bankCode","bankName","routingNumber","accountNumber","type","pixKey"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo da conta."},"pixKey":{"type":"string","nullable":true,"description":"Chave Pix, quando pago a uma."},"bankCode":{"type":"string","nullable":true,"description":"Código do banco."},"bankName":{"type":"string","nullable":true,"description":"Nome do banco."},"document":{"type":"string","nullable":true,"description":"CPF/CNPJ do titular."},"holderName":{"type":"string","nullable":true,"description":"Nome do titular da conta."},"accountNumber":{"type":"string","nullable":true,"description":"Número da conta."},"routingNumber":{"type":"string","nullable":true,"description":"Agência."}},"description":"Retrato da conta bancária de destino, tirado quando o saque foi pedido.","additionalProperties":false}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"cash_0a1b2c3d4e5f60718293","fee":5000,"_links":{},"amount":5000,"method":"string","paidAt":"string","status":"string","currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"walletId":"wall_0a1b2c3d4e5f60718293","createdAt":"string","updatedAt":"string","approvedAt":"string","transferCode":"string","receivingBankAccount":{"type":"string","pixKey":"string","bankCode":"string","bankName":"string","document":"string","holderName":"JOAO SILVA","accountNumber":"string","routingNumber":"string"}}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(cash)_.+$"},"required":false,"description":"Só este saque."},{"in":"query","name":"status","schema":{"type":"string","maxLength":50},"required":false,"description":"Só saques com este status (ex.: `pending`, `paid`, `canceled`)."},{"in":"query","name":"method","schema":{"type":"string","maxLength":50},"required":false,"description":"Só saques pagos por este meio (ex.: `pix`)."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listWithdrawals"},"post":{"tags":["Withdrawals"],"summary":"Cria um saque","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","walletId","amount","fee","status","method","currency","transferCode","paidAt","approvedAt","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(cash)_.+$","description":"Identificador público (cash_…)"},"fee":{"type":"integer","description":"Taxa do saque, em centavos."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","description":"Valor sacado, em centavos."},"method":{"type":"string","nullable":true,"description":"Como é pago (ex.: `pix`, `ted`)."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi pago; `null` até lá."},"status":{"type":"string","description":"Status: `pending`, `processing`, `paid`, `canceled`, `failed`…"},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"walletId":{"type":"string","pattern":"^(wall)_.+$","nullable":true,"description":"A conta bancária em que é pago; `null` quando pago na sua chave Pix."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"approvedAt":{"type":"string","nullable":true,"description":"Quando foi aprovado para pagamento; `null` até lá."},"transferCode":{"type":"string","nullable":true,"description":"Identificador da transferência no banco; `null` até ser pago."},"receivingBankAccount":{"type":"object","nullable":true,"required":["holderName","document","bankCode","bankName","routingNumber","accountNumber","type","pixKey"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo da conta."},"pixKey":{"type":"string","nullable":true,"description":"Chave Pix, quando pago a uma."},"bankCode":{"type":"string","nullable":true,"description":"Código do banco."},"bankName":{"type":"string","nullable":true,"description":"Nome do banco."},"document":{"type":"string","nullable":true,"description":"CPF/CNPJ do titular."},"holderName":{"type":"string","nullable":true,"description":"Nome do titular da conta."},"accountNumber":{"type":"string","nullable":true,"description":"Número da conta."},"routingNumber":{"type":"string","nullable":true,"description":"Agência."}},"description":"Retrato da conta bancária de destino, tirado quando o saque foi pedido.","additionalProperties":false}},"additionalProperties":false},"example":{"id":"cash_0a1b2c3d4e5f60718293","fee":5000,"_links":{},"amount":5000,"method":"string","paidAt":"string","status":"string","currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"walletId":"wall_0a1b2c3d4e5f60718293","createdAt":"string","updatedAt":"string","approvedAt":"string","transferCode":"string","receivingBankAccount":{"type":"string","pixKey":"string","bankCode":"string","bankName":"string","document":"string","holderName":"JOAO SILVA","accountNumber":"string","routingNumber":"string"}}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createWithdrawal","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","minimum":1,"description":"Valor a sacar, em centavos (debitado do saldo disponível no pedido)."},"walletId":{"type":"string","pattern":"^(wall)_.+$","description":"A conta bancária que o recebe. Omitida = a principal; a parte das vendas no Pix vai sempre para a chave Pix do seu próprio CPF/CNPJ."}},"additionalProperties":false},"example":{"amount":5000,"walletId":"wall_0a1b2c3d4e5f60718293"}}},"required":true}}},"/v1/transactions":{"get":{"tags":["Transactions"],"summary":"Lista as transações","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","customId","customerId","cardBrand","amount","originalAmount","status","method","currency","fees","approvedAt","updatedAt","createdAt","images"],"properties":{"id":{"type":"string","pattern":"^(tra|trx)_.+$","description":"Identificador público (tra_/trx_…)"},"fees":{"type":"integer","description":"Total de taxas, em centavos."},"amount":{"type":"string","description":"Valor cobrado, em centavos (como texto)."},"images":{"type":"array","items":{"type":"string"},"description":"URLs das imagens dos itens."},"method":{"type":"string","description":"Meio de pagamento."},"status":{"type":"string","description":"Status da cobrança."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"customId":{"type":"string","nullable":true,"description":"O seu id personalizado da cobrança; `null` em cobranças antigas."},"cardBrand":{"type":"string","nullable":true,"description":"Bandeira do cartão; `null` nos outros meios."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"approvedAt":{"type":"string","nullable":true,"description":"Quando a cobrança foi aprovada; `null` nos demais casos."},"customerId":{"type":"string","pattern":"^(cus)_.+$","nullable":true,"description":"O comprador."},"originalAmount":{"type":"string","description":"Valor antes dos descontos, em centavos (como texto)."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"tra_0a1b2c3d4e5f60718293","fees":5000,"amount":"string","images":["string"],"method":"string","status":"string","currency":"BRL","customId":"string","cardBrand":"string","createdAt":"string","updatedAt":"string","approvedAt":"string","customerId":"cus_0a1b2c3d4e5f60718293","originalAmount":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"status","schema":{"enum":["pending","pre-authorized","approved","failed","refused","canceled","refunded","chargeback","dispute","fraud-review","analyzing","awaiting","unauthorized"],"type":"string"},"required":false,"description":"Só cobranças com este status."},{"in":"query","name":"method","schema":{"enum":["credit","pix","billet","nupay"],"type":"string"},"required":false,"description":"Só cobranças com este meio de pagamento."},{"in":"query","name":"customerId","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":false,"description":"Só as cobranças deste cliente."},{"in":"query","name":"customerid","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":false,"description":"Apelido de `customerId`."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(tra|trx)_.+$"},"required":false,"description":"Só esta cobrança."},{"in":"query","name":"customid","schema":{"type":"string","maxLength":50},"required":false,"description":"Só a cobrança com este id personalizado."},{"in":"query","name":"referenceid","schema":{"type":"string","maxLength":255},"required":false,"description":"Só as cobranças com esta referência externa sua."},{"in":"query","name":"customeremail","schema":{"type":"string","format":"email"},"required":false,"description":"Só as cobranças do comprador com este e-mail."},{"in":"query","name":"customerdocument","schema":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":11},"required":false,"description":"Só as cobranças do comprador com este documento (dígitos do CPF/CNPJ)."},{"in":"query","name":"source","schema":{"type":"string","maxLength":20},"required":false,"description":"Só as cobranças desta origem."},{"in":"query","name":"ipaddress","schema":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"required":false,"description":"Só as cobranças feitas deste endereço IP."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listTransactions"},"post":{"tags":["Transactions"],"summary":"Cria uma transação (cobrança)","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","customId","amount","originalAmount","fees","net","status","method","currency","payment","discount","discounts","customer","billing","externalReference","shippable","spplited","items","receivables","splits","refunds","disputes","timeline","callback","utm","processingTimeMs","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(tra|trx)_.+$","description":"Identificador público (tra_/trx_…)"},"net":{"type":"integer","description":"O que você recebe: `amount − fees`, em centavos."},"utm":{"type":"object","nullable":true,"properties":{"term":{"type":"string","description":"`utm_term`."},"medium":{"type":"string","description":"`utm_medium`."},"source":{"type":"string","description":"`utm_source`."},"content":{"type":"string","description":"`utm_content`."},"campaign":{"type":"string","description":"`utm_campaign`."}},"description":"Atribuição de marketing da venda; `null` quando não há.","additionalProperties":false},"fees":{"type":"integer","description":"Total de taxas retidas, em centavos."},"items":{"type":"array","items":{"type":"object","required":["id","name","unitPrice","quantity","currency","description","images","isUpsell","isOrderbump","variantId","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(item|tri)_.+$","description":"Identificador público (item_/tri_…)"},"name":{"type":"string","description":"Nome do item."},"images":{"type":"array","items":{"type":"string"},"nullable":true,"description":"URLs das imagens do item; `null` quando não há."},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"isUpsell":{"type":"boolean","nullable":true,"description":"Se o item foi adicionado por uma oferta de upsell."},"metadata":{"nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há."},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário, em centavos."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"variantId":{"type":"string","nullable":true,"description":"A variante do catálogo; `null` num item avulso."},"description":{"type":"string","nullable":true,"description":"Descrição do item."},"isOrderbump":{"type":"boolean","nullable":true,"description":"Se o item foi adicionado por um order bump."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"nullable":true,"description":"Itens do carrinho; `null` quando a cobrança não teve itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","description":"Valor cobrado, em centavos (depois dos descontos)."},"method":{"enum":["credit","pix","billet","nupay"],"type":"string","description":"Meio de pagamento."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","receivable","amount","grossAmount","percentage","description","chargeProcessingFee","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do split."},"amount":{"type":"integer","description":"Fatia líquida, em centavos."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"percentage":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"A fatia como percentual, quando foi definida assim."},"receivable":{"type":"string","nullable":true,"description":"O recebível criado para a fatia."},"description":{"type":"string","nullable":true,"description":"Descrição."},"grossAmount":{"type":"integer","description":"Fatia bruta, em centavos."},"chargeProcessingFee":{"type":"boolean","nullable":true,"description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"As fatias desta cobrança destinadas a outras contas; `null` quando não há split."},"status":{"enum":["pending","pre-authorized","approved","failed","refused","canceled","refunded","chargeback","dispute","fraud-review","analyzing","awaiting"],"type":"string","description":"Status da cobrança. A criação é assíncrona: o desfecho chega por webhook."},"billing":{"type":"object","required":["address"],"properties":{"address":{"type":"object","required":["id","ownerId","ownerType","street","number","complement","district","city","state","postcode","country","latitude","longitude","line","line1","line2","line3","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do endereço; `null` quando o endereço não foi salvo."},"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"ownerId":{"type":"string","nullable":true,"description":"Id público do dono do endereço."},"district":{"type":"string","nullable":true,"description":"Bairro."},"latitude":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Latitude; `null` quando desconhecida."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"longitude":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Longitude; `null` quando desconhecida."},"ownerType":{"type":"string","nullable":true,"description":"Quem é dono do endereço (`customer`, `company`…)."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."}},"description":"O endereço do pagador.","additionalProperties":false}},"description":"Bloco de cobrança.","additionalProperties":false},"payment":{"type":"object","required":["provider","version","refused","reusable","billetUrl","billetBarcode","billetSequence","billetDocumentNumber","billetReferenceNumber","pixQrCodeEmv","pixQrCodeUrl","pixQrCodeImage","acquirerTransactionNumber","cardFirstDigits","cardLastDigits","cardBrand","cardRegistered","cardId","installments","expirationDate","paidAt","allowRenewPayment","invoiceLink","invoicePathLink"],"properties":{"cardId":{"type":"string","nullable":true,"description":"Id público (`card_…`) do cartão que esta cobrança usou, quando ficou salvo no cliente — o mesmo que `GET /v1/cards` lista. Use-o para cobrar renovações com `payment.card.id`. `null` sem cartão."},"paidAt":{"type":"string","nullable":true,"description":"Quando a cobrança foi paga; `null` até lá."},"refused":{"type":"object","nullable":true,"required":["code","type","category","message","displayMessage","reversible"],"properties":{"code":{"enum":["insufficientFundsError","expiredCardError","invalidCardNumber","invalidExpiryMonth","invalidExpiryYear","invalidSecurityCode","invalidPinCode","invalidPaymentInformation","cardDeclined","authorizationRefused","cardCustomerNotAssociated","invalidParameters","sellerAuthorizationRefused","paymentMethodUnavailable","pixAutomaticNotDebited","cardValidationUnavailable","paymentProcessingError"],"type":"string","description":"Código estável da recusa — o valor para tratar no seu sistema."},"type":{"enum":["cardError","invalidRequestError","processingError"],"type":"string","description":"Família do erro: `cardError`, `invalidRequestError` ou `processingError`."},"message":{"type":"string","description":"Mensagem técnica (em inglês)."},"category":{"enum":["payment","validation","businessRule","processing"],"type":"string","description":"`payment`, `validation`, `businessRule` ou `processing`."},"reversible":{"type":"boolean","description":"Se o comprador pode tentar de novo (ex.: com outro cartão)."},"displayMessage":{"type":"string","description":"Mensagem segura para mostrar ao comprador (pt-BR)."}},"description":"Por que a cobrança foi recusada; `null` quando não foi.","additionalProperties":false},"version":{"enum":["1.1"],"type":"string","description":"Versão do objeto de pagamento."},"provider":{"enum":["selectwin"],"type":"string","description":"Sempre `selectwin`."},"reusable":{"type":"boolean","description":"Se o pagamento pode ser reutilizado (hoje sempre `false`)."},"billetUrl":{"type":"string","nullable":true,"description":"URL do boleto (PDF); `null` nos outros meios e até ser emitido."},"cardBrand":{"type":"string","nullable":true,"description":"Bandeira do cartão."},"invoiceLink":{"type":"string","nullable":true,"description":"URL do comprovante hospedado desta cobrança (`pay.selectwin.io/r/…`). `null` na resposta da criação — preenchido na leitura e nos webhooks."},"installments":{"type":"integer","nullable":true,"description":"Número de parcelas."},"pixQrCodeEmv":{"type":"string","nullable":true,"description":"Código copia e cola do Pix (EMV); `null` até ser emitido."},"pixQrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code do Pix."},"billetBarcode":{"type":"string","nullable":true,"description":"Linha digitável do boleto."},"billetSequence":{"type":"string","nullable":true,"description":"Número sequencial do boleto."},"cardLastDigits":{"type":"string","nullable":true,"description":"Quatro últimos dígitos do cartão."},"cardRegistered":{"type":"boolean","description":"Se o cartão foi salvo no cliente."},"expirationDate":{"type":"string","nullable":true,"description":"Quando o Pix ou o boleto expira; `null` em cartão."},"pixQrCodeImage":{"type":"string","nullable":true,"description":"Imagem do QR code do Pix (base64); `null` quando não disponível."},"cardFirstDigits":{"type":"string","nullable":true,"description":"Seis primeiros dígitos do cartão; `null` nos outros meios."},"invoicePathLink":{"type":"string","nullable":true,"description":"O mesmo comprovante, como caminho (`/r/{env}/{token}`) para renderizar no seu próprio domínio. `null` exatamente quando `invoiceLink` é."},"nupayPaymentUrl":{"type":"string","nullable":true,"description":"NuPay: o link de aprovação no app do Nubank, para onde o comprador é enviado. `null` nos outros meios."},"allowRenewPayment":{"type":"boolean","description":"Se um novo Pix/boleto pode ser emitido para esta cobrança (`true` nesses meios)."},"billetDocumentNumber":{"type":"string","nullable":true,"description":"Número do documento do boleto."},"billetReferenceNumber":{"type":"string","nullable":true,"description":"Número de referência do boleto."},"acquirerTransactionNumber":{"type":"string","nullable":true,"description":"Número da cobrança no provedor de pagamento (NSU)."}},"description":"Como a cobrança é paga: o código Pix, o boleto, o cartão usado, a recusa.","additionalProperties":false},"refunds":{"type":"array","items":{"type":"object","required":["id","description","receiptId","amount","category","observations","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(void|trf|trr)_.+$","description":"Identificador público (void_/trf_/trr_…)"},"amount":{"type":"integer","description":"Valor estornado, em centavos."},"category":{"type":"string","nullable":true,"description":"Categoria do estorno (ver `GET /v1/utils/types-of-refund`)."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"receiptId":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Comprovante do estorno."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"Por que foi estornado."},"observations":{"type":"string","nullable":true,"description":"Observações."}},"additionalProperties":false},"nullable":true,"description":"Os estornos feitos nesta cobrança; `null` quando não há."},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","nullable":true,"description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","nullable":true,"description":"URL que recebe os webhooks desta cobrança."}},"description":"Webhook só desta cobrança; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"customId":{"type":"string","nullable":true,"description":"O seu id personalizado da cobrança: prefixo + base + sufixo, como configurado em `/v1/companies/configs`; `null` em cobranças antigas."},"customer":{"type":"object","nullable":true,"required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail; `null` quando não há."},"gender":{"type":"string","nullable":true,"description":"Gênero (`male`, `female`, `other`); `null` quando desconhecido."},"document":{"type":"object","required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento; `null` quando não há."},"number":{"type":"string","nullable":true,"description":"Número do documento (dígitos em CPF/CNPJ); `null` quando não há."}},"description":"Documento do comprador.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há."},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"nullable":true,"description":"Outros e-mails do comprador; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador deste cliente; `null` quando não há."}},"description":"O comprador; `null` quando não há.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"integer","description":"O desconto, em centavos."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado à cobrança; `null` quando não há.","additionalProperties":false},"disputes":{"type":"array","items":{"type":"object","required":["id","returnEmail","description","status","reason","reasonCode","reasonDescription","openedAt","closedAt","outcome","decidedAt","deadline","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id da disputa."},"reason":{"type":"string","nullable":true,"description":"Por que o comprador contestou."},"status":{"type":"string","nullable":true,"description":"Status da disputa."},"outcome":{"enum":["won","lost"],"type":"string","nullable":true,"description":"Como terminou: `won` (a cobrança volta a aprovada) ou `lost` (chargeback); `null` enquanto aberta."},"closedAt":{"type":"string","nullable":true,"description":"Quando foi encerrada; `null` enquanto aberta."},"deadline":{"type":"object","nullable":true,"required":["deadlineAt","hoursRemaining","expired","urgent"],"properties":{"urgent":{"type":"boolean","description":"Ainda defensável, mas perto do prazo."},"expired":{"type":"boolean","description":"A janela fechou: provas enviadas agora não são mais aceitas."},"deadlineAt":{"type":"string","nullable":true,"description":"Até quando as provas são aceitas."},"hoursRemaining":{"type":"number","nullable":true,"description":"Horas restantes para enviar as provas."}},"description":"O prazo das provas, derivado de `openedAt`; `null` quando a data de abertura é desconhecida.","additionalProperties":false},"openedAt":{"type":"string","nullable":true,"description":"Quando a disputa foi aberta."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"decidedAt":{"type":"string","nullable":true,"description":"Quando foi decidida; `null` enquanto aberta."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"reasonCode":{"type":"string","nullable":true,"description":"Código do motivo na bandeira."},"description":{"type":"string","nullable":true,"description":"O texto da sua defesa."},"returnEmail":{"type":"string","nullable":true,"description":"E-mail que recebe o desfecho."},"deliveryProof":{"nullable":true,"description":"Prova de entrega que você anexou; `null` quando não há."},"shipmentProof":{"nullable":true,"description":"Prova de envio que você anexou; `null` quando não há."},"fiscalDocuments":{"nullable":true,"description":"Documentos fiscais que você anexou; `null` quando não há."},"deliveryReceipts":{"nullable":true,"description":"Comprovantes de entrega que você anexou; `null` quando não há."},"reasonDescription":{"type":"string","nullable":true,"description":"Descrição do motivo."},"communicationProof":{"nullable":true,"description":"Prova de comunicação que você anexou; `null` quando não há."}},"additionalProperties":false},"nullable":true,"description":"As disputas desta cobrança; `null` quando não há."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há."},"shipping":{"nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há."},"spplited":{"type":"boolean","description":"Se a cobrança foi dividida com outras contas (ver `splits`). O nome mantém a grafia histórica."},"timeline":{"type":"array","items":{"type":"object","required":["id","message","details","type","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id da entrada."},"type":{"type":"string","nullable":true,"description":"Tipo da entrada."},"details":{"type":"string","nullable":true,"description":"Detalhes da entrada."},"message":{"type":"string","nullable":true,"description":"O que aconteceu."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"additionalProperties":false},"description":"Histórico da cobrança (mudanças de status e notas), do mais antigo ao mais novo."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a venda tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"receivables":{"type":"array","items":{"type":"object","required":["id","recipient","split","status","amount","grossAmount","anticipationFee","installmentNumber","description","currency","authorizationCode","paidAt","refundedAt","canceledAt","expectedOn","liable","chargeProcessingFee","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do recebível (`rec_…`)."},"split":{"type":"string","nullable":true,"description":"O split de que vem; `null` quando é seu."},"amount":{"type":"integer","description":"Valor líquido, em centavos."},"liable":{"type":"boolean","nullable":true,"description":"Se este recebedor arca com os chargebacks dele."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi liberado ao recebedor; `null` até lá."},"status":{"type":"string","nullable":true,"description":"Status do recebível."},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que o recebe."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando foi cancelado; `null` quando não foi."},"expectedOn":{"type":"string","nullable":true,"description":"Data prevista de liberação."},"refundedAt":{"type":"string","nullable":true,"description":"Quando foi estornado; `null` quando não foi."},"description":{"type":"string","nullable":true,"description":"Descrição."},"grossAmount":{"type":"integer","description":"Valor bruto, em centavos."},"anticipationFee":{"type":"integer","nullable":true,"description":"Taxa cobrada para antecipá-lo, em centavos; `null` quando não foi antecipado."},"authorizationCode":{"type":"string","nullable":true,"description":"Código de autorização da cobrança."},"installmentNumber":{"type":"integer","nullable":true,"description":"Número da parcela a que pertence."},"chargeProcessingFee":{"type":"boolean","nullable":true,"description":"Se este recebedor paga a taxa de processamento."}},"additionalProperties":false},"nullable":true,"description":"Os recebíveis desta cobrança, um por parcela e recebedor; `null` quando ainda não há."},"paymentGroup":{"type":"object","nullable":true,"required":["id","method","status","legIndex","legCount","isPrimary","totalAmount"],"properties":{"id":{"type":"string","description":"Id do pedido (o grupo de pagamento)."},"method":{"enum":["dualcredit","creditpix"],"type":"string","description":"`dualcredit` (dois cartões) ou `creditpix` (cartão + Pix)."},"status":{"enum":["authorizing","awaiting_retry","awaiting_pix","capturing","paid","compensating","failed","canceled","needs_review"],"type":"string","description":"Status do pedido inteiro — feche o pedido por ele, nunca por uma parte."},"legCount":{"type":"integer","description":"Número de partes do pedido."},"legIndex":{"type":"integer","description":"Posição desta parte no pedido (a partir de 0)."},"isPrimary":{"type":"boolean","description":"Se é a parte principal do pedido."},"totalAmount":{"type":"integer","description":"Total do pedido, em centavos."},"transactionIds":{"type":"array","items":{"type":"string"},"description":"A cobrança atual de cada parte do pedido, na ordem das partes (esta inclusa)."}},"description":"Pagamento combinado: esta cobrança é UMA PARTE de um pedido pago com dois cartões ou cartão + Pix. `null` = venda comum.","additionalProperties":false},"originalAmount":{"type":"integer","description":"Valor antes dos descontos, em centavos."},"processingTimeMs":{"type":"integer","nullable":true,"description":"Tempo da criação até o primeiro resultado do pagamento, em milissegundos; `null` até lá."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da cobrança; `null` quando não há."}},"additionalProperties":false},"examples":{"pixPending":{"value":{"id":"tra_0a1b2c3d4e5f60718293","net":4751,"utm":null,"fees":249,"items":null,"_links":{"self":{"href":"https://api.selectwin.io/v1/transactions/tra_0a1b2c3d4e5f60718293","method":"GET","description":"Read a transaction."},"refund":{"href":"https://api.selectwin.io/v1/transactions/tra_0a1b2c3d4e5f60718293/refund","method":"POST","description":"Refund the transaction."},"capture":{"href":"https://api.selectwin.io/v1/transactions/tra_0a1b2c3d4e5f60718293/capture","method":"POST","description":"Capture the transaction."}},"amount":5000,"method":"pix","splits":null,"status":"pending","billing":{"address":{"id":null,"city":null,"line":null,"line1":null,"line2":null,"line3":null,"state":null,"number":null,"street":null,"country":null,"ownerId":null,"district":null,"latitude":null,"postcode":null,"createdAt":null,"longitude":null,"ownerType":null,"updatedAt":null,"complement":null}},"payment":{"cardId":null,"paidAt":null,"refused":null,"version":"1.1","provider":"selectwin","reusable":false,"billetUrl":null,"cardBrand":null,"invoiceLink":null,"installments":1,"pixQrCodeEmv":null,"pixQrCodeUrl":null,"billetBarcode":null,"billetSequence":null,"cardLastDigits":null,"cardRegistered":false,"expirationDate":"2026-01-15T13:00:00.000Z","pixQrCodeImage":null,"cardFirstDigits":null,"invoicePathLink":null,"nupayPaymentUrl":null,"allowRenewPayment":true,"billetDocumentNumber":null,"billetReferenceNumber":null,"acquirerTransactionNumber":null},"refunds":null,"callback":null,"currency":"BRL","customId":"K7M8N9P2Q3RS","customer":{"id":"cus_0a1b2c3d4e5f60718293","email":"joao.silva@example.com","gender":null,"document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","metadata":null,"available":true,"birthdate":"1990-05-20","createdAt":"2026-01-15T12:00:00.000Z","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"2026-01-15T12:00:00.000Z","delinquent":false,"additionalEmails":null,"externalReference":null},"discount":null,"disputes":null,"merchant":{"name":"Acme Ltda","merchantId":"bus_0a1b2c3d4e5f60718293","isSubAccount":false},"metadata":null,"shipping":null,"spplited":false,"timeline":[],"createdAt":"2026-01-15T12:00:00.000Z","discounts":null,"shippable":false,"updatedAt":"2026-01-15T12:00:00.000Z","receivables":null,"originalAmount":5000,"processingTimeMs":null,"externalReference":"PEDIDO-123"}},"billetPending":{"value":{"id":"tra_0a1b2c3d4e5f60718293","net":4751,"utm":null,"fees":249,"items":null,"_links":{"self":{"href":"https://api.selectwin.io/v1/transactions/tra_0a1b2c3d4e5f60718293","method":"GET","description":"Read a transaction."},"refund":{"href":"https://api.selectwin.io/v1/transactions/tra_0a1b2c3d4e5f60718293/refund","method":"POST","description":"Refund the transaction."},"capture":{"href":"https://api.selectwin.io/v1/transactions/tra_0a1b2c3d4e5f60718293/capture","method":"POST","description":"Capture the transaction."}},"amount":5000,"method":"billet","splits":null,"status":"pending","billing":{"address":{"id":"addr_0a1b2c3d4e5f60718293","city":"São Paulo","line":"Avenida Paulista, 1000 - Bela Vista, São Paulo - SP, 01310100","line1":"Avenida Paulista, 1000","line2":"Bela Vista","line3":"São Paulo - SP, 01310100","state":"SP","number":"1000","street":"Avenida Paulista","country":"BR","ownerId":"cus_0a1b2c3d4e5f60718293","district":"Bela Vista","latitude":null,"postcode":"01310100","createdAt":"2026-01-15T12:00:00.000Z","longitude":null,"ownerType":"customer","updatedAt":"2026-01-15T12:00:00.000Z","complement":null}},"payment":{"cardId":null,"paidAt":null,"refused":null,"version":"1.1","provider":"selectwin","reusable":false,"billetUrl":null,"cardBrand":null,"invoiceLink":null,"installments":1,"pixQrCodeEmv":null,"pixQrCodeUrl":null,"billetBarcode":null,"billetSequence":null,"cardLastDigits":null,"cardRegistered":false,"expirationDate":"2026-01-18T12:00:00.000Z","pixQrCodeImage":null,"cardFirstDigits":null,"invoicePathLink":null,"nupayPaymentUrl":null,"allowRenewPayment":true,"billetDocumentNumber":null,"billetReferenceNumber":null,"acquirerTransactionNumber":null},"refunds":null,"callback":null,"currency":"BRL","customId":"K7M8N9P2Q3RS","customer":{"id":"cus_0a1b2c3d4e5f60718293","email":"joao.silva@example.com","gender":null,"document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","metadata":null,"available":true,"birthdate":"1990-05-20","createdAt":"2026-01-15T12:00:00.000Z","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"2026-01-15T12:00:00.000Z","delinquent":false,"additionalEmails":null,"externalReference":null},"discount":null,"disputes":null,"merchant":{"name":"Acme Ltda","merchantId":"bus_0a1b2c3d4e5f60718293","isSubAccount":false},"metadata":null,"shipping":null,"spplited":false,"timeline":[],"createdAt":"2026-01-15T12:00:00.000Z","discounts":null,"shippable":false,"updatedAt":"2026-01-15T12:00:00.000Z","receivables":null,"originalAmount":5000,"processingTimeMs":null,"externalReference":"PEDIDO-123"}},"creditPending":{"value":{"id":"tra_0a1b2c3d4e5f60718293","net":4751,"utm":null,"fees":249,"items":null,"_links":{"self":{"href":"https://api.selectwin.io/v1/transactions/tra_0a1b2c3d4e5f60718293","method":"GET","description":"Read a transaction."},"refund":{"href":"https://api.selectwin.io/v1/transactions/tra_0a1b2c3d4e5f60718293/refund","method":"POST","description":"Refund the transaction."},"capture":{"href":"https://api.selectwin.io/v1/transactions/tra_0a1b2c3d4e5f60718293/capture","method":"POST","description":"Capture the transaction."}},"amount":5000,"method":"credit","splits":null,"status":"pending","billing":{"address":{"id":null,"city":null,"line":null,"line1":null,"line2":null,"line3":null,"state":null,"number":null,"street":null,"country":null,"ownerId":null,"district":null,"latitude":null,"postcode":null,"createdAt":null,"longitude":null,"ownerType":null,"updatedAt":null,"complement":null}},"payment":{"cardId":"card_0a1b2c3d4e5f60718293","paidAt":null,"refused":null,"version":"1.1","provider":"selectwin","reusable":false,"billetUrl":null,"cardBrand":"visa","invoiceLink":null,"installments":3,"pixQrCodeEmv":null,"pixQrCodeUrl":null,"billetBarcode":null,"billetSequence":null,"cardLastDigits":"1111","cardRegistered":true,"expirationDate":null,"pixQrCodeImage":null,"cardFirstDigits":"411111","invoicePathLink":null,"nupayPaymentUrl":null,"allowRenewPayment":false,"billetDocumentNumber":null,"billetReferenceNumber":null,"acquirerTransactionNumber":null},"refunds":null,"callback":null,"currency":"BRL","customId":"K7M8N9P2Q3RS","customer":{"id":"cus_0a1b2c3d4e5f60718293","email":"joao.silva@example.com","gender":null,"document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","metadata":null,"available":true,"birthdate":"1990-05-20","createdAt":"2026-01-15T12:00:00.000Z","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"2026-01-15T12:00:00.000Z","delinquent":false,"additionalEmails":null,"externalReference":null},"discount":null,"disputes":null,"merchant":{"name":"Acme Ltda","merchantId":"bus_0a1b2c3d4e5f60718293","isSubAccount":false},"metadata":null,"shipping":null,"spplited":false,"timeline":[],"createdAt":"2026-01-15T12:00:00.000Z","discounts":null,"shippable":false,"updatedAt":"2026-01-15T12:00:00.000Z","receivables":null,"originalAmount":5000,"processingTimeMs":null,"externalReference":"PEDIDO-123"}}}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"description":"Cria uma transação (cobrança) no cartão de crédito, no Pix ou no boleto (e no NuPay, nas contas habilitadas).\n\n**A criação é assíncrona.** A resposta `201` vem `pending` (ou `fraud-review`) e o desfecho chega por webhook (`transaction.approved`, `transaction.failed`…). O copia e cola e o link do QR do Pix (`payment.pixQrCodeEmv`, `payment.pixQrCodeUrl`) e a linha digitável e o link do boleto (`payment.billetBarcode`, `payment.billetUrl`) não vêm na `201`: chegam no webhook `transaction.pending` e ficam na leitura da transação.\n\n**Regras condicionais (a API confere; não estão no JSON Schema):**\n- `customer` leva o `id` de um cliente salvo **ou** os dados inline (`firstName`, `lastName` e `email`).\n- `payment.method=credit` exige `payment.card.id` (cartão salvo), `payment.card.token` (cartão tokenizado no navegador) ou o cartão completo (`holderName`, `expirationMonth`, `expirationYear`, `numbering`, `securityCode`).\n- `payment.method=billet` exige `billing.address.id` (endereço salvo) ou o endereço inline (`postcode`, `street`, `number`).\n- `payment.method=nupay` exige `payment.nupay.returnUrl` e `payment.nupay.cancelUrl`, à vista e sem cartão; na conta não habilitada, `422 paymentMethodNotAvailable`.\n- Se `items[]` for enviado, a soma de `unitPrice × quantity` deve ser igual a `amount`.\n- Desconto só por código de cupom do catálogo: `discounts: [{ \"code\": \"BEMVINDO10\" }]`.\n\nVeja os exemplos por método (credit / pix / billet / creditWithCart).","operationId":"createTransaction","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","payment","customer"],"properties":{"utm":{"type":"object","description":"Atribuição de marketing da venda: `utm_source`, `utm_medium`, `utm_campaign`, `utm_content`, `utm_term` (ou `source`, `medium`…).","additionalProperties":{}},"items":{"type":"array","items":{"type":"object","required":["name","unitPrice","quantity"],"properties":{"name":{"type":"string","maxLength":255,"description":"Nome do item."},"images":{"type":"array","items":{"type":"string","format":"uri","description":"URL absoluta."},"maxItems":10,"description":"URLs das imagens do item (até 10)."},"pricing":{"type":"object","properties":{"currency":{"type":"string","description":"Código de moeda ISO 4217"},"quantity":{"type":"integer","maximum":100000,"minimum":1,"description":"Quantidade."},"unitPrice":{"type":"integer","maximum":20000000,"minimum":0,"description":"Preço unitário, em centavos."}},"description":"Apelido dos campos planos do item (`unitPrice`, `quantity`, `currency`), aninhados.","additionalProperties":false},"currency":{"type":"string","description":"Código de moeda ISO 4217"},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"quantity":{"type":"integer","maximum":100000,"minimum":1,"description":"Quantidade."},"unitPrice":{"type":"integer","maximum":20000000,"minimum":0,"description":"Preço unitário, em centavos."},"variantId":{"type":"string","pattern":"^.+_.+$","description":"A variante do catálogo a que este item se refere, quando vem do seu catálogo."},"description":{"type":"string","maxLength":1000,"description":"Descrição do item."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador do item."}},"description":"Um item do carrinho. A soma de `unitPrice × quantity` dos itens precisa ser igual a `amount`.","additionalProperties":false},"maxItems":100,"description":"Itens do carrinho (até 100)."},"amount":{"type":"integer","maximum":20000000,"minimum":500,"description":"Valor em centavos, antes dos descontos (mínimo 500 = R$ 5,00). Com `items[]`, precisa ser igual à soma de `unitPrice × quantity`."},"source":{"type":"string","maxLength":20,"description":"De onde a venda veio (texto livre, até 20 caracteres)."},"splits":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat` (com `value`)."},"value":{"type":"number","maximum":20000000,"minimum":0,"description":"O percentual (0–100) ou o valor fixo em reais, conforme `type`."},"recipient":{"type":"string","pattern":"^.+_.+$","description":"Apelido de `recipientId`."},"amountCents":{"type":"integer","minimum":1,"description":"Uma fatia fixa, em centavos."},"recipientId":{"type":"string","pattern":"^.+_.+$","description":"A conta que recebe esta fatia (`bus_…`)."}},"description":"Uma fatia desta cobrança destinada a outra conta: `recipientId` + `amountCents`, ou `recipient` + `type` + `value`.","additionalProperties":false},"maxItems":10,"description":"Fatias desta cobrança destinadas a outras contas (até 10)."},"billing":{"type":"object","required":["address"],"properties":{"address":{"type":"object","properties":{"id":{"type":"string","pattern":"^.+_.+$","description":"Um endereço salvo do comprador."},"city":{"type":"string","maxLength":100,"description":"Cidade."},"state":{"type":"string","maxLength":100,"description":"Estado (sigla de duas letras, ex.: `SP`)."},"number":{"type":"string","maxLength":100,"description":"Número."},"street":{"type":"string","maxLength":255,"description":"Logradouro."},"country":{"type":"string","maxLength":3,"minLength":2,"description":"Código do país (ISO 3166-1, ex.: `BR`)."},"district":{"type":"string","maxLength":100,"description":"Bairro."},"postcode":{"type":"string","pattern":"^\\d{5}-?\\d{3}$","description":"CEP, 8 dígitos — o hífen é aceito."},"complement":{"type":"string","maxLength":255,"description":"Complemento (apartamento, sala, bloco…)."}},"description":"Endereço do pagador: um endereço salvo (`id`) ou os campos inline (`postcode`, `street` e `number` pelo menos). Obrigatório no boleto; guardado como retrato nos outros meios.","additionalProperties":false}},"description":"Bloco de cobrança: o endereço do pagador.\n\n**Regra:** Obrigatório quando `payment.method=billet` (endereço do pagador): `billing.address.id` (salvo) ou endereço inline com postcode + street + number.","additionalProperties":false},"payment":{"type":"object","required":["method"],"properties":{"pix":{"type":"object","properties":{"expiresInDays":{"type":"integer","maximum":365,"minimum":1,"description":"Presente = um Pix com vencimento (vence em tantos dias, como um boleto) no lugar do QR code imediato."},"expiresInMinutes":{"type":"integer","maximum":525600,"minimum":15,"description":"Por quanto tempo o QR code fica pagável, em minutos (padrão das configurações da sua conta)."},"billingInstructions":{"type":"object","properties":{"lateFee":{"type":"object","properties":{"mode":{"enum":["fixed","percentage"],"type":"string","default":"fixed","description":"`fixed` (um valor) ou `percentage` (do boleto)."},"amount":{"type":"integer","minimum":0,"description":"A multa, em centavos (`mode=fixed`)."},"startDays":{"type":"integer","maximum":60,"minimum":0,"description":"Dias depois do vencimento até a multa valer (0 = desde o vencimento)."},"percentage":{"type":"number","maximum":100,"minimum":0,"description":"A multa, como percentual do boleto (`mode=percentage`)."}},"description":"Multa depois do vencimento.","additionalProperties":false},"interest":{"type":"object","properties":{"mode":{"enum":["dailyAmount","dailyPercentage","monthlyPercentage"],"type":"string","default":"dailyAmount","description":"`dailyAmount` (centavos por dia), `dailyPercentage` ou `monthlyPercentage`."},"amount":{"type":"integer","minimum":0,"description":"Juros por dia, em centavos (`mode=dailyAmount`)."},"startDays":{"type":"integer","maximum":60,"minimum":0,"description":"Dias depois do vencimento até os juros começarem (0 = desde o vencimento)."},"percentage":{"type":"number","maximum":100,"minimum":0,"description":"Taxa de juros, como percentual por dia ou por mês, conforme `mode`."}},"description":"Juros depois do vencimento.","additionalProperties":false},"discounts":{"type":"array","items":{"type":"object","properties":{"mode":{"enum":["fixed","percentage"],"type":"string","default":"fixed","description":"`fixed` (um valor) ou `percentage` (do boleto)."},"amount":{"type":"integer","minimum":0,"description":"O desconto, em centavos (`mode=fixed`)."},"percentage":{"type":"number","maximum":100,"minimum":0,"description":"O desconto, como percentual do boleto (`mode=percentage`)."},"daysBeforeDue":{"type":"integer","default":0,"maximum":365,"minimum":0,"description":"Dias antes do vencimento até quando o desconto vale (0 = até o vencimento)."}},"description":"Desconto por antecipação.","additionalProperties":false},"maxItems":3,"minItems":1,"description":"Descontos por antecipação (1 a 3 faixas). Nem todo banco aplica mais do que a primeira."}},"description":"Descontos por antecipação de um Pix com vencimento. Multa e juros não valem no Pix.","additionalProperties":false}},"description":"Opções do Pix.","additionalProperties":false},"card":{"type":"object","properties":{"id":{"type":"string","pattern":"^(card)_.+$","description":"Um cartão salvo do cliente."},"token":{"type":"string","pattern":"^[A-Za-z0-9_.:-]+$","maxLength":128,"minLength":8,"description":"Token de cartão de uso único emitido no navegador do comprador por `POST /v1/tokenization/tokens` (válido por uma hora)."},"numbering":{"type":"string","description":"Número do cartão (PAN), só dígitos — espaços e traços são removidos. Tokenizado ao chegar, nunca guardado."},"holderName":{"type":"string","maxLength":255,"minLength":3,"description":"Nome impresso no cartão (só no cartão inline)."},"securityCode":{"type":"string","pattern":"^\\d{3,4}$","description":"Código de segurança do cartão (CVV/CVC), 3 ou 4 dígitos."},"expirationYear":{"allOf":[{"type":"integer","minimum":0},{"type":"integer","maximum":2100,"minimum":2026}],"description":"Ano de validade, 4 dígitos — 2 dígitos são aceitos (só no cartão inline)."},"expirationMonth":{"type":"integer","maximum":12,"minimum":1,"description":"Mês de validade, 1 a 12 (só no cartão inline)."}},"description":"O cartão de uma cobrança no crédito: um cartão salvo (`id`), um token emitido no navegador do comprador (`token`), ou o cartão completo inline. O cartão inline é tokenizado antes da cobrança e nunca guardado.","additionalProperties":false},"nupay":{"type":"object","required":["returnUrl","cancelUrl"],"properties":{"orderUrl":{"type":"string","format":"uri","description":"A página do pedido na sua loja."},"cancelUrl":{"type":"string","format":"uri","description":"Para onde o comprador volta depois de desistir."},"returnUrl":{"type":"string","format":"uri","description":"Para onde o comprador volta depois de aprovar o pagamento no app."},"expiresInMinutes":{"type":"integer","maximum":1440,"minimum":5,"description":"Quanto tempo o comprador tem para aprovar, em minutos (padrão das configurações da sua conta, senão 30)."}},"description":"Opções do NuPay — obrigatórias com `method=nupay`. A cobrança volta com `payment.nupayPaymentUrl`, onde o comprador a aprova.","additionalProperties":false},"billet":{"type":"object","properties":{"expiresInDays":{"type":"integer","maximum":365,"minimum":1,"description":"Dias até o vencimento do boleto (padrão das configurações da sua conta)."},"billingInstructions":{"type":"object","properties":{"lateFee":{"type":"object","properties":{"mode":{"enum":["fixed","percentage"],"type":"string","default":"fixed","description":"`fixed` (um valor) ou `percentage` (do boleto)."},"amount":{"type":"integer","minimum":0,"description":"A multa, em centavos (`mode=fixed`)."},"startDays":{"type":"integer","maximum":60,"minimum":0,"description":"Dias depois do vencimento até a multa valer (0 = desde o vencimento)."},"percentage":{"type":"number","maximum":100,"minimum":0,"description":"A multa, como percentual do boleto (`mode=percentage`)."}},"description":"Multa depois do vencimento.","additionalProperties":false},"interest":{"type":"object","properties":{"mode":{"enum":["dailyAmount","dailyPercentage","monthlyPercentage"],"type":"string","default":"dailyAmount","description":"`dailyAmount` (centavos por dia), `dailyPercentage` ou `monthlyPercentage`."},"amount":{"type":"integer","minimum":0,"description":"Juros por dia, em centavos (`mode=dailyAmount`)."},"startDays":{"type":"integer","maximum":60,"minimum":0,"description":"Dias depois do vencimento até os juros começarem (0 = desde o vencimento)."},"percentage":{"type":"number","maximum":100,"minimum":0,"description":"Taxa de juros, como percentual por dia ou por mês, conforme `mode`."}},"description":"Juros depois do vencimento.","additionalProperties":false},"discounts":{"type":"array","items":{"type":"object","properties":{"mode":{"enum":["fixed","percentage"],"type":"string","default":"fixed","description":"`fixed` (um valor) ou `percentage` (do boleto)."},"amount":{"type":"integer","minimum":0,"description":"O desconto, em centavos (`mode=fixed`)."},"percentage":{"type":"number","maximum":100,"minimum":0,"description":"O desconto, como percentual do boleto (`mode=percentage`)."},"daysBeforeDue":{"type":"integer","default":0,"maximum":365,"minimum":0,"description":"Dias antes do vencimento até quando o desconto vale (0 = até o vencimento)."}},"description":"Desconto por antecipação.","additionalProperties":false},"maxItems":3,"minItems":1,"description":"Descontos por antecipação (1 a 3 faixas). Nem todo banco aplica mais do que a primeira."}},"description":"Multa, juros e descontos por antecipação do boleto.","additionalProperties":false}},"description":"Opções do boleto.","additionalProperties":false},"method":{"enum":["credit","pix","billet","nupay"],"type":"string","description":"Meio de pagamento: `credit` (cartão), `pix`, `billet` (boleto) ou `nupay`."},"capture":{"type":"boolean","default":true,"description":"`true` (padrão) captura na hora; `false` só pré-autoriza — capture depois com `POST /v1/transactions/{id}/capture`."},"currency":{"type":"string","default":"BRL","description":"Código de moeda ISO 4217"},"installments":{"type":"integer","default":1,"maximum":21,"minimum":1,"description":"Número de parcelas (só cartão). O teto é o configurado na sua conta."},"financeInstallments":{"type":"boolean","default":true,"description":"`true` (padrão): o comprador paga os juros de parcelamento configurados na sua conta, então `amount` é inflado até o total financiado — exatamente como o simulador mostra. Mande `false` só quando `amount` já for o total financiado."}},"description":"Como cobrar.\n\n**Regra:** Com `method=credit`, `card` é **obrigatório** (`card.id` de um cartão salvo, ou cartão completo inline: holderName, expirationMonth, expirationYear, numbering, securityCode).","additionalProperties":false},"callback":{"type":"object","required":["webhookUrl"],"properties":{"active":{"type":"boolean","default":true,"description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","format":"uri","description":"URL que recebe os webhooks desta cobrança."}},"description":"Webhook só DESTA cobrança: os eventos dela vão para esta URL no lugar dos endpoints configurados na conta.","additionalProperties":false},"customer":{"type":"object","properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Um cliente salvo. Sem ele, o comprador é encontrado ou criado pelos campos inline."},"email":{"type":"string","format":"email","description":"Endereço de e-mail (obrigatório para criar o comprador inline)."},"gender":{"enum":["male","female","other"],"type":"string","description":"Gênero: `male`, `female` ou `other`."},"document":{"type":"object","required":["type","number"],"properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","description":"Tipo do documento: `cpf`, `cnpj` ou `passport`."},"number":{"type":"string","maxLength":20,"minLength":1,"description":"Número do documento: dígitos do CPF ou CNPJ, ou o número do passaporte."}},"description":"Documento do comprador.","additionalProperties":false},"fullName":{"type":"string","maxLength":255,"minLength":1,"description":"Nome completo, como alternativa a nome + sobrenome."},"lastName":{"type":"string","maxLength":255,"minLength":1,"description":"Sobrenome (obrigatório para criar o comprador inline)."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"birthdate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data de nascimento, `YYYY-MM-DD`."},"firstName":{"type":"string","maxLength":255,"minLength":2,"description":"Nome (obrigatório para criar o comprador inline)."},"telephone":{"type":"object","properties":{"line":{"type":"string","pattern":"^\\d+$","description":"O número inteiro com código do país e DDD (ex.: `5511987654321`) — o único telefone que chega ao provedor de pagamento (boleto, 3DS)."},"number":{"type":"string","pattern":"^\\d+$","description":"Número local, só dígitos."},"areaCode":{"type":"string","pattern":"^\\d+$","description":"DDD (ex.: `11`)."},"countryCode":{"type":"string","pattern":"^\\d+$","description":"Código do país (ex.: `55`)."}},"description":"Telefone do comprador, em partes; `line` é o número inteiro.","additionalProperties":false},"additionalEmails":{"type":"array","items":{"type":"string","format":"email","description":"Endereço de e-mail (normalizado em minúsculas)."},"maxItems":20,"description":"Outros e-mails do comprador (até 20)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador do comprador."}},"description":"O comprador: um cliente salvo (`id`), ou os dados inline (`firstName`, `lastName` e `email`), que é encontrado ou criado.\n\n**Regra:** Obrigatório informar `id` (cliente salvo) **OU** os dados inline `firstName` + `lastName` + `email` (a API faz find-or-create). Enviar `customer: {}` é rejeitado.","additionalProperties":false},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"shipping":{"type":"object","description":"Retrato do frete (JSON livre): guardado como enviado e devolvido na leitura.","additionalProperties":{}},"discounts":{"type":"array","items":{"type":"object","required":["code"],"properties":{"code":{"type":"string","maxLength":50,"minLength":1,"description":"Um código de cupom do seu catálogo."}},"description":"Um cupom a aplicar. Os cupons são aplicados em ordem, cada um sobre o valor restante.","additionalProperties":false},"maxItems":20,"description":"Códigos de cupom do seu catálogo (até 20), aplicados em ordem."},"onBehalfOf":{"type":"string","pattern":"^.+_.+$","description":"Marketplace: cobrar NA sub-conta sua indicada — ela passa a ser a vendedora de registro e a sua taxa de plataforma é recolhida como split. Ausente = você é o vendedor."},"description":{"type":"string","maxLength":1000,"description":"Nota em texto livre, guardada em `metadata.description`."},"geolocation":{"type":"object","properties":{"latitude":{"type":"number","maximum":90,"minimum":-90,"description":"Latitude do comprador."},"ipAddress":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"Endereço IP do comprador."},"longitude":{"type":"number","maximum":180,"minimum":-180,"description":"Longitude do comprador."},"userAgent":{"type":"string","maxLength":500,"description":"`User-Agent` do navegador do comprador."},"acceptLanguage":{"type":"string","maxLength":50,"description":"`Accept-Language` do navegador do comprador."},"deviceFingerprint":{"type":"string","maxLength":64,"description":"Impressão digital do dispositivo, coletada pelo seu front-end."}},"description":"Sinais de dispositivo e localização do comprador, para a análise de fraude. Todos opcionais: os cabeçalhos da requisição são usados quando omitidos.","additionalProperties":false},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador da cobrança (ex.: o número do seu pedido), devolvido como veio."}},"additionalProperties":false},"examples":{"pix":{"value":{"amount":5000,"payment":{"pix":{"expiresInMinutes":60},"method":"pix"},"customer":{"id":"cus_0a1b2c3d4e5f60718293"},"externalReference":"PEDIDO-123"}},"billet":{"value":{"amount":5000,"billing":{"address":{"id":"addr_0a1b2c3d4e5f60718293"}},"payment":{"billet":{"expiresInDays":3},"method":"billet"},"customer":{"id":"cus_0a1b2c3d4e5f60718293"},"externalReference":"PEDIDO-123"}},"credit":{"value":{"amount":5000,"payment":{"card":{"id":"card_0a1b2c3d4e5f60718293"},"method":"credit","capture":true,"installments":3},"customer":{"id":"cus_0a1b2c3d4e5f60718293"},"externalReference":"PEDIDO-123"}},"creditWithCart":{"value":{"items":[{"name":"Plano Pro","quantity":1,"unitPrice":5000}],"amount":5000,"payment":{"card":{"id":"card_0a1b2c3d4e5f60718293"},"method":"credit","installments":3},"customer":{"id":"cus_0a1b2c3d4e5f60718293"},"discounts":[{"code":"BEMVINDO10"}],"externalReference":"PEDIDO-123"}}}}},"required":true}}},"/v1/subscriptions":{"get":{"tags":["Subscriptions"],"summary":"Lista as assinaturas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","status","currency","method","type","currentCycle","customer","billing","canceledAt","cancellation","discount","discounts","renewalTerms","shippable","shipping","spplited","splits","items","callback","geolocation","externalReference","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(subs|sub)_.+$","description":"Identificador público (subs_/sub_…)"},"type":{"type":"string","nullable":true,"description":"Tipo da assinatura (`recurring`)."},"items":{"type":"array","items":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"description":"Os itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"method":{"type":"string","nullable":true,"description":"Como os ciclos são cobrados: `credit`, `pix` ou `billet`."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"Splits de cada cobrança de ciclo; `null` quando não há."},"status":{"enum":["active","trialing","pending","paused","pastdue","unpaid","canceled"],"type":"string","description":"Status: `active`, `trialing`, `pending`, `paused`, `pastdue`, `unpaid` ou `canceled`."},"billing":{"type":"object","required":["frequency","frequencyCount","endDate","exactDay","freeTrialDays","autoRenew","address"],"properties":{"address":{"type":"object","required":["street","number","complement","district","city","state","country","postcode","line","fingerprint","line1","line2","line3"],"properties":{"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","nullable":true,"description":"Bairro."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."},"fingerprint":{"type":"string","nullable":true,"description":"Impressão digital do endereço (deduplicação)."}},"description":"O endereço do pagador (usado no boleto de cada ciclo). Todos os campos `null` quando não há.","additionalProperties":false},"endDate":{"type":"string","nullable":true,"description":"Quando a assinatura termina; `null` = nunca."},"exactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que é cobrada; `null` quando não é fixo."},"autoRenew":{"type":"boolean","description":"Se a assinatura se renova sozinha no fim de cada período (`false` depois de um cancelamento no fim do período)."},"frequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança: `daily`, `weekly`, `monthly` ou `yearly`."},"freeTrialDays":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"frequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo."}},"description":"Periodicidade da cobrança e endereço do pagador.","additionalProperties":false},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","description":"URL que recebe os webhooks desta assinatura."}},"description":"Webhook próprio; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"customer":{"type":"object","required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","additionalEmails","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do cliente (`cus_…`)."},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail."},"gender":{"type":"string","nullable":true,"description":"Gênero; `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento."},"number":{"type":"string","nullable":true,"description":"Número do documento."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do cliente."}},"description":"O comprador.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"number","description":"O desconto."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado; `null` quando não há.","additionalProperties":false},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shipping":{"type":"object","nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há.","additionalProperties":{}},"spplited":{"type":"boolean","description":"Se as cobranças dos ciclos são divididas com outras contas (ver `splits`). O nome mantém a grafia histórica."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a assinatura tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando a assinatura foi encerrada; `null` enquanto está viva."},"geolocation":{"type":"object","nullable":true,"description":"Sinais de dispositivo e localização do comprador, como enviados; `null` quando não há.","additionalProperties":{}},"cancellation":{"type":"object","nullable":true,"required":["reasonCode","reason","canceledBy"],"properties":{"reason":{"type":"string","nullable":true,"description":"O texto livre escrito por quem cancelou."},"canceledBy":{"enum":["seller","customer","platform"],"type":"string","nullable":true,"description":"`seller` (API ou painel), `customer` (portal) ou `platform` (régua de cobrança, chargeback, estorno)."},"reasonCode":{"enum":["price","not_using","technical_issue","switched_provider","other"],"type":"string","nullable":true,"description":"O motivo da lista; `null` nos cancelamentos antigos e nos da própria plataforma."}},"description":"Por que foi cancelada; `null` enquanto ninguém pediu o cancelamento.","additionalProperties":false},"currentCycle":{"type":"object","nullable":true,"required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"description":"O ciclo de cobrança atual; `null` quando não há.","additionalProperties":false},"pixAutomatic":{"type":"object","nullable":true,"required":["status","journey","qrCodeEmv","qrCodeUrl","valueCents","firstChargeDate","approvedAt","endReason"],"properties":{"status":{"enum":["pending","awaitingAuthorization","active","rejected","ended"],"type":"string","description":"`pending` (sendo criado) · `awaitingAuthorization` (QR code exibido) · `active` (debitado a cada ciclo) · `rejected` (o pagador recusou ou revogou) · `ended`. Depois de `rejected`/`ended` os ciclos são cobrados por um QR code cada."},"journey":{"enum":["paymentOnApproval","onlyRecurrency"],"type":"string","description":"`paymentOnApproval`: o primeiro ciclo é pago junto com a autorização; `onlyRecurrency`: só a recorrência é autorizada."},"endReason":{"type":"string","nullable":true,"description":"Por que terminou; `null` enquanto ativo."},"qrCodeEmv":{"type":"string","nullable":true,"description":"O QR code de autorização (copia e cola) — só enquanto `awaitingAuthorization`."},"qrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code de autorização — só enquanto `awaitingAuthorization`."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o pagador autorizou; `null` até lá."},"valueCents":{"type":"integer","description":"O valor fixo debitado a cada ciclo, em centavos."},"firstChargeDate":{"type":"string","description":"Data do primeiro débito."}},"description":"Só na leitura individual; `null` quando a assinatura não é paga por Pix Automático.","additionalProperties":false},"renewalTerms":{"type":"object","nullable":true,"required":["shipping","shippingAmount","methodDiscount","discountMethod","discountPercentage"],"properties":{"shipping":{"type":"boolean","description":"Se o frete é cobrado em cada renovação."},"discountMethod":{"enum":["credit","pix","billet"],"type":"string","nullable":true,"description":"O meio que concedeu o desconto no checkout; `null` quando nenhum."},"methodDiscount":{"type":"boolean","description":"Se o desconto do meio de pagamento vale nas renovações cobradas por `discountMethod`."},"shippingAmount":{"type":"integer","description":"O frete cotado no checkout, em centavos (0 = sem frete)."},"discountPercentage":{"type":"number","description":"O desconto desse meio, como percentual (ex.: 5 = 5%)."}},"description":"O que cada renovação cobra além dos itens, congelado na criação; `null` = nada congelado (as renovações cobram itens menos cupons).","additionalProperties":false},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da assinatura; `null` quando não há."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"subs_0a1b2c3d4e5f60718293","type":"string","items":[{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","images":["string"],"enabled":true,"currency":"BRL","metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}],"_links":{},"method":"string","splits":[{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"liable":true,"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}],"status":"active","billing":{"address":{"city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","number":"1000","street":"string","country":"string","district":"string","postcode":"string","complement":"string","fingerprint":"string"},"endDate":"string","exactDay":0,"autoRenew":true,"frequency":"string","freeTrialDays":0,"frequencyCount":0},"callback":{"active":true,"webhookUrl":"string"},"currency":"BRL","customer":{"id":"string","email":"buyer@example.com","gender":"string","document":{"type":"string","number":"12345678909"},"lastName":"Silva","metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"},"discount":{"type":"string","value":5000,"percentageOfAmount":5000},"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shipping":{},"spplited":true,"createdAt":"string","discounts":[],"shippable":true,"updatedAt":"string","canceledAt":"string","geolocation":{},"cancellation":{"reason":"string","canceledBy":"seller","reasonCode":"price"},"currentCycle":{"id":"scy_0a1b2c3d4e5f60718293","cycle":0,"status":"string","dueDate":"string","endDate":"string","billedAt":"string","createdAt":"string","startDate":"string","updatedAt":"string"},"pixAutomatic":{"status":"pending","journey":"paymentOnApproval","endReason":"string","qrCodeEmv":"string","qrCodeUrl":"string","approvedAt":"string","valueCents":5000,"firstChargeDate":"string"},"renewalTerms":{"shipping":true,"discountMethod":"credit","methodDiscount":true,"shippingAmount":5000,"discountPercentage":0},"externalReference":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"status","schema":{"enum":["active","trialing","pending","paused","pastdue","unpaid","canceled"],"type":"string"},"required":false,"description":"Só assinaturas com este status."},{"in":"query","name":"method","schema":{"enum":["credit","pix","billet"],"type":"string"},"required":false,"description":"Só assinaturas cobradas por este meio."},{"in":"query","name":"customerId","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":false,"description":"Só as assinaturas deste cliente."},{"in":"query","name":"customerid","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":false,"description":"Apelido de `customerId`."},{"in":"query","name":"externalreference","schema":{"type":"string","maxLength":255,"minLength":1},"required":false,"description":"Só as assinaturas com esta referência externa sua."},{"in":"query","name":"customerdocument","schema":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":11},"required":false,"description":"Só as assinaturas do comprador com este documento (dígitos do CPF/CNPJ)."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listSubscriptions"},"post":{"tags":["Subscriptions"],"summary":"Cria uma assinatura","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","currency","method","type","currentCycle","customer","billing","canceledAt","cancellation","discount","discounts","renewalTerms","shippable","shipping","spplited","splits","items","callback","geolocation","externalReference","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(subs|sub)_.+$","description":"Identificador público (subs_/sub_…)"},"type":{"type":"string","nullable":true,"description":"Tipo da assinatura (`recurring`)."},"items":{"type":"array","items":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"description":"Os itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"method":{"type":"string","nullable":true,"description":"Como os ciclos são cobrados: `credit`, `pix` ou `billet`."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"Splits de cada cobrança de ciclo; `null` quando não há."},"status":{"enum":["active","trialing","pending","paused","pastdue","unpaid","canceled"],"type":"string","description":"Status: `active`, `trialing`, `pending`, `paused`, `pastdue`, `unpaid` ou `canceled`."},"billing":{"type":"object","required":["frequency","frequencyCount","endDate","exactDay","freeTrialDays","autoRenew","address"],"properties":{"address":{"type":"object","required":["street","number","complement","district","city","state","country","postcode","line","fingerprint","line1","line2","line3"],"properties":{"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","nullable":true,"description":"Bairro."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."},"fingerprint":{"type":"string","nullable":true,"description":"Impressão digital do endereço (deduplicação)."}},"description":"O endereço do pagador (usado no boleto de cada ciclo). Todos os campos `null` quando não há.","additionalProperties":false},"endDate":{"type":"string","nullable":true,"description":"Quando a assinatura termina; `null` = nunca."},"exactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que é cobrada; `null` quando não é fixo."},"autoRenew":{"type":"boolean","description":"Se a assinatura se renova sozinha no fim de cada período (`false` depois de um cancelamento no fim do período)."},"frequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança: `daily`, `weekly`, `monthly` ou `yearly`."},"freeTrialDays":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"frequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo."}},"description":"Periodicidade da cobrança e endereço do pagador.","additionalProperties":false},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","description":"URL que recebe os webhooks desta assinatura."}},"description":"Webhook próprio; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"customer":{"type":"object","required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","additionalEmails","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do cliente (`cus_…`)."},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail."},"gender":{"type":"string","nullable":true,"description":"Gênero; `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento."},"number":{"type":"string","nullable":true,"description":"Número do documento."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do cliente."}},"description":"O comprador.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"number","description":"O desconto."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado; `null` quando não há.","additionalProperties":false},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shipping":{"type":"object","nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há.","additionalProperties":{}},"spplited":{"type":"boolean","description":"Se as cobranças dos ciclos são divididas com outras contas (ver `splits`). O nome mantém a grafia histórica."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a assinatura tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando a assinatura foi encerrada; `null` enquanto está viva."},"geolocation":{"type":"object","nullable":true,"description":"Sinais de dispositivo e localização do comprador, como enviados; `null` quando não há.","additionalProperties":{}},"cancellation":{"type":"object","nullable":true,"required":["reasonCode","reason","canceledBy"],"properties":{"reason":{"type":"string","nullable":true,"description":"O texto livre escrito por quem cancelou."},"canceledBy":{"enum":["seller","customer","platform"],"type":"string","nullable":true,"description":"`seller` (API ou painel), `customer` (portal) ou `platform` (régua de cobrança, chargeback, estorno)."},"reasonCode":{"enum":["price","not_using","technical_issue","switched_provider","other"],"type":"string","nullable":true,"description":"O motivo da lista; `null` nos cancelamentos antigos e nos da própria plataforma."}},"description":"Por que foi cancelada; `null` enquanto ninguém pediu o cancelamento.","additionalProperties":false},"currentCycle":{"type":"object","nullable":true,"required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"description":"O ciclo de cobrança atual; `null` quando não há.","additionalProperties":false},"pixAutomatic":{"type":"object","nullable":true,"required":["status","journey","qrCodeEmv","qrCodeUrl","valueCents","firstChargeDate","approvedAt","endReason"],"properties":{"status":{"enum":["pending","awaitingAuthorization","active","rejected","ended"],"type":"string","description":"`pending` (sendo criado) · `awaitingAuthorization` (QR code exibido) · `active` (debitado a cada ciclo) · `rejected` (o pagador recusou ou revogou) · `ended`. Depois de `rejected`/`ended` os ciclos são cobrados por um QR code cada."},"journey":{"enum":["paymentOnApproval","onlyRecurrency"],"type":"string","description":"`paymentOnApproval`: o primeiro ciclo é pago junto com a autorização; `onlyRecurrency`: só a recorrência é autorizada."},"endReason":{"type":"string","nullable":true,"description":"Por que terminou; `null` enquanto ativo."},"qrCodeEmv":{"type":"string","nullable":true,"description":"O QR code de autorização (copia e cola) — só enquanto `awaitingAuthorization`."},"qrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code de autorização — só enquanto `awaitingAuthorization`."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o pagador autorizou; `null` até lá."},"valueCents":{"type":"integer","description":"O valor fixo debitado a cada ciclo, em centavos."},"firstChargeDate":{"type":"string","description":"Data do primeiro débito."}},"description":"Só na leitura individual; `null` quando a assinatura não é paga por Pix Automático.","additionalProperties":false},"renewalTerms":{"type":"object","nullable":true,"required":["shipping","shippingAmount","methodDiscount","discountMethod","discountPercentage"],"properties":{"shipping":{"type":"boolean","description":"Se o frete é cobrado em cada renovação."},"discountMethod":{"enum":["credit","pix","billet"],"type":"string","nullable":true,"description":"O meio que concedeu o desconto no checkout; `null` quando nenhum."},"methodDiscount":{"type":"boolean","description":"Se o desconto do meio de pagamento vale nas renovações cobradas por `discountMethod`."},"shippingAmount":{"type":"integer","description":"O frete cotado no checkout, em centavos (0 = sem frete)."},"discountPercentage":{"type":"number","description":"O desconto desse meio, como percentual (ex.: 5 = 5%)."}},"description":"O que cada renovação cobra além dos itens, congelado na criação; `null` = nada congelado (as renovações cobram itens menos cupons).","additionalProperties":false},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da assinatura; `null` quando não há."}},"additionalProperties":false},"examples":{"trialing":{"value":{"id":"subs_0a1b2c3d4e5f60718293","type":"recurring","items":[{"id":"sit_0a1b2c3d4e5f60718293","name":"Plano Pro","images":null,"enabled":true,"currency":"BRL","metadata":null,"quantity":1,"createdAt":"2026-01-15T12:00:00.000Z","unitPrice":4990,"updatedAt":"2026-01-15T12:00:00.000Z","description":null,"pricingSchema":"unit","externalReference":null}],"_links":{"self":{"href":"https://api.selectwin.io/v1/subscriptions/subs_…","method":"GET"}},"method":"credit","splits":null,"status":"trialing","billing":{"address":{"city":null,"line":null,"line1":null,"line2":null,"line3":null,"state":null,"number":null,"street":null,"country":null,"district":null,"postcode":null,"complement":null,"fingerprint":null},"endDate":null,"exactDay":null,"frequency":"monthly","freeTrialDays":7,"frequencyCount":1},"callback":null,"currency":"BRL","customer":{"id":"cus_0a1b2c3d4e5f60718293","email":"maria@example.com","gender":null,"document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","metadata":null,"available":true,"birthdate":null,"createdAt":"2026-01-15T12:00:00.000Z","firstName":"Maria","telephone":{"line":"+5511999999999","number":"999999999","areaCode":"11","countryCode":"55"},"updatedAt":"2026-01-15T12:00:00.000Z","delinquent":false,"additionalEmails":null,"externalReference":null},"discount":null,"merchant":{"name":"Acme Ltda","merchantId":"bus_0a1b2c3d4e5f60718293","isSubAccount":false},"metadata":null,"shipping":null,"spplited":false,"createdAt":"2026-01-15T12:00:00.000Z","discounts":null,"shippable":false,"updatedAt":"2026-01-15T12:00:00.000Z","geolocation":null,"currentCycle":{"id":"scy_0a1b2c3d4e5f60718293","cycle":1,"status":"scheduled","dueDate":"2026-01-22T12:00:00.000Z","endDate":null,"billedAt":null,"createdAt":"2026-01-15T12:00:00.000Z","startDate":"2026-01-15T12:00:00.000Z","updatedAt":"2026-01-15T12:00:00.000Z"},"externalReference":null}}}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"description":"Cria uma assinatura\n\n**Só pelo catálogo (Selectwin-strict):** o modelo de preço/cobrança vem da variante do produto, nunca do pedido — a variante precisa ter `pricingType=recurring` (senão `422`). Assinaturas medidas/por faixa usam o mesmo formato de pedido; o comportamento vem da variante. Uma assinatura com `freeTrial` nasce `trialing` e NÃO é cobrada até o fim do período de teste.","operationId":"createSubscription","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["customer","items","payment"],"properties":{"name":{"type":"string","maxLength":255,"description":"Nome da assinatura, para a sua referência."},"items":{"type":"array","items":{"type":"object","required":["variantId"],"properties":{"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"quantity":{"type":"integer","default":1,"maximum":999999,"minimum":1,"description":"Quantidade."},"variantId":{"type":"string","pattern":"^(var|prv)_.+$","description":"Uma variante recorrente do seu catálogo — o preço e a periodicidade vêm dela."},"description":{"type":"string","maxLength":2048,"description":"A sua nota sobre o item (não muda o preço)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador do item."}},"description":"Um item, de uma variante recorrente do seu catálogo.","additionalProperties":false},"maxItems":20,"minItems":1,"description":"Os itens (1 a 20), cada um de uma variante recorrente."},"splits":{"type":"array","items":{"type":"object","required":["recipient","type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","maximum":999999.99,"minimum":0,"description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"recipient":{"type":"string","pattern":"^.+_.+$","description":"A conta que recebe a fatia (`bus_…`)."}},"additionalProperties":false},"maxItems":20,"description":"Splits de cada cobrança de ciclo (até 20)."},"billing":{"type":"object","default":{},"properties":{"address":{"type":"object","properties":{"id":{"type":"string","pattern":"^.+_.+$","description":"Um endereço salvo do comprador."},"city":{"type":"string","maxLength":100,"description":"Cidade."},"state":{"type":"string","maxLength":100,"description":"Estado (sigla de duas letras, ex.: `SP`)."},"number":{"type":"string","maxLength":100,"description":"Número."},"street":{"type":"string","maxLength":255,"description":"Logradouro."},"country":{"type":"string","maxLength":3,"minLength":2,"description":"Código do país (ISO 3166-1, ex.: `BR`)."},"district":{"type":"string","maxLength":100,"description":"Bairro."},"postcode":{"type":"string","pattern":"^\\d{5}-?\\d{3}$","description":"CEP, 8 dígitos — o hífen é aceito."},"complement":{"type":"string","maxLength":255,"description":"Complemento (apartamento, sala, bloco…)."}},"description":"Endereço do pagador: um endereço salvo (`id`) ou os campos inline (`postcode`, `street` e `number` pelo menos). Obrigatório no boleto; guardado como retrato nos outros meios.","additionalProperties":false},"endDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Quando a assinatura termina (`YYYY-MM-DD`); padrão nunca."},"exactDay":{"type":"integer","maximum":31,"minimum":1,"description":"Cobrar neste dia do mês."},"freeTrial":{"type":"object","required":["enabled","days"],"properties":{"days":{"type":"integer","maximum":365,"minimum":1,"description":"Duração do teste, em dias."},"enabled":{"type":"boolean","description":"Se há período de teste."}},"description":"Período de teste: a assinatura nasce `trialing` e nada é cobrado até o teste acabar.","additionalProperties":false},"frequency":{"enum":["daily","weekly","monthly","yearly"],"type":"string","default":"monthly","description":"Unidade do intervalo de cobrança."},"startDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Quando a assinatura começa (`YYYY-MM-DD`); padrão hoje."},"frequencyCount":{"type":"integer","default":1,"maximum":365,"minimum":1,"description":"Quantas unidades por ciclo (ex.: `monthly` × 3 = trimestral)."}},"description":"Periodicidade da cobrança e endereço do pagador. O valor recorrente nunca fica aqui: vem das variantes do catálogo.","additionalProperties":false},"endDate":{"description":"Não é mais aceito na raiz: mande dentro do bloco `billing` (uma requisição com ele aqui é recusada)."},"payment":{"type":"object","properties":{"pix":{"type":"object","properties":{"automatic":{"type":"boolean","description":"Pix Automático: o pagador autoriza uma vez (um QR code) e cada ciclo é debitado — sem QR por ciclo. Só valor fixo."},"expiresInMinutes":{"type":"integer","maximum":525600,"minimum":15,"description":"Por quanto tempo o QR code de cada ciclo fica pagável, em minutos."}},"description":"Opções do Pix.","additionalProperties":false},"card":{"type":"object","properties":{"id":{"type":"string","pattern":"^(card)_.+$","description":"Um cartão salvo do cliente."},"token":{"type":"string","pattern":"^[A-Za-z0-9_.:-]+$","maxLength":128,"minLength":8,"description":"Token de cartão de uso único emitido no navegador do comprador por `POST /v1/tokenization/tokens` (válido por uma hora)."},"numbering":{"type":"string","description":"Número do cartão (PAN), só dígitos — espaços e traços são removidos. Tokenizado ao chegar, nunca guardado."},"holderName":{"type":"string","maxLength":255,"minLength":3,"description":"Nome impresso no cartão (só no cartão inline)."},"securityCode":{"type":"string","pattern":"^\\d{3,4}$","description":"Código de segurança do cartão (CVV/CVC), 3 ou 4 dígitos."},"expirationYear":{"allOf":[{"type":"integer","minimum":0},{"type":"integer","maximum":2100,"minimum":2026}],"description":"Ano de validade, 4 dígitos — 2 dígitos são aceitos (só no cartão inline)."},"expirationMonth":{"type":"integer","maximum":12,"minimum":1,"description":"Mês de validade, 1 a 12 (só no cartão inline)."}},"description":"O cartão de uma cobrança no crédito: um cartão salvo (`id`), um token emitido no navegador do comprador (`token`), ou o cartão completo inline. O cartão inline é tokenizado antes da cobrança e nunca guardado.","additionalProperties":false},"billet":{"type":"object","properties":{"expiresInDays":{"type":"integer","maximum":365,"minimum":1,"description":"Dias até o vencimento do boleto de cada ciclo."}},"description":"Opções do boleto.","additionalProperties":false},"method":{"enum":["credit","pix","billet"],"type":"string","default":"credit","description":"`credit` cobra o cartão salvo a cada ciclo; `pix` e `billet` emitem um QR code / boleto novo a cada ciclo para o comprador pagar."},"installments":{"type":"integer","default":1,"maximum":21,"minimum":1,"description":"Parcelas de cada cobrança de ciclo (só cartão)."}},"description":"Como cada ciclo é cobrado.\n\n**Regra:** Com `method=credit`, `card` é **obrigatório** (`card.id` de um cartão salvo, ou cartão completo inline: holderName, expirationMonth, expirationYear, numbering, securityCode).","additionalProperties":false},"callback":{"type":"object","required":["webhookUrl"],"properties":{"active":{"type":"boolean","default":true,"description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","format":"uri","description":"URL que recebe os webhooks desta assinatura."}},"description":"Webhook só desta assinatura.","additionalProperties":false},"customer":{"type":"object","properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Um cliente salvo. Sem ele, o comprador é encontrado ou criado pelos campos inline."},"email":{"type":"string","format":"email","description":"Endereço de e-mail (obrigatório para criar o comprador inline)."},"gender":{"enum":["male","female","other"],"type":"string","description":"Gênero: `male`, `female` ou `other`."},"document":{"type":"object","required":["type","number"],"properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","description":"Tipo do documento: `cpf`, `cnpj` ou `passport`."},"number":{"type":"string","maxLength":20,"minLength":1,"description":"Número do documento: dígitos do CPF ou CNPJ, ou o número do passaporte."}},"description":"Documento do comprador.","additionalProperties":false},"fullName":{"type":"string","maxLength":255,"minLength":1,"description":"Nome completo, como alternativa a nome + sobrenome."},"lastName":{"type":"string","maxLength":255,"minLength":1,"description":"Sobrenome (obrigatório para criar o comprador inline)."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"birthdate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data de nascimento, `YYYY-MM-DD`."},"firstName":{"type":"string","maxLength":255,"minLength":2,"description":"Nome (obrigatório para criar o comprador inline)."},"telephone":{"type":"object","properties":{"line":{"type":"string","pattern":"^\\d+$","description":"O número inteiro com código do país e DDD (ex.: `5511987654321`) — o único telefone que chega ao provedor de pagamento (boleto, 3DS)."},"number":{"type":"string","pattern":"^\\d+$","description":"Número local, só dígitos."},"areaCode":{"type":"string","pattern":"^\\d+$","description":"DDD (ex.: `11`)."},"countryCode":{"type":"string","pattern":"^\\d+$","description":"Código do país (ex.: `55`)."}},"description":"Telefone do comprador, em partes; `line` é o número inteiro.","additionalProperties":false},"additionalEmails":{"type":"array","items":{"type":"string","format":"email","description":"Endereço de e-mail (normalizado em minúsculas)."},"maxItems":20,"description":"Outros e-mails do comprador (até 20)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador do comprador."}},"description":"O comprador: um cliente salvo (`id`), ou os dados inline (`firstName`, `lastName` e `email`), que é encontrado ou criado.\n\n**Regra:** Obrigatório informar `id` (cliente salvo) **OU** os dados inline `firstName` + `lastName` + `email` (a API faz find-or-create). Enviar `customer: {}` é rejeitado.","additionalProperties":false},"exactDay":{"description":"Não é mais aceito na raiz: mande dentro do bloco `billing` (uma requisição com ele aqui é recusada)."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"shipping":{"type":"object","description":"Retrato do frete (JSON livre), guardado e devolvido como veio.","additionalProperties":{}},"autoRenew":{"type":"boolean","description":"Se a assinatura se renova sozinha no fim de cada período (padrão `true`)."},"discounts":{"type":"array","items":{"type":"object","required":["code"],"properties":{"code":{"type":"string","maxLength":50,"minLength":1,"description":"Um código de cupom do seu catálogo."}},"additionalProperties":false},"maxItems":20,"description":"Códigos de cupom (até 20): um cupom `recurring` é reaplicado a cada ciclo; um `firstCharge`, só no primeiro."},"freeTrial":{"description":"Não é mais aceito na raiz: mande dentro do bloco `billing` (uma requisição com ele aqui é recusada)."},"frequency":{"description":"Não é mais aceito na raiz: mande dentro do bloco `billing` (uma requisição com ele aqui é recusada)."},"sessionId":{"type":"string","maxLength":255,"description":"A sessão de checkout de que a assinatura veio, se houver."},"startDate":{"description":"Não é mais aceito na raiz: mande dentro do bloco `billing` (uma requisição com ele aqui é recusada)."},"onBehalfOf":{"type":"string","pattern":"^.+_.+$","description":"Marketplace: criar a assinatura NA sub-conta sua indicada — ela passa a ser a vendedora de registro e a sua taxa de plataforma é recolhida em cada ciclo."},"description":{"type":"string","maxLength":255,"description":"Descrição."},"geolocation":{"type":"object","description":"Sinais de dispositivo e localização do comprador (JSON livre), para a análise de fraude.","additionalProperties":{}},"integrationId":{"type":"string","maxLength":255,"description":"A integração de que a assinatura veio, se houver."},"frequencyCount":{"description":"Não é mais aceito na raiz: mande dentro do bloco `billing` (uma requisição com ele aqui é recusada)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador da assinatura, devolvido como veio."}},"additionalProperties":false},"examples":{"freeTrial":{"value":{"items":[{"quantity":1,"variantId":"var_0a1b2c3d4e5f60718293"}],"payment":{"card":{"id":"card_0a1b2c3d4e5f60718293"},"method":"credit"},"customer":{"id":"cus_0a1b2c3d4e5f60718293"},"freeTrial":{"days":7,"enabled":true}}},"recurringCard":{"value":{"items":[{"quantity":1,"variantId":"var_0a1b2c3d4e5f60718293"}],"payment":{"card":{"id":"card_0a1b2c3d4e5f60718293"},"method":"credit","installments":1},"customer":{"id":"cus_0a1b2c3d4e5f60718293"}}},"annualWithCoupon":{"value":{"items":[{"quantity":1,"variantId":"var_0a1b2c3d4e5f60718293"}],"coupon":{"code":"BLACKFRIDAY"},"payment":{"card":{"id":"card_0a1b2c3d4e5f60718293"},"method":"credit"},"customer":{"id":"cus_0a1b2c3d4e5f60718293"},"frequency":"yearly","frequencyCount":1}}}}},"required":true}}},"/v1/webhooks/{id}":{"get":{"tags":["Webhooks"],"summary":"Consulta um endpoint de webhook","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","endpoint","enabled","disabledReason","disabledAt","disabledCanceledDispatches","events","forceActive","shotsQty","failedShotsQty","lastDeliveryAt","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(wbe|wbh)_.+$","description":"Identificador público (wbe_/wbh_…)"},"name":{"type":"string","description":"Nome do endpoint."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"events":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Os tipos de evento entregues; `null` com `forceActive`."},"enabled":{"type":"boolean","description":"Se o endpoint recebe entregas."},"endpoint":{"type":"string","description":"A URL que recebe os eventos."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shotsQty":{"type":"integer","description":"Total de entregas tentadas."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"disabledAt":{"type":"string","nullable":true,"description":"Quando foi desativado; `null` enquanto ativo."},"forceActive":{"type":"boolean","description":"Se todos os tipos de evento são entregues."},"disabledReason":{"enum":["seller","circuitBreaker","staff"],"type":"string","nullable":true,"description":"Quem desativou: `seller` (você), `circuitBreaker` (a proteção automática, depois de falhas seguidas) ou `staff`; `null` enquanto ativo."},"failedShotsQty":{"type":"integer","description":"Entregas que falharam."},"lastDeliveryAt":{"type":"string","nullable":true,"description":"Quando a última entrega foi feita; `null` quando não houve."},"disabledCanceledDispatches":{"type":"integer","nullable":true,"description":"Quantas entregas pendentes a desativação cancelou; `null` quando você mesmo desativou."}},"additionalProperties":false},"example":{"id":"wbe_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"events":["string"],"enabled":true,"endpoint":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shotsQty":0,"createdAt":"string","updatedAt":"string","disabledAt":"string","forceActive":true,"disabledReason":"seller","failedShotsQty":0,"lastDeliveryAt":"string","disabledCanceledDispatches":0}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","pattern":"^(wbe|wbh)_.+$"},"required":true,"description":"Identificador público (wbe_/wbh_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getWebhookEndpoint"},"put":{"tags":["Webhooks"],"summary":"Atualiza um endpoint de webhook","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","endpoint","enabled","disabledReason","disabledAt","disabledCanceledDispatches","events","forceActive","shotsQty","failedShotsQty","lastDeliveryAt","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(wbe|wbh)_.+$","description":"Identificador público (wbe_/wbh_…)"},"name":{"type":"string","description":"Nome do endpoint."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"events":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Os tipos de evento entregues; `null` com `forceActive`."},"enabled":{"type":"boolean","description":"Se o endpoint recebe entregas."},"endpoint":{"type":"string","description":"A URL que recebe os eventos."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shotsQty":{"type":"integer","description":"Total de entregas tentadas."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"disabledAt":{"type":"string","nullable":true,"description":"Quando foi desativado; `null` enquanto ativo."},"forceActive":{"type":"boolean","description":"Se todos os tipos de evento são entregues."},"disabledReason":{"enum":["seller","circuitBreaker","staff"],"type":"string","nullable":true,"description":"Quem desativou: `seller` (você), `circuitBreaker` (a proteção automática, depois de falhas seguidas) ou `staff`; `null` enquanto ativo."},"failedShotsQty":{"type":"integer","description":"Entregas que falharam."},"lastDeliveryAt":{"type":"string","nullable":true,"description":"Quando a última entrega foi feita; `null` quando não houve."},"disabledCanceledDispatches":{"type":"integer","nullable":true,"description":"Quantas entregas pendentes a desativação cancelou; `null` quando você mesmo desativou."}},"additionalProperties":false},"example":{"id":"wbe_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"events":["string"],"enabled":true,"endpoint":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shotsQty":0,"createdAt":"string","updatedAt":"string","disabledAt":"string","forceActive":true,"disabledReason":"seller","failedShotsQty":0,"lastDeliveryAt":"string","disabledCanceledDispatches":0}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","pattern":"^(wbe|wbh)_.+$"},"required":true,"description":"Identificador público (wbe_/wbh_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateWebhookEndpoint","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"minLength":1,"description":"Nome do endpoint, para a sua referência."},"events":{"type":"array","items":{"enum":["transaction.created","transaction.pending","transaction.failed","transaction.approved","transaction.canceled","transaction.chargeback","transaction.refunded","transaction.fraud-review","transaction.pre-authorized","transaction.unauthorized","transaction.awaiting","transaction.dispute","customer.created","customer.updated","customer.deleted","customer.address.created","customer.address.updated","customer.address.deleted","card.created","card.updated","card.deleted","card.expired","subscription.created","subscription.pending","subscription.active","subscription.canceled","subscription.pastdue","subscription.unpaid","subscription.trialing","subscription.paused","subscription.updated","receivable.created","receivable.pending","receivable.paid","receivable.canceled","receivable.chargeback","receivable.refunded","receivable.dispute","receivable.scheduled","receivable.fraud-hold","wallet.created","wallet.deleted","wallet.pending","wallet.disabled","wallet.enabled","seller.created","seller.updated","seller.analyzing","seller.approved","seller.refused","seller.blocked","seller.disabled","seller.reinstated","seller.kycRequired","withdrawal.created","withdrawal.pending","withdrawal.confirmed","withdrawal.canceled","withdrawal.refused","withdrawal.processing","withdrawal.analysis","webhook.created","webhook.updated","webhook.deleted","webhook.disabled","checkout.session.created","checkout.session.updated","checkout.session.abandoned","checkout.session.recovered","checkout.session.reactivated","checkout.session.expired","checkout.session.completed","product.created","product.updated","product.deleted","variant.created","variant.updated","variant.deleted","coupon.created","coupon.updated","coupon.disabled","anticipation.requested","anticipation.executed","anticipation.rejected","anticipation.canceled","webhook.ping"],"type":"string"},"maxItems":200,"description":"Os tipos de evento a entregar (ver `GET /v1/utils/types-of-webhooks`). Obrigatório sem `forceActive`."},"enabled":{"type":"boolean","description":"Se o endpoint recebe entregas."},"endpoint":{"type":"string","format":"uri","description":"A URL `https://` que recebe os eventos."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"forceActive":{"type":"boolean","description":"Entregar TODOS os tipos de evento, os de agora e os futuros, no lugar da lista `events`."},"headerAuthorization":{"type":"string","maxLength":1000,"description":"Valor enviado no cabeçalho `Authorization` de cada entrega."},"headerAuthorizationType":{"type":"string","maxLength":50,"description":"Esquema do cabeçalho `Authorization` (ex.: `Bearer`)."}},"additionalProperties":false},"example":{"name":"Acme Ltda","events":["transaction.created"],"enabled":true,"endpoint":"https://example.com","metadata":{},"forceActive":true,"headerAuthorization":"string","headerAuthorizationType":"string"}}},"required":true}},"delete":{"tags":["Webhooks"],"summary":"Exclui um endpoint de webhook","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","description":"Id público do recurso excluído."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"resource":{"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"string","_links":{},"deleted":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"resource":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","pattern":"^(wbe|wbh)_.+$"},"required":true,"description":"Identificador público (wbe_/wbh_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteWebhookEndpoint"}},"/v1/cards/{cardId}":{"get":{"tags":["Cards"],"summary":"Consulta um cartão","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","holderName","brand","firstDigits","lastDigits","expirationMonth","expirationYear","primary","active","valid","verified","associated","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(card)_.+$","description":"Identificador público (card_…)"},"brand":{"type":"string","description":"Bandeira do cartão (ex.: `visa`, `mastercard`)."},"valid":{"type":"boolean","description":"Se o cartão passou na validação."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"active":{"type":"boolean","description":"Se o cartão pode ser cobrado."},"primary":{"type":"boolean","description":"Se é o cartão principal do cliente."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"verified":{"type":"boolean","description":"Se o cartão foi verificado com o emissor."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"associated":{"type":"boolean","nullable":true,"description":"Se o cartão está vinculado ao cliente para cobrança. `null` = pendente: o cartão entrou por uma tela do comprador e ainda não tem cobrança aprovada."},"holderName":{"type":"string","nullable":true,"description":"Nome impresso no cartão."},"lastDigits":{"type":"string","description":"Quatro últimos dígitos do cartão."},"firstDigits":{"type":"string","description":"Seis primeiros dígitos do cartão (BIN)."},"expirationYear":{"type":"string","description":"Ano de validade (`YYYY`)."},"expirationMonth":{"type":"string","description":"Mês de validade (`MM`)."}},"additionalProperties":false},"example":{"id":"card_0a1b2c3d4e5f60718293","brand":"string","valid":true,"_links":{},"active":true,"primary":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"verified":true,"createdAt":"string","updatedAt":"string","associated":true,"holderName":"JOAO SILVA","lastDigits":"string","firstDigits":"string","expirationYear":"string","expirationMonth":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"cardId","schema":{"type":"string","pattern":"^(card)_.+$"},"required":true,"description":"Identificador público (card_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getCard"},"delete":{"tags":["Cards"],"summary":"Exclui um cartão","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","description":"Id público do recurso excluído."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"resource":{"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"string","_links":{},"deleted":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"resource":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"cardId","schema":{"type":"string","pattern":"^(card)_.+$"},"required":true,"description":"Identificador público (card_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteCard"}},"/v1/public/pricing":{"get":{"tags":["Pricing"],"summary":"Tabela pública de preços: os planos ativos de cada produto da Selectwin (sem autenticação)","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["object","currency","effectiveAt","products","fees"],"properties":{"fees":{"enum":["null"],"nullable":true,"description":"A tabela pública de taxas ainda não existe: sempre null por ora — a taxa vale a da conta."},"object":{"enum":["publicPricing"],"type":"string","description":"Sempre `publicPricing`."},"currency":{"enum":["BRL"],"type":"string","description":"Sempre `BRL`."},"products":{"type":"array","items":{"type":"object","required":["code","name","kind","plans"],"properties":{"code":{"type":"string","description":"Código do produto (identificador estável)."},"kind":{"enum":["insights","members-area","integration-app","custom-domain","bundle"],"type":"string","description":"Tipo do produto."},"name":{"type":"string","description":"Nome do produto."},"plans":{"type":"array","items":{"type":"object","required":["code","name","description","isDefault","priceCents","interval","trialDays","meters","features","items"],"properties":{"code":{"type":"string","description":"Código do plano (identificador estável)."},"name":{"type":"string","description":"Nome do plano."},"items":{"type":"array","items":{"type":"object","required":["product","plan","meters"],"properties":{"plan":{"type":"object","required":["code","name"],"properties":{"code":{"type":"string","description":"Código do plano."},"name":{"type":"string","description":"Nome do plano."}},"description":"O plano desse produto que o pacote inclui.","additionalProperties":false},"meters":{"type":"array","items":{"type":"object","required":["code","label","unit","includedUnits","overagePolicy","overageUnitPriceCents","overageBlockSize"],"properties":{"code":{"type":"string","description":"records (Lince) · storage, bandwidth (Club, em bytes) · dispatches (apps) · sms (SmartOps - SMS) · domains (domínio próprio)."},"unit":{"enum":["count","bytes"],"type":"string","description":"Unidade do medidor: `count` ou `bytes`."},"label":{"type":"string","description":"Nome de exibição do medidor."},"includedUnits":{"type":"integer","nullable":true,"description":"Franquia do mês; null = sem franquia."},"overagePolicy":{"enum":["block","charge"],"type":"string","description":"block = o produto para na franquia · charge = cobra cada bloco acima dela."},"overageBlockSize":{"type":"integer","nullable":true,"description":"Tamanho do bloco, na unidade do medidor."},"overageUnitPriceCents":{"type":"integer","nullable":true,"description":"Preço de UM bloco excedente, em centavos."}},"additionalProperties":false},"description":"Os medidores desse plano."},"product":{"type":"object","required":["code","name","kind"],"properties":{"code":{"type":"string","description":"Código do produto."},"kind":{"enum":["insights","members-area","integration-app","custom-domain","bundle"],"type":"string","description":"Tipo do produto."},"name":{"type":"string","description":"Nome do produto."}},"description":"O produto ao qual o plano do pacote pertence.","additionalProperties":false}},"additionalProperties":false},"description":"Pacote: um plano de cada produto que ele cobre. Vazio nos outros planos."},"meters":{"type":"array","items":{"type":"object","required":["code","label","unit","includedUnits","overagePolicy","overageUnitPriceCents","overageBlockSize"],"properties":{"code":{"type":"string","description":"records (Lince) · storage, bandwidth (Club, em bytes) · dispatches (apps) · sms (SmartOps - SMS) · domains (domínio próprio)."},"unit":{"enum":["count","bytes"],"type":"string","description":"Unidade do medidor: `count` ou `bytes`."},"label":{"type":"string","description":"Nome de exibição do medidor."},"includedUnits":{"type":"integer","nullable":true,"description":"Franquia do mês; null = sem franquia."},"overagePolicy":{"enum":["block","charge"],"type":"string","description":"block = o produto para na franquia · charge = cobra cada bloco acima dela."},"overageBlockSize":{"type":"integer","nullable":true,"description":"Tamanho do bloco, na unidade do medidor."},"overageUnitPriceCents":{"type":"integer","nullable":true,"description":"Preço de UM bloco excedente, em centavos."}},"additionalProperties":false},"description":"O que se conta no mês e a franquia de cada um. Medidor ausente = sem franquia."},"features":{"type":"object","description":"Só as chaves tier, maxUploadBytes, maxVideoDurationSec, dailyDispatchQuota.","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]}},"interval":{"enum":["month"],"type":"string","description":"Sempre `month`."},"isDefault":{"type":"boolean","description":"O plano INICIAL do produto: toda conta entra nele no cadastro."},"trialDays":{"type":"integer","description":"Teste grátis, em dias; `0` quando não há."},"priceCents":{"type":"integer","description":"Mensalidade, em centavos."},"description":{"type":"string","nullable":true,"description":"Descrição do plano; `null` quando não há."}},"additionalProperties":false},"description":"Os planos do produto."}},"additionalProperties":false},"description":"Os produtos à venda, cada um com seus planos."},"effectiveAt":{"type":"string","nullable":true,"description":"A última mudança do que esta resposta serve (maior updatedAt entre os produtos e planos servidos)."}},"additionalProperties":false},"example":{"fees":"null","object":"publicPricing","currency":"BRL","products":[{"code":"string","kind":"insights","name":"Acme Ltda","plans":[{"code":"string","name":"Acme Ltda","items":[{"plan":{"code":"string","name":"Acme Ltda"},"meters":[{}],"product":{"code":"string","kind":"insights","name":"Acme Ltda"}}],"meters":[{"code":"string","unit":"count","label":"string","includedUnits":0,"overagePolicy":"block","overageBlockSize":0,"overageUnitPriceCents":5000}],"features":{},"interval":"month","isDefault":true,"trialDays":0,"priceCents":5000,"description":"string"}]}],"effectiveAt":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"429":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Limite de requisições excedido"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"product","schema":{"type":"string","pattern":"^[a-z0-9-]{1,40}$"},"required":false,"description":"Só um produto, pelo código (ex.: members-area)."}],"operationId":"getPublicPricing"}},"/v1/utils/metadata":{"get":{"tags":["Utils"],"summary":"Capacidades da API (moedas, meios de pagamento, tipos de documento)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["apiVersion","currencies","paymentMethods","documentTypes","companyDocumentTypes","companyDocumentTypesByInvite"],"properties":{"apiVersion":{"type":"string","description":"Versão da API."},"currencies":{"type":"array","items":{"type":"string"},"description":"Moedas aceitas."},"documentTypes":{"type":"array","items":{"type":"string"},"description":"Tipos de documento aceitos para compradores (`cpf`, `cnpj`, `passport`)."},"paymentMethods":{"type":"array","items":{"type":"string"},"description":"Meios de pagamento aceitos."},"companyDocumentTypes":{"type":"array","items":{"type":"string"},"description":"Tipos de documento com que uma empresa pode se cadastrar no fluxo aberto."},"companyDocumentTypesByInvite":{"type":"array","items":{"type":"string"},"description":"Tipos de documento que exigem código de convite para o cadastro."}},"description":"Os conjuntos de valores que a API aceita.","additionalProperties":false}},"additionalProperties":false},"example":{"data":{"apiVersion":"string","currencies":["string"],"documentTypes":["string"],"paymentMethods":["string"],"companyDocumentTypes":["string"],"companyDocumentTypesByInvite":["string"]}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"utilsMetadata"}},"/v1/balance/history":{"get":{"tags":["Finance"],"summary":"Lista os movimentos do saldo","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","fromType","toType","processedAmount","oldBalance","newBalance","handledBy","type","description","amount","direction","availableAfter","category","note","source","createdAt"],"properties":{"id":{"type":"integer","description":"Id sequencial do movimento."},"note":{"type":"string","nullable":true,"description":"Texto escrito para você num ajuste manual, ou a descrição da fatura paga com o saldo; `null` nos demais."},"type":{"type":"string","description":"O que o movimento foi, como slug estável (`receivableReleased`, `withdrawal`, `chargebackFee`…) — o campo para tratar no seu sistema."},"amount":{"type":"integer","nullable":true,"description":"Efeito no saldo DISPONÍVEL, em centavos e com sinal: positivo entrou, negativo saiu, 0 não mexeu nele; `null` em movimentos antigos."},"source":{"type":"object","nullable":true,"required":["object","id"],"properties":{"id":{"type":"string","description":"Id público da origem."},"object":{"enum":["transaction","receivable","withdrawal","invoice","debtSettlement","anticipation"],"type":"string","description":"Tipo da origem (ex.: `transaction`, `withdrawal`)."}},"description":"O objeto por trás do movimento, para abrir o detalhe; `null` em movimentos sem origem registrada.","additionalProperties":false},"toType":{"type":"string","nullable":true,"description":"O balde em que o dinheiro entrou; `null` quando saiu do saldo."},"category":{"type":"string","nullable":true,"description":"Categoria de um ajuste manual feito pela Selectwin; `null` nos movimentos automáticos."},"fromType":{"type":"string","nullable":true,"description":"O balde de onde o dinheiro saiu (`available`, `pending`, `blocked`…); `null` quando veio de fora."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"direction":{"enum":["credit","debit"],"type":"string","nullable":true,"description":"`credit` entrou no saldo disponível, `debit` saiu; `null` quando `amount` é 0 ou `null`."},"handledBy":{"type":"string","nullable":true,"description":"Nome interno do que movimentou o dinheiro — prefira `type`."},"newBalance":{"type":"object","required":["availableBalance","pendingBalance","blockedBalance","refundedBalance"],"properties":{"blockedBalance":{"type":"integer","description":"O que está retido (disputas, análise de fraude, retenção da Selectwin), em centavos."},"pendingBalance":{"type":"integer","description":"O que aguarda a data de liberação, em centavos."},"refundedBalance":{"type":"integer","description":"O que foi estornado a compradores, em centavos."},"availableBalance":{"type":"integer","description":"O que você pode sacar agora, em centavos."}},"description":"O saldo depois do movimento.","additionalProperties":false},"oldBalance":{"type":"object","required":["availableBalance","pendingBalance","blockedBalance","refundedBalance"],"properties":{"blockedBalance":{"type":"integer","description":"O que está retido (disputas, análise de fraude, retenção da Selectwin), em centavos."},"pendingBalance":{"type":"integer","description":"O que aguarda a data de liberação, em centavos."},"refundedBalance":{"type":"integer","description":"O que foi estornado a compradores, em centavos."},"availableBalance":{"type":"integer","description":"O que você pode sacar agora, em centavos."}},"description":"O saldo antes do movimento.","additionalProperties":false},"description":{"type":"string","description":"O mesmo, em português, pronto para a linha do extrato."},"availableAfter":{"type":"integer","nullable":true,"description":"O saldo disponível depois deste movimento, em centavos."},"processedAmount":{"type":"integer","description":"Valor movimentado, em centavos."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":0,"note":"string","type":"string","amount":5000,"source":{"id":"string","object":"transaction"},"toType":"string","category":"string","fromType":"string","createdAt":"string","direction":"credit","handledBy":"string","newBalance":{"blockedBalance":5000,"pendingBalance":5000,"refundedBalance":5000,"availableBalance":5000},"oldBalance":{"blockedBalance":5000,"pendingBalance":5000,"refundedBalance":5000,"availableBalance":5000},"description":"string","availableAfter":0,"processedAmount":5000}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"bucket","schema":{"enum":["available"],"type":"string"},"required":false,"description":"`available`: só os movimentos que mudaram o saldo disponível (o extrato). Omita para todos os movimentos entre baldes."},{"in":"query","name":"direction","schema":{"enum":["credit","debit"],"type":"string"},"required":false,"description":"Entrada (`credit`) ou saída (`debit`) do saldo disponível. Implica `bucket=available`."},{"in":"query","name":"type","schema":{"type":"string","maxLength":600,"minLength":1},"required":false,"description":"Tipos de movimento separados por vírgula (receivableScheduled, receivableReleased, receivableChargeback, receivableDispute, receivableRefunded, receivableCanceled, receivableSettledExternally, warrantyHeld, warrantyReleased, warrantyCover, chargebackFee, chargebackFeeRefund, antifraudFee, withdrawalFee, withdrawal, withdrawalReversal, appUsageCharge, productSubscription, debtSettlement, debtSettlementRefund, receivableAnticipated, anticipationFee, adjustment, other)."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listBalanceHistory"}},"/v1/webhooks/events":{"get":{"tags":["Webhooks"],"summary":"Lista os eventos de webhook","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","type","resource","resourceId","source","delivered","attempts","createdAt"],"properties":{"id":{"type":"string","pattern":"^(wbh)_.+$","description":"Identificador público (wbh_…)"},"data":{"description":"O conteúdo do evento, como enviado à sua URL."},"type":{"type":"string","description":"Tipo do evento, no formato `recurso.acao`."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"source":{"type":"string","description":"Origem do evento na plataforma."},"attempts":{"type":"integer","description":"Tentativas de entrega feitas, somando todos os endpoints."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"resource":{"type":"string","description":"O recurso de que o evento trata (ex.: `transaction`)."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"delivered":{"type":"boolean","description":"Se todos os endpoints assinantes receberam a entrega com sucesso."},"dispatches":{"type":"array","items":{"type":"object","required":["id","eventId","eventType","endpointId","endpoint","status","attempts","responseStatusCode","responseBody","responseTime","nextAttemptAt","lastAttemptAt","successAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(wdi)_.+$","description":"Identificador público (wdi_…)"},"status":{"enum":["pending","success","failed","retrying","canceled"],"type":"string","description":"`pending`, `success`, `failed`, `retrying` ou `canceled`."},"eventId":{"type":"string","pattern":"^(wbh)_.+$","nullable":true,"description":"O evento entregue; `null` numa entrega sintética (ping de teste)."},"attempts":{"type":"integer","description":"Tentativas feitas até agora."},"endpoint":{"type":"string","description":"A URL para onde foi entregue."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"eventType":{"type":"string","nullable":true,"description":"Tipo do evento entregue (ex.: `transaction.approved`); `null` numa entrega sintética."},"successAt":{"type":"string","nullable":true,"description":"Quando a entrega deu certo; `null` até lá."},"endpointId":{"type":"string","pattern":"^(wbe|wbh)_.+$","nullable":true,"description":"O endpoint para onde foi entregue."},"responseBody":{"type":"string","nullable":true,"description":"Corpo que o seu endpoint respondeu (primeiros 8 KB); `null` quando não houve."},"responseTime":{"type":"integer","nullable":true,"description":"Quanto tempo o seu endpoint levou para responder, em milissegundos."},"lastAttemptAt":{"type":"string","nullable":true,"description":"Quando a última tentativa foi feita."},"nextAttemptAt":{"type":"string","nullable":true,"description":"Quando a próxima tentativa está marcada; `null` quando não há."},"responseStatusCode":{"type":"integer","nullable":true,"description":"Status HTTP que o seu endpoint respondeu; `null` quando não respondeu."}},"additionalProperties":false},"description":"As entregas deste evento, uma por endpoint (só na leitura individual)."},"resourceId":{"type":"string","nullable":true,"description":"Id público desse recurso."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"wbh_0a1b2c3d4e5f60718293","type":"string","_links":{},"source":"string","attempts":0,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"resource":"string","createdAt":"string","delivered":true,"dispatches":[{"id":"wdi_0a1b2c3d4e5f60718293","status":"pending","eventId":"wbh_0a1b2c3d4e5f60718293","attempts":0,"endpoint":"string","createdAt":"string","eventType":"string","successAt":"string","endpointId":"wbe_0a1b2c3d4e5f60718293","responseBody":"string","responseTime":0,"lastAttemptAt":"string","nextAttemptAt":"string","responseStatusCode":0}],"resourceId":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"type","schema":{"enum":["transaction.created","transaction.pending","transaction.failed","transaction.approved","transaction.canceled","transaction.chargeback","transaction.refunded","transaction.fraud-review","transaction.pre-authorized","transaction.unauthorized","transaction.awaiting","transaction.dispute","customer.created","customer.updated","customer.deleted","customer.address.created","customer.address.updated","customer.address.deleted","card.created","card.updated","card.deleted","card.expired","subscription.created","subscription.pending","subscription.active","subscription.canceled","subscription.pastdue","subscription.unpaid","subscription.trialing","subscription.paused","subscription.updated","receivable.created","receivable.pending","receivable.paid","receivable.canceled","receivable.chargeback","receivable.refunded","receivable.dispute","receivable.scheduled","receivable.fraud-hold","wallet.created","wallet.deleted","wallet.pending","wallet.disabled","wallet.enabled","seller.created","seller.updated","seller.analyzing","seller.approved","seller.refused","seller.blocked","seller.disabled","seller.reinstated","seller.kycRequired","withdrawal.created","withdrawal.pending","withdrawal.confirmed","withdrawal.canceled","withdrawal.refused","withdrawal.processing","withdrawal.analysis","webhook.created","webhook.updated","webhook.deleted","webhook.disabled","checkout.session.created","checkout.session.updated","checkout.session.abandoned","checkout.session.recovered","checkout.session.reactivated","checkout.session.expired","checkout.session.completed","product.created","product.updated","product.deleted","variant.created","variant.updated","variant.deleted","coupon.created","coupon.updated","coupon.disabled","anticipation.requested","anticipation.executed","anticipation.rejected","anticipation.canceled","webhook.ping"],"type":"string"},"required":false,"description":"Só eventos deste tipo."},{"in":"query","name":"resource","schema":{"type":"string","maxLength":100},"required":false,"description":"Só eventos deste recurso (ex.: `transaction`)."},{"in":"query","name":"resourceId","schema":{"type":"string","maxLength":50},"required":false,"description":"Só os eventos deste id de recurso."},{"in":"query","name":"status","schema":{"enum":["delivered","failed"],"type":"string"},"required":false,"description":"`delivered` ou `failed`."},{"in":"query","name":"eventId","schema":{"type":"string","maxLength":50},"required":false,"description":"Só este evento."},{"in":"query","name":"endpoint","schema":{"type":"string","maxLength":255},"required":false,"description":"URL (ou parte dela) de um endpoint para o qual o evento foi entregue."},{"in":"query","name":"resourceid","schema":{"type":"string","maxLength":50},"required":false,"description":"Apelido de `resourceId`."},{"in":"query","name":"eventid","schema":{"type":"string","maxLength":50},"required":false,"description":"Apelido de `eventId`."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listWebhookEvents"}},"/v1/coupons/validate":{"post":{"tags":["Coupons"],"summary":"Valida um cupom contra um carrinho (prévia do desconto)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["valid","reason","code","discount","originalAmount","chargedAmount"],"properties":{"code":{"type":"string","description":"O código do cupom."},"valid":{"type":"boolean","description":"Se o cupom vale para este carrinho."},"reason":{"type":"string","nullable":true,"description":"Por que não vale; `null` quando válido."},"discount":{"type":"object","nullable":true,"required":["type","value","percentage"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"integer","description":"O desconto, em centavos."},"percentage":{"type":"number","description":"O desconto como percentual do valor do carrinho."}},"description":"O desconto que o cupom aplicaria; `null` quando não é válido.","additionalProperties":false},"chargedAmount":{"type":"integer","nullable":true,"description":"Valor do carrinho depois do desconto (centavos)."},"originalAmount":{"type":"integer","nullable":true,"description":"Valor do carrinho antes do desconto (centavos)."}},"additionalProperties":false},"example":{"code":"string","valid":true,"reason":"string","discount":{"type":"percentage","value":5000,"percentage":0},"chargedAmount":5000,"originalAmount":5000}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"validateCoupon","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["code","amount"],"properties":{"code":{"type":"string","maxLength":50,"minLength":1,"description":"O código do cupom."},"amount":{"type":"integer","maximum":20000000,"minimum":1,"description":"Valor do carrinho em centavos, antes do desconto."},"itemIds":{"type":"array","items":{"type":"string","pattern":"^.+_.+$","description":"Identificador público (prefixo_valor)"},"maxItems":100,"description":"Ids das variantes no carrinho — para cupons restritos a itens específicos."},"itemCount":{"type":"integer","maximum":100000,"minimum":0,"description":"Número de itens no carrinho."},"customerId":{"type":"string","pattern":"^(cus)_.+$","description":"O comprador — para cupons limitados a um uso por cliente ou a clientes específicos."}},"additionalProperties":false},"example":{"code":"string","amount":5000,"itemIds":["id_0a1b2c3d4e5f60718293"],"itemCount":0,"customerId":"cus_0a1b2c3d4e5f60718293"}}},"required":true}}},"/v1/marketplace/plans":{"get":{"tags":["Marketplace"],"summary":"Lista os planos de taxas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["data","count"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","name","pix","boleto","credit","debit","withdrawalFee","createdAt"],"properties":{"id":{"type":"string","pattern":"^(rate)_.+$","description":"Identificador público (rate_…)"},"pix":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"name":{"type":"string","nullable":true,"description":"Nome do plano."},"debit":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"boleto":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"credit":{"type":"object","required":["percent","fixed","installments","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."},"installments":{"type":"array","items":{"type":"object","required":["n","percent"],"properties":{"n":{"type":"integer","description":"Número de parcelas."},"percent":{"type":"number","description":"Taxa para esse número de parcelas."}},"additionalProperties":false},"nullable":true,"description":"Taxa por número de parcelas; `null` quando o mesmo `percent` vale para todas."}},"description":"A taxa das vendas no cartão de crédito.","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"withdrawalFee":{"type":"number","nullable":true,"description":"Taxa fixa cobrada da sub-conta em cada saque, em centavos; `null` quando não há."}},"additionalProperties":false},"description":"Os seus planos de taxas."},"count":{"type":"integer","description":"Quantos planos."}},"additionalProperties":false},"example":{"data":[{"id":"rate_0a1b2c3d4e5f60718293","pix":{"fixed":0,"percent":0,"releaseDays":0},"name":"Acme Ltda","debit":{"fixed":0,"percent":0,"releaseDays":0},"boleto":{"fixed":0,"percent":0,"releaseDays":0},"credit":{"fixed":0,"percent":0,"releaseDays":0,"installments":[{"n":0,"percent":0}]},"createdAt":"string","withdrawalFee":5000}],"count":0}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"listMarketplacePlans"},"post":{"tags":["Marketplace"],"summary":"Cria um plano de taxas","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","pix","boleto","credit","debit","withdrawalFee","createdAt"],"properties":{"id":{"type":"string","pattern":"^(rate)_.+$","description":"Identificador público (rate_…)"},"pix":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"name":{"type":"string","nullable":true,"description":"Nome do plano."},"debit":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"boleto":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"credit":{"type":"object","required":["percent","fixed","installments","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."},"installments":{"type":"array","items":{"type":"object","required":["n","percent"],"properties":{"n":{"type":"integer","description":"Número de parcelas."},"percent":{"type":"number","description":"Taxa para esse número de parcelas."}},"additionalProperties":false},"nullable":true,"description":"Taxa por número de parcelas; `null` quando o mesmo `percent` vale para todas."}},"description":"A taxa das vendas no cartão de crédito.","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"withdrawalFee":{"type":"number","nullable":true,"description":"Taxa fixa cobrada da sub-conta em cada saque, em centavos; `null` quando não há."}},"additionalProperties":false},"example":{"id":"rate_0a1b2c3d4e5f60718293","pix":{"fixed":0,"percent":0,"releaseDays":0},"name":"Acme Ltda","debit":{"fixed":0,"percent":0,"releaseDays":0},"boleto":{"fixed":0,"percent":0,"releaseDays":0},"credit":{"fixed":0,"percent":0,"releaseDays":0,"installments":[{"n":0,"percent":0}]},"createdAt":"string","withdrawalFee":5000}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"createMarketplacePlan","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"pix":{"type":"object","properties":{"fixed":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa como percentual da venda (0–100)."},"releaseDays":{"type":"integer","maximum":365,"minimum":0,"description":"Dias até o dinheiro deste meio ser liberado para a sub-conta (nunca antes de você recebê-lo)."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"name":{"type":"string","maxLength":100,"minLength":1,"description":"Nome do plano."},"debit":{"type":"object","properties":{"fixed":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa como percentual da venda (0–100)."},"releaseDays":{"type":"integer","maximum":365,"minimum":0,"description":"Dias até o dinheiro deste meio ser liberado para a sub-conta (nunca antes de você recebê-lo)."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"boleto":{"type":"object","properties":{"fixed":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa como percentual da venda (0–100)."},"releaseDays":{"type":"integer","maximum":365,"minimum":0,"description":"Dias até o dinheiro deste meio ser liberado para a sub-conta (nunca antes de você recebê-lo)."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"credit":{"type":"object","properties":{"fixed":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa como percentual da venda (0–100)."},"releaseDays":{"type":"integer","maximum":365,"minimum":0,"description":"Dias até o dinheiro deste meio ser liberado para a sub-conta (nunca antes de você recebê-lo)."},"installments":{"type":"array","items":{"type":"object","required":["n","percent"],"properties":{"n":{"type":"integer","maximum":36,"minimum":1,"description":"Número de parcelas."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa para esse número de parcelas (0–100)."}},"additionalProperties":false},"maxItems":36,"description":"Taxa por número de parcelas, sobrepondo `percent`."}},"description":"A taxa das vendas no cartão de crédito, opcionalmente por número de parcelas.","additionalProperties":false},"withdrawalFee":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa cobrada da sub-conta em cada saque, em centavos."}},"additionalProperties":false},"example":{"pix":{"fixed":0,"percent":0,"releaseDays":0},"name":"Acme Ltda","debit":{"fixed":0,"percent":0,"releaseDays":0},"boleto":{"fixed":0,"percent":0,"releaseDays":0},"credit":{"fixed":0,"percent":0,"releaseDays":0,"installments":[{"n":1,"percent":0}]},"withdrawalFee":5000}}},"required":true},"x-account-level":"always"}},"/v1/checkouts/sessions":{"get":{"tags":["Checkout"],"summary":"Lista as sessões de checkout","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","id","status","source","totalAmount","online","transactionId","abandonedAt","completedAt","intentScore","abandonRiskScore","automationScore","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sess|ckts|ses)_.+$","description":"Identificador público (sess_/ckts_/ses_…)"},"object":{"enum":["checkout.session"],"type":"string","description":"Sempre `checkout.session`."},"online":{"type":"boolean","description":"Se o comprador está no checkout agora."},"source":{"type":"string","nullable":true,"description":"De onde a sessão veio; `null` quando desconhecido."},"status":{"enum":["active","completed","cancelled","abandoned","expired"],"type":"string","description":"`active` (o comprador está no checkout), `completed` (pago), `cancelled`, `abandoned` ou `expired`."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"abandonedAt":{"type":"string","nullable":true,"description":"Quando o carrinho foi abandonado; `null` quando não foi."},"completedAt":{"type":"string","nullable":true,"description":"Quando a sessão foi paga; `null` até lá."},"intentScore":{"type":"integer","nullable":true,"description":"Quão perto o comprador está de pagar (0–100), pelo último sinal; `null` sem sinais."},"totalAmount":{"type":"integer","nullable":true,"description":"Total do carrinho, em centavos; `null` quando nunca foi precificado."},"transactionId":{"type":"string","nullable":true,"description":"A cobrança que concluiu a sessão; `null` até lá."},"automationScore":{"type":"integer","nullable":true,"description":"Indício de robô/automação (0–100), pelo último sinal; `null` sem sinais."},"abandonRiskScore":{"type":"integer","nullable":true,"description":"Quão provável é a sessão se perder (0–100), pelo último sinal; `null` sem sinais."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."}},"additionalProperties":false},"example":{"data":[{"id":"sess_0a1b2c3d4e5f60718293","object":"checkout.session","online":true,"source":"string","status":"active","createdAt":"string","updatedAt":"string","abandonedAt":"string","completedAt":"string","intentScore":0,"totalAmount":5000,"transactionId":"string","automationScore":0,"abandonRiskScore":0}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"offset":0,"hasMore":true}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação: createdAt | intentScore | abandonRiskScore | abandonedAt, prefixo \"-\" = decrescente (ex.: \"-intentScore\"). Pontuações e abandonedAt ordenam com nulos por último, desempate por createdAt decrescente. Os antigos \"ascending\"/\"descending\" ordenam por createdAt."},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"abandonedrangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Limite inferior (inclusivo, instante ISO) de `abandonedAt`"},{"in":"query","name":"abandonedrangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Limite superior (inclusivo, instante ISO) de `abandonedAt`"},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(sess|ckts|ses)_.+$"},"required":false,"description":"Só esta sessão."},{"in":"query","name":"status","schema":{"enum":["active","completed","cancelled","abandoned","expired"],"type":"string"},"required":false,"description":"Só sessões com este status."},{"in":"query","name":"source","schema":{"type":"string","maxLength":20},"required":false,"description":"Só sessões desta origem."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listCheckoutSessions"},"post":{"tags":["Checkout"],"summary":"Cria uma sessão de checkout","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["object","id","url","status","ambient","source","currency","lineItems","totals","coupons","customer","address","paymentMethods","paymentSelection","redirectUrls","utm","cookies","metadata","customInputs","integrationType","integrationId","externalTransactionId","firstInitialization","online","expiresAt","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(sess|ckts|ses)_.+$","description":"Identificador público (sess_/ckts_/ses_…)"},"url":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta sessão; `null` quando não há."},"utm":{"type":"object","nullable":true,"description":"Atribuição de marketing; `null` quando não há.","additionalProperties":{}},"object":{"enum":["checkout.session"],"type":"string","description":"Sempre `checkout.session`."},"online":{"type":"boolean","description":"Se o comprador está no checkout agora (um sinal recente da página)."},"source":{"type":"string","nullable":true,"description":"De onde a sessão veio; `null` quando desconhecido."},"status":{"enum":["active","completed","cancelled","abandoned","expired"],"type":"string","description":"`active` (o comprador está no checkout), `completed` (pago), `cancelled`, `abandoned` ou `expired`."},"totals":{"type":"object","required":["amount","discount","shipping","tax"],"properties":{"tax":{"type":"integer","nullable":true,"description":"Total de impostos, em centavos."},"amount":{"type":"integer","nullable":true,"description":"Total do carrinho, em centavos; `null` quando o carrinho nunca foi precificado."},"discount":{"type":"integer","nullable":true,"description":"Total de desconto, em centavos."},"shipping":{"type":"integer","nullable":true,"description":"Total do frete, em centavos."}},"description":"Os totais do carrinho; todos `null` quando nunca foi precificado.","additionalProperties":false},"address":{"type":"object","nullable":true,"description":"O endereço, como preenchido; `null` quando ainda não há nada.","additionalProperties":{}},"ambient":{"type":"string","description":"Ambiente: `live` ou `sandbox`."},"cookies":{"type":"object","nullable":true,"description":"Cookies de rastreio do comprador, pelo nome do cookie; `null` quando não há.","additionalProperties":{}},"coupons":{"type":"array","items":{"type":"object","required":["code","type","value"],"properties":{"code":{"type":"string","nullable":true,"description":"Código do cupom."},"type":{"type":"string","nullable":true,"description":"`flat` ou `percentage`."},"value":{"type":"number","nullable":true,"description":"O valor do desconto."}},"additionalProperties":false},"description":"Cupons aplicados."},"currency":{"enum":["BRL"],"type":"string","description":"Sempre `BRL`."},"customer":{"type":"object","nullable":true,"description":"O comprador, como preenchido; `null` quando ainda não há nada.","additionalProperties":{}},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"expiresAt":{"type":"string","nullable":true,"description":"Quando a sessão expira."},"lineItems":{"type":"array","items":{"type":"object","required":["id","name","quantity","unitPrice","currency","isOrderbump","isUpsell","metadata","externalReference"],"properties":{"id":{"type":"string","nullable":true,"description":"A variante do catálogo; `null` num item avulso."},"name":{"type":"string","nullable":true,"description":"Nome do item."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"isUpsell":{"type":"boolean","description":"Se o item foi adicionado por uma oferta de upsell."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"unitPrice":{"type":"number","nullable":true,"description":"Preço unitário, em centavos; `null` quando ainda não precificado."},"isOrderbump":{"type":"boolean","description":"Se o item foi adicionado por um order bump."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"description":"Uma linha do carrinho.","additionalProperties":false},"description":"O carrinho."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"customInputs":{"enum":["null"],"nullable":true,"description":"Sempre `null`."},"redirectUrls":{"type":"object","required":["paid","refused","pending"],"properties":{"paid":{"type":"string","nullable":true,"description":"Para onde o comprador vai depois de um pedido pago."},"pending":{"type":"string","nullable":true,"description":"Para onde o comprador vai enquanto o pagamento está pendente."},"refused":{"type":"string","nullable":true,"description":"Para onde o comprador vai depois de uma recusa."}},"description":"Para onde o comprador é enviado depois do pagamento, por desfecho.","additionalProperties":false},"integrationId":{"type":"string","nullable":true,"description":"Id público dessa integração; `null` quando não há."},"paymentMethods":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"description":"Meios de pagamento oferecidos."},"integrationType":{"type":"string","nullable":true,"description":"Tipo da integração a que a sessão pertence; `null` quando não há."},"paymentSelection":{"type":"object","nullable":true,"required":["method"],"properties":{"method":{"type":"string","description":"O meio escolhido."}},"description":"O meio de pagamento que o comprador escolheu; `null` até lá.","additionalProperties":false},"firstInitialization":{"type":"boolean","description":"Se é a primeira vez que a sessão foi inicializada."},"externalTransactionId":{"type":"string","nullable":true,"description":"O id do seu pedido; `null` quando não há."}},"additionalProperties":false},"example":{"id":"sess_0a1b2c3d4e5f60718293","url":"string","utm":{},"object":"checkout.session","online":true,"source":"string","status":"active","totals":{"tax":0,"amount":5000,"discount":0,"shipping":0},"address":{},"ambient":"string","cookies":{},"coupons":[{"code":"string","type":"string","value":5000}],"currency":"BRL","customer":{},"metadata":{},"createdAt":"string","expiresAt":"string","lineItems":[{"id":"string","name":"Acme Ltda","currency":"BRL","isUpsell":true,"metadata":{},"quantity":0,"unitPrice":5000,"isOrderbump":true,"externalReference":"string"}],"updatedAt":"string","customInputs":"null","redirectUrls":{"paid":"string","pending":"string","refused":"string"},"integrationId":"string","paymentMethods":["string"],"integrationType":"string","paymentSelection":{"method":"string"},"firstInitialization":true,"externalTransactionId":"string"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createCheckoutSession","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"utm":{"type":"object","description":"Atribuição de marketing (`source`, `medium`, `campaign`, `content`, `term`). Capturada uma vez; imutável na atualização.","additionalProperties":{}},"items":{"type":"array","items":{"type":"object","additionalProperties":{}},"default":[],"description":"O carrinho: um objeto por linha (`id` da variante, `quantity`…). Validado contra o seu catálogo quando a sessão é enviada para pagamento."},"client":{"type":"object","description":"Dados do cliente, incluindo a UTM da primeira visita (JSON livre; imutável depois da primeira inicialização).","additionalProperties":{}},"source":{"type":"string","maxLength":20,"description":"De onde a sessão veio (texto livre, até 20 caracteres)."},"address":{"type":"object","description":"O endereço, como preenchido até agora (JSON livre).","additionalProperties":{}},"ambient":{"enum":["live","sandbox"],"type":"string","description":"Aceito por compatibilidade; o ambiente vem sempre da sua credencial."},"cookies":{"type":"object","description":"Cookies de rastreio do comprador, pelo nome do cookie (`_fbp`, `_fbc`, `_ga`, `gclid`…), para a atribuição dos pixels.","additionalProperties":{}},"coupons":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"description":"Cupons aplicados: códigos, ou objetos com `code`."},"customer":{"type":"object","description":"O comprador, como preenchido até agora (JSON livre).","additionalProperties":{}},"language":{"type":"string","maxLength":20,"description":"Idioma do comprador (ex.: `pt-BR`)."},"metadata":{"type":"object","description":"Os seus metadados chave-valor.","additionalProperties":{}},"timezone":{"type":"string","maxLength":50,"description":"Fuso horário do comprador (ex.: `America/Sao_Paulo`)."},"totalTax":{"type":"integer","minimum":0,"description":"Total de impostos, em centavos."},"expiresAt":{"type":"string","format":"date-time","description":"Quando a sessão expira; derivado das suas configurações quando omitido."},"lineItems":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Apelido de `items`."},"onBehalfOf":{"type":"string","pattern":"^.+_.+$","description":"Marketplace: a cobrança que esta sessão liquida é feita NA sub-conta sua indicada (ela passa a ser a vendedora de registro); a sua taxa de plataforma é recolhida como split."},"totalAmount":{"type":"integer","minimum":0,"description":"Total do carrinho, em centavos."},"redirectUrls":{"type":"object","description":"Para onde o comprador é enviado depois do pagamento, por desfecho (`paid`, `refused`, `pending`): URLs `https://`; vazio ou `null` = não definido.","additionalProperties":{"anyOf":[{"type":"string","format":"uri","description":"URL `https://` absoluta para onde o comprador pode ser enviado (`http://` só em localhost), sem credenciais."},{"enum":[""],"type":"string"},{"enum":["null"],"nullable":true}]}},"integrationId":{"type":"string","maxLength":255,"description":"Id público dessa integração."},"totalDiscount":{"type":"integer","minimum":0,"description":"Total de desconto, em centavos."},"totalShipping":{"type":"integer","minimum":0,"description":"Total do frete, em centavos."},"paymentMethods":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"description":"Meios de pagamento oferecidos nesta sessão."},"integrationType":{"type":"string","maxLength":50,"description":"Tipo da integração a que a sessão pertence (ex.: `woocommerce`)."},"shippingDelivery":{"type":"object","description":"A opção de frete escolhida (JSON livre).","additionalProperties":{}},"externalTransactionId":{"type":"string","maxLength":255,"description":"O id do seu pedido para esta sessão."}},"additionalProperties":false},"example":{"utm":{},"items":[],"client":{},"source":"string","address":{},"ambient":"live","cookies":{},"coupons":["string"],"customer":{},"language":"string","metadata":{},"timezone":"string","totalTax":5000,"expiresAt":"2026-01-15T12:00:00.000Z","lineItems":[{}],"onBehalfOf":"id_0a1b2c3d4e5f60718293","totalAmount":5000,"redirectUrls":{},"integrationId":"string","totalDiscount":5000,"totalShipping":5000,"paymentMethods":["string"],"integrationType":"string","shippingDelivery":{},"externalTransactionId":"string"}}},"required":true}}},"/v1/coupons/{couponId}":{"get":{"tags":["Coupons"],"summary":"Consulta um cupom","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","code","type","value","enabled","minCartAmount","maxCartAmount","minCartItems","maxCartItems","usageLimit","usageQuantity","limitOneUsePerCustomer","isCumulative","initDate","endDate","allowedItemIds","allowedCustomerIds","scope","recurringCycles","redemptionsCount","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(dis|coup)_.+$","description":"Identificador público (dis_/coup_…)"},"code":{"type":"string","nullable":true,"description":"O código que o comprador digita."},"name":{"type":"string","nullable":true,"description":"Nome do cupom."},"type":{"enum":["flat","percentage"],"type":"string","description":"`flat` (um valor fixo) ou `percentage`."},"scope":{"enum":["firstCharge","recurring"],"type":"string","description":"Numa assinatura: `firstCharge` (só a primeira cobrança) ou `recurring` (todo ciclo, até `recurringCycles`)."},"value":{"type":"number","description":"Em `percentage`, o percentual (0–100); em `flat`, o valor em reais (decimal)."},"enabled":{"type":"boolean","description":"Se o cupom pode ser usado."},"endDate":{"type":"string","nullable":true,"description":"Até quando o cupom vale; `null` = sem fim."},"initDate":{"type":"string","nullable":true,"description":"A partir de quando o cupom vale; `null` = sem início."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"usageLimit":{"type":"integer","nullable":true,"description":"Número total de usos permitidos; `null` ou 0 = ilimitado."},"isCumulative":{"type":"boolean","description":"Se pode ser combinado com outros cupons."},"maxCartItems":{"type":"integer","nullable":true,"description":"Número máximo de itens; `null` = sem limite."},"minCartItems":{"type":"integer","nullable":true,"description":"Número mínimo de itens; `null` = sem mínimo."},"maxCartAmount":{"type":"integer","nullable":true,"description":"Valor máximo do carrinho (centavos); `null` = sem limite."},"minCartAmount":{"type":"integer","nullable":true,"description":"Valor mínimo do carrinho (centavos); `null` = sem mínimo."},"usageQuantity":{"type":"integer","nullable":true,"description":"Usos permitidos por cliente; `null` ou 0 = ilimitado."},"allowedItemIds":{"type":"array","items":{},"nullable":true,"description":"Ids das variantes a que o cupom se restringe; `null` = qualquer item."},"recurringCycles":{"type":"integer","nullable":true,"description":"Com `scope=recurring`: quantos ciclos ganham o desconto; `null` = todos os ciclos."},"redemptionsCount":{"type":"integer","description":"Quantas vezes o cupom foi usado (reservas e confirmados). Esgota quando `usageLimit > 0` e isto chega lá."},"allowedCustomerIds":{"type":"array","items":{},"nullable":true,"description":"Ids dos clientes a que o cupom se restringe; `null` = qualquer cliente."},"limitOneUsePerCustomer":{"type":"boolean","description":"Cada cliente pode usar o cupom uma vez."}},"additionalProperties":false},"example":{"id":"dis_0a1b2c3d4e5f60718293","code":"string","name":"Acme Ltda","type":"flat","scope":"firstCharge","value":5000,"enabled":true,"endDate":"string","initDate":"string","createdAt":"string","updatedAt":"string","usageLimit":0,"isCumulative":true,"maxCartItems":0,"minCartItems":0,"maxCartAmount":5000,"minCartAmount":5000,"usageQuantity":0,"allowedItemIds":[],"recurringCycles":0,"redemptionsCount":0,"allowedCustomerIds":[],"limitOneUsePerCustomer":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"couponId","schema":{"type":"string","pattern":"^(dis|coup)_.+$"},"required":true,"description":"Identificador público (dis_/coup_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getCoupon"},"put":{"tags":["Coupons"],"summary":"Atualiza um cupom","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","code","type","value","enabled","minCartAmount","maxCartAmount","minCartItems","maxCartItems","usageLimit","usageQuantity","limitOneUsePerCustomer","isCumulative","initDate","endDate","allowedItemIds","allowedCustomerIds","scope","recurringCycles","redemptionsCount","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(dis|coup)_.+$","description":"Identificador público (dis_/coup_…)"},"code":{"type":"string","nullable":true,"description":"O código que o comprador digita."},"name":{"type":"string","nullable":true,"description":"Nome do cupom."},"type":{"enum":["flat","percentage"],"type":"string","description":"`flat` (um valor fixo) ou `percentage`."},"scope":{"enum":["firstCharge","recurring"],"type":"string","description":"Numa assinatura: `firstCharge` (só a primeira cobrança) ou `recurring` (todo ciclo, até `recurringCycles`)."},"value":{"type":"number","description":"Em `percentage`, o percentual (0–100); em `flat`, o valor em reais (decimal)."},"enabled":{"type":"boolean","description":"Se o cupom pode ser usado."},"endDate":{"type":"string","nullable":true,"description":"Até quando o cupom vale; `null` = sem fim."},"initDate":{"type":"string","nullable":true,"description":"A partir de quando o cupom vale; `null` = sem início."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"usageLimit":{"type":"integer","nullable":true,"description":"Número total de usos permitidos; `null` ou 0 = ilimitado."},"isCumulative":{"type":"boolean","description":"Se pode ser combinado com outros cupons."},"maxCartItems":{"type":"integer","nullable":true,"description":"Número máximo de itens; `null` = sem limite."},"minCartItems":{"type":"integer","nullable":true,"description":"Número mínimo de itens; `null` = sem mínimo."},"maxCartAmount":{"type":"integer","nullable":true,"description":"Valor máximo do carrinho (centavos); `null` = sem limite."},"minCartAmount":{"type":"integer","nullable":true,"description":"Valor mínimo do carrinho (centavos); `null` = sem mínimo."},"usageQuantity":{"type":"integer","nullable":true,"description":"Usos permitidos por cliente; `null` ou 0 = ilimitado."},"allowedItemIds":{"type":"array","items":{},"nullable":true,"description":"Ids das variantes a que o cupom se restringe; `null` = qualquer item."},"recurringCycles":{"type":"integer","nullable":true,"description":"Com `scope=recurring`: quantos ciclos ganham o desconto; `null` = todos os ciclos."},"redemptionsCount":{"type":"integer","description":"Quantas vezes o cupom foi usado (reservas e confirmados). Esgota quando `usageLimit > 0` e isto chega lá."},"allowedCustomerIds":{"type":"array","items":{},"nullable":true,"description":"Ids dos clientes a que o cupom se restringe; `null` = qualquer cliente."},"limitOneUsePerCustomer":{"type":"boolean","description":"Cada cliente pode usar o cupom uma vez."}},"additionalProperties":false},"example":{"id":"dis_0a1b2c3d4e5f60718293","code":"string","name":"Acme Ltda","type":"flat","scope":"firstCharge","value":5000,"enabled":true,"endDate":"string","initDate":"string","createdAt":"string","updatedAt":"string","usageLimit":0,"isCumulative":true,"maxCartItems":0,"minCartItems":0,"maxCartAmount":5000,"minCartAmount":5000,"usageQuantity":0,"allowedItemIds":[],"recurringCycles":0,"redemptionsCount":0,"allowedCustomerIds":[],"limitOneUsePerCustomer":true}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"couponId","schema":{"type":"string","pattern":"^(dis|coup)_.+$"},"required":true,"description":"Identificador público (dis_/coup_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateCoupon","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"minLength":1,"description":"O código que o comprador digita."},"name":{"type":"string","maxLength":80,"minLength":1,"description":"Nome do cupom, para a sua referência."},"type":{"enum":["flat","percentage"],"type":"string","description":"`flat` (um valor fixo) ou `percentage`."},"scope":{"enum":["firstCharge","recurring"],"type":"string","description":"Numa assinatura: `firstCharge` desconta só a primeira cobrança (padrão); `recurring` é reaplicado a cada ciclo, até `recurringCycles`."},"value":{"type":"number","maximum":20000000,"minimum":0,"description":"Em `percentage`, o percentual (0–100); em `flat`, o valor em reais (decimal)."},"enabled":{"type":"boolean","description":"Se o cupom pode ser usado."},"endDate":{"type":"string","format":"date-time","nullable":true,"description":"Até quando o cupom vale; `null` limpa."},"initDate":{"type":"string","format":"date-time","nullable":true,"description":"A partir de quando o cupom vale; `null` limpa."},"usageLimit":{"type":"integer","minimum":0,"description":"Número total de usos permitidos (0 = ilimitado)."},"isCumulative":{"type":"boolean","description":"Se pode ser combinado com outros cupons."},"maxCartItems":{"type":"integer","maximum":100000,"minimum":0,"description":"Número máximo de itens no carrinho."},"minCartItems":{"type":"integer","maximum":100000,"minimum":0,"description":"Número mínimo de itens no carrinho."},"maxCartAmount":{"type":"integer","maximum":20000000,"minimum":0,"description":"Valor máximo do carrinho para o cupom valer (centavos)."},"minCartAmount":{"type":"integer","maximum":20000000,"minimum":0,"description":"Valor mínimo do carrinho para o cupom valer (centavos)."},"usageQuantity":{"type":"integer","minimum":0,"description":"Usos permitidos por cliente (0 = ilimitado)."},"allowedItemIds":{"type":"array","items":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"maxItems":1000,"description":"Só estas variantes ganham o desconto (ids de variante)."},"recurringCycles":{"type":"integer","maximum":999,"minimum":1,"nullable":true,"description":"Com `scope=recurring`: quantos ciclos ganham o desconto; `null` = todos os ciclos."},"allowedCustomerIds":{"type":"array","items":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"maxItems":1000,"description":"Só estes clientes podem usar o cupom."},"limitOneUsePerCustomer":{"type":"boolean","description":"Cada cliente pode usar o cupom uma vez."}},"additionalProperties":false},"example":{"code":"string","name":"Acme Ltda","type":"flat","scope":"firstCharge","value":5000,"enabled":true,"endDate":"2026-01-15T12:00:00.000Z","initDate":"2026-01-15T12:00:00.000Z","usageLimit":0,"isCumulative":true,"maxCartItems":0,"minCartItems":0,"maxCartAmount":5000,"minCartAmount":5000,"usageQuantity":0,"allowedItemIds":["var_0a1b2c3d4e5f60718293"],"recurringCycles":1,"allowedCustomerIds":["cus_0a1b2c3d4e5f60718293"],"limitOneUsePerCustomer":true}}},"required":true}},"patch":{"tags":["Coupons"],"summary":"Atualiza um cupom","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","code","type","value","enabled","minCartAmount","maxCartAmount","minCartItems","maxCartItems","usageLimit","usageQuantity","limitOneUsePerCustomer","isCumulative","initDate","endDate","allowedItemIds","allowedCustomerIds","scope","recurringCycles","redemptionsCount","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(dis|coup)_.+$","description":"Identificador público (dis_/coup_…)"},"code":{"type":"string","nullable":true,"description":"O código que o comprador digita."},"name":{"type":"string","nullable":true,"description":"Nome do cupom."},"type":{"enum":["flat","percentage"],"type":"string","description":"`flat` (um valor fixo) ou `percentage`."},"scope":{"enum":["firstCharge","recurring"],"type":"string","description":"Numa assinatura: `firstCharge` (só a primeira cobrança) ou `recurring` (todo ciclo, até `recurringCycles`)."},"value":{"type":"number","description":"Em `percentage`, o percentual (0–100); em `flat`, o valor em reais (decimal)."},"enabled":{"type":"boolean","description":"Se o cupom pode ser usado."},"endDate":{"type":"string","nullable":true,"description":"Até quando o cupom vale; `null` = sem fim."},"initDate":{"type":"string","nullable":true,"description":"A partir de quando o cupom vale; `null` = sem início."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"usageLimit":{"type":"integer","nullable":true,"description":"Número total de usos permitidos; `null` ou 0 = ilimitado."},"isCumulative":{"type":"boolean","description":"Se pode ser combinado com outros cupons."},"maxCartItems":{"type":"integer","nullable":true,"description":"Número máximo de itens; `null` = sem limite."},"minCartItems":{"type":"integer","nullable":true,"description":"Número mínimo de itens; `null` = sem mínimo."},"maxCartAmount":{"type":"integer","nullable":true,"description":"Valor máximo do carrinho (centavos); `null` = sem limite."},"minCartAmount":{"type":"integer","nullable":true,"description":"Valor mínimo do carrinho (centavos); `null` = sem mínimo."},"usageQuantity":{"type":"integer","nullable":true,"description":"Usos permitidos por cliente; `null` ou 0 = ilimitado."},"allowedItemIds":{"type":"array","items":{},"nullable":true,"description":"Ids das variantes a que o cupom se restringe; `null` = qualquer item."},"recurringCycles":{"type":"integer","nullable":true,"description":"Com `scope=recurring`: quantos ciclos ganham o desconto; `null` = todos os ciclos."},"redemptionsCount":{"type":"integer","description":"Quantas vezes o cupom foi usado (reservas e confirmados). Esgota quando `usageLimit > 0` e isto chega lá."},"allowedCustomerIds":{"type":"array","items":{},"nullable":true,"description":"Ids dos clientes a que o cupom se restringe; `null` = qualquer cliente."},"limitOneUsePerCustomer":{"type":"boolean","description":"Cada cliente pode usar o cupom uma vez."}},"additionalProperties":false},"example":{"id":"dis_0a1b2c3d4e5f60718293","code":"string","name":"Acme Ltda","type":"flat","scope":"firstCharge","value":5000,"enabled":true,"endDate":"string","initDate":"string","createdAt":"string","updatedAt":"string","usageLimit":0,"isCumulative":true,"maxCartItems":0,"minCartItems":0,"maxCartAmount":5000,"minCartAmount":5000,"usageQuantity":0,"allowedItemIds":[],"recurringCycles":0,"redemptionsCount":0,"allowedCustomerIds":[],"limitOneUsePerCustomer":true}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"couponId","schema":{"type":"string","pattern":"^(dis|coup)_.+$"},"required":true,"description":"Identificador público (dis_/coup_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"patchCoupon","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"minLength":1,"description":"O código que o comprador digita."},"name":{"type":"string","maxLength":80,"minLength":1,"description":"Nome do cupom, para a sua referência."},"type":{"enum":["flat","percentage"],"type":"string","description":"`flat` (um valor fixo) ou `percentage`."},"scope":{"enum":["firstCharge","recurring"],"type":"string","description":"Numa assinatura: `firstCharge` desconta só a primeira cobrança (padrão); `recurring` é reaplicado a cada ciclo, até `recurringCycles`."},"value":{"type":"number","maximum":20000000,"minimum":0,"description":"Em `percentage`, o percentual (0–100); em `flat`, o valor em reais (decimal)."},"enabled":{"type":"boolean","description":"Se o cupom pode ser usado."},"endDate":{"type":"string","format":"date-time","nullable":true,"description":"Até quando o cupom vale; `null` limpa."},"initDate":{"type":"string","format":"date-time","nullable":true,"description":"A partir de quando o cupom vale; `null` limpa."},"usageLimit":{"type":"integer","minimum":0,"description":"Número total de usos permitidos (0 = ilimitado)."},"isCumulative":{"type":"boolean","description":"Se pode ser combinado com outros cupons."},"maxCartItems":{"type":"integer","maximum":100000,"minimum":0,"description":"Número máximo de itens no carrinho."},"minCartItems":{"type":"integer","maximum":100000,"minimum":0,"description":"Número mínimo de itens no carrinho."},"maxCartAmount":{"type":"integer","maximum":20000000,"minimum":0,"description":"Valor máximo do carrinho para o cupom valer (centavos)."},"minCartAmount":{"type":"integer","maximum":20000000,"minimum":0,"description":"Valor mínimo do carrinho para o cupom valer (centavos)."},"usageQuantity":{"type":"integer","minimum":0,"description":"Usos permitidos por cliente (0 = ilimitado)."},"allowedItemIds":{"type":"array","items":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"maxItems":1000,"description":"Só estas variantes ganham o desconto (ids de variante)."},"recurringCycles":{"type":"integer","maximum":999,"minimum":1,"nullable":true,"description":"Com `scope=recurring`: quantos ciclos ganham o desconto; `null` = todos os ciclos."},"allowedCustomerIds":{"type":"array","items":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"maxItems":1000,"description":"Só estes clientes podem usar o cupom."},"limitOneUsePerCustomer":{"type":"boolean","description":"Cada cliente pode usar o cupom uma vez."}},"additionalProperties":false},"example":{"code":"string","name":"Acme Ltda","type":"flat","scope":"firstCharge","value":5000,"enabled":true,"endDate":"2026-01-15T12:00:00.000Z","initDate":"2026-01-15T12:00:00.000Z","usageLimit":0,"isCumulative":true,"maxCartItems":0,"minCartItems":0,"maxCartAmount":5000,"minCartAmount":5000,"usageQuantity":0,"allowedItemIds":["var_0a1b2c3d4e5f60718293"],"recurringCycles":1,"allowedCustomerIds":["cus_0a1b2c3d4e5f60718293"],"limitOneUsePerCustomer":true}}},"required":true}},"delete":{"tags":["Coupons"],"summary":"Exclui um cupom","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","pattern":"^(dis|coup)_.+$","description":"Id público do recurso excluído."},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"resource":{"enum":["coupon"],"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"dis_0a1b2c3d4e5f60718293","deleted":true,"resource":"coupon"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"couponId","schema":{"type":"string","pattern":"^(dis|coup)_.+$"},"required":true,"description":"Identificador público (dis_/coup_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteCoupon"}},"/v1/wallets/{walletId}":{"get":{"tags":["Wallets"],"summary":"Consulta uma carteira de recebimento","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","holderName","bankName","bankCode","routingNumber","accountNumber","accountType","pixKey","primary","enabled","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(wall)_.+$","description":"Identificador público (wall_…)"},"name":{"type":"string","description":"Nome da conta bancária."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"pixKey":{"type":"string","nullable":true,"description":"Chave Pix do destino; `null` quando é conta bancária."},"enabled":{"type":"boolean","description":"Se a conta bancária pode receber saques (`false` depois de arquivada)."},"primary":{"type":"boolean","description":"Se é o destino principal dos saques."},"bankCode":{"type":"string","nullable":true,"description":"Código do banco."},"bankName":{"type":"string","nullable":true,"description":"Nome do banco."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"holderName":{"type":"string","description":"Nome do titular da conta — sempre o dono da conta (a sua empresa)."},"accountType":{"type":"string","description":"Tipo da conta (ex.: `checking`)."},"accountNumber":{"type":"string","nullable":true,"description":"Número da conta."},"routingNumber":{"type":"string","nullable":true,"description":"Agência."}},"additionalProperties":false},"example":{"id":"wall_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"pixKey":"string","enabled":true,"primary":true,"bankCode":"string","bankName":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","updatedAt":"string","holderName":"JOAO SILVA","accountType":"string","accountNumber":"string","routingNumber":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"walletId","schema":{"type":"string","pattern":"^(wall)_.+$"},"required":true,"description":"Identificador público (wall_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getWallet"},"delete":{"tags":["Wallets"],"summary":"Arquiva uma carteira de recebimento","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","description":"Id público do recurso excluído."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"resource":{"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"string","_links":{},"deleted":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"resource":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"walletId","schema":{"type":"string","pattern":"^(wall)_.+$"},"required":true,"description":"Identificador público (wall_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteWallet"}},"/v1/webhooks/{id}/test":{"post":{"tags":["Webhooks"],"summary":"Envia um ping de teste para conferir a integração","responses":{"202":{"content":{"application/json":{"schema":{"type":"object","required":["accepted","id"],"properties":{"id":{"type":"string","description":"Id público do evento ou da entrega que será enviada."},"accepted":{"enum":[true],"type":"boolean","description":"Sempre `true`: o pedido foi aceito; a entrega acontece em segundo plano."}},"additionalProperties":false},"example":{"id":"string","accepted":true}}},"description":"Aceito"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","pattern":"^(wbe|wbh)_.+$"},"required":true,"description":"Identificador público (wbe_/wbh_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"testWebhookEndpoint","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{},"additionalProperties":false}]}}},"required":true}}},"/v1/tokenization/config":{"get":{"tags":["tokenization"],"summary":"Onde e como o navegador do comprador tokeniza um cartão (endpoint da Selectwin; nenhuma credencial trafega)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["environment","publicKey","tokenization","acceptedBrands","elements"],"properties":{"elements":{"type":"object","required":["scriptUrl","fieldsUrl"],"properties":{"fieldsUrl":{"type":"string","format":"uri","description":"Os campos de cartão hospedados que o elemento embute."},"scriptUrl":{"type":"string","format":"uri","description":"O script que a sua página carrega para montar o elemento de cartão."}},"description":"Selectwin Elements: o iframe de cartão hospedado — os campos do cartão vivem na origem da Selectwin, então a sua página nunca segura o número do cartão.","additionalProperties":false},"publicKey":{"type":"string","nullable":true,"description":"A sua chave publicável, devolvida para uma página que chegou aqui com `SelectKey` poder continuar usando a pk."},"environment":{"enum":["live","sandbox"],"type":"string","description":"O ambiente a que a chave pertence."},"tokenization":{"type":"object","required":["method","url","headers","fields","tokenField","ttlSeconds"],"properties":{"url":{"type":"string","format":"uri","description":"Para onde o navegador faz o POST do cartão: o endpoint de tokenização da Selectwin, já com `?pk=`."},"fields":{"type":"object","required":["holderName","number","expirationMonth","expirationYear","securityCode"],"properties":{"number":{"type":"string","description":"Campo do corpo para o número do cartão."},"holderName":{"type":"string","description":"Campo do corpo para o nome no cartão."},"securityCode":{"type":"string","description":"Campo do corpo para o código de segurança."},"expirationYear":{"type":"string","description":"Campo do corpo para o ano de validade."},"expirationMonth":{"type":"string","description":"Campo do corpo para o mês de validade."}},"description":"O nome do campo do corpo para cada campo do cartão.","additionalProperties":false},"method":{"enum":["POST"],"type":"string","description":"Sempre `POST`."},"headers":{"type":"object","description":"Cabeçalhos a enviar como estão (só o tipo de conteúdo — nenhuma credencial vai à página).","additionalProperties":{"type":"string"}},"tokenField":{"type":"string","description":"O campo da resposta JSON que carrega o token."},"ttlSeconds":{"type":"integer","description":"Por quanto tempo um token emitido continua utilizável, em segundos (uso único)."}},"description":"Onde e como o navegador tokeniza um cartão.","additionalProperties":false},"acceptedBrands":{"type":"array","items":{"type":"string"},"description":"Bandeiras que você aceita (`visa`, `mastercard`…) — para a página recusar uma bandeira antes de tokenizar."}},"additionalProperties":false},"example":{"elements":{"fieldsUrl":"https://example.com","scriptUrl":"https://example.com"},"publicKey":"string","environment":"live","tokenization":{"url":"https://example.com","fields":{"number":"1000","holderName":"JOAO SILVA","securityCode":"string","expirationYear":"string","expirationMonth":"string"},"method":"POST","headers":{},"tokenField":"string","ttlSeconds":0},"acceptedBrands":["string"]}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"},"503":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false}}},"description":"Serviço indisponível"}},"parameters":[{"in":"query","name":"pk","schema":{"type":"string","pattern":"^pk_(live|test)_[A-Za-z0-9]{8,128}$"},"required":false,"description":"A sua chave publicável (`pk_live_…` / `pk_test_…`), emitida junto com cada chave de API. Segura num navegador."}],"operationId":"getTokenizationConfig"}},"/v1/tokenization/tokens":{"post":{"tags":["tokenization"],"summary":"Tokeniza um cartão digitado no navegador do comprador (devolve um token de uso único)","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["token","ttlSeconds","card"],"properties":{"card":{"type":"object","required":["brand","brandType","firstDigits","lastDigits","expirationMonth","expirationYear","holderName"],"properties":{"brand":{"type":"string","description":"Bandeira do cartão."},"brandType":{"type":"string","description":"`credit`, `debit`…"},"holderName":{"type":"string","description":"Nome impresso no cartão."},"lastDigits":{"type":"string","description":"Quatro últimos dígitos."},"firstDigits":{"type":"string","description":"Seis primeiros dígitos."},"expirationYear":{"type":"string","description":"Ano de validade (`YYYY`)."},"expirationMonth":{"type":"string","description":"Mês de validade (`MM`)."}},"description":"O que se sabe do cartão, para exibição.","additionalProperties":false},"token":{"type":"string","description":"O token de cartão de uso único — o que `POST /v1/cards` (`token`) e `payment.card.token` recebem."},"ttlSeconds":{"type":"integer","description":"Por quanto tempo o token continua utilizável, em segundos."}},"additionalProperties":false},"example":{"card":{"brand":"string","brandType":"string","holderName":"JOAO SILVA","lastDigits":"string","firstDigits":"string","expirationYear":"string","expirationMonth":"string"},"token":"string","ttlSeconds":0}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"429":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Limite de requisições excedido"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"},"503":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false}}},"description":"Serviço indisponível"}},"parameters":[{"in":"query","name":"pk","schema":{"type":"string","pattern":"^pk_(live|test)_[A-Za-z0-9]{8,128}$"},"required":true,"description":"A sua chave publicável (`pk_live_…` / `pk_test_…`), emitida junto com cada chave de API. Segura num navegador."}],"operationId":"tokenizeBrowserCard","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["holderName","numbering","expirationMonth","expirationYear","securityCode"],"properties":{"numbering":{"type":"string","description":"Número do cartão (PAN), só dígitos — espaços e traços são removidos. Tokenizado ao chegar, nunca guardado."},"holderName":{"type":"string","maxLength":255,"minLength":3,"description":"Nome impresso no cartão."},"securityCode":{"type":"string","pattern":"^\\d{3,4}$","description":"Código de segurança do cartão (CVV/CVC), 3 ou 4 dígitos."},"expirationYear":{"allOf":[{"type":"integer","minimum":0},{"type":"integer","maximum":2100,"minimum":2026}],"description":"Ano de validade, 4 dígitos — 2 dígitos são aceitos."},"expirationMonth":{"type":"integer","maximum":12,"minimum":1,"description":"Mês de validade, 1 a 12."}},"additionalProperties":false},"example":{"numbering":"string","holderName":"JOAO SILVA","securityCode":"id_0a1b2c3d4e5f60718293","expirationYear":{},"expirationMonth":1}}},"required":true}}},"/v1/utils/company-types":{"get":{"tags":["Utils"],"summary":"Lista as categorias de empresa","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["categoryId","mcc","code","name","description"],"properties":{"mcc":{"type":"string","nullable":true,"description":"Código de categoria do estabelecimento (MCC)."},"code":{"type":"string","nullable":true,"description":"Código da categoria."},"name":{"type":"string","nullable":true,"description":"Nome da categoria."},"categoryId":{"type":"integer","description":"Id da categoria."},"description":{"type":"string","nullable":true,"description":"Descrição."}},"additionalProperties":false},"description":"As categorias de negócio com que uma empresa pode se cadastrar."}},"additionalProperties":false},"example":{"data":[{"mcc":"string","code":"string","name":"Acme Ltda","categoryId":0,"description":"string"}]}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"utilsCompanyTypes"}},"/v1/utils/roles-of-user":{"get":{"tags":["Utils"],"summary":"Lista o catálogo de papéis de usuário","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"nullable":true,"description":"O catálogo de papéis, como configurado."}},"additionalProperties":false},"example":{}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"utilsRolesOfUser"}},"/v1/webhooks/dispatches":{"get":{"tags":["Webhooks"],"summary":"Lista as entregas de webhook","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","eventId","eventType","endpointId","endpoint","status","attempts","responseStatusCode","responseBody","responseTime","nextAttemptAt","lastAttemptAt","successAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(wdi)_.+$","description":"Identificador público (wdi_…)"},"status":{"enum":["pending","success","failed","retrying","canceled"],"type":"string","description":"`pending`, `success`, `failed`, `retrying` ou `canceled`."},"eventId":{"type":"string","pattern":"^(wbh)_.+$","nullable":true,"description":"O evento entregue; `null` numa entrega sintética (ping de teste)."},"attempts":{"type":"integer","description":"Tentativas feitas até agora."},"endpoint":{"type":"string","description":"A URL para onde foi entregue."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"eventType":{"type":"string","nullable":true,"description":"Tipo do evento entregue (ex.: `transaction.approved`); `null` numa entrega sintética."},"successAt":{"type":"string","nullable":true,"description":"Quando a entrega deu certo; `null` até lá."},"endpointId":{"type":"string","pattern":"^(wbe|wbh)_.+$","nullable":true,"description":"O endpoint para onde foi entregue."},"responseBody":{"type":"string","nullable":true,"description":"Corpo que o seu endpoint respondeu (primeiros 8 KB); `null` quando não houve."},"responseTime":{"type":"integer","nullable":true,"description":"Quanto tempo o seu endpoint levou para responder, em milissegundos."},"lastAttemptAt":{"type":"string","nullable":true,"description":"Quando a última tentativa foi feita."},"nextAttemptAt":{"type":"string","nullable":true,"description":"Quando a próxima tentativa está marcada; `null` quando não há."},"responseStatusCode":{"type":"integer","nullable":true,"description":"Status HTTP que o seu endpoint respondeu; `null` quando não respondeu."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"wdi_0a1b2c3d4e5f60718293","status":"pending","eventId":"wbh_0a1b2c3d4e5f60718293","attempts":0,"endpoint":"string","createdAt":"string","eventType":"string","successAt":"string","endpointId":"wbe_0a1b2c3d4e5f60718293","responseBody":"string","responseTime":0,"lastAttemptAt":"string","nextAttemptAt":"string","responseStatusCode":0}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"status","schema":{"enum":["pending","success","failed","retrying","canceled"],"type":"string"},"required":false,"description":"Só entregas com este status."},{"in":"query","name":"responseStatus","schema":{"type":"integer"},"required":false,"description":"Só entregas que o seu endpoint respondeu com este status HTTP."},{"in":"query","name":"onlyErrored","schema":{"type":"boolean"},"required":false,"description":"Só entregas que falharam."},{"in":"query","name":"endpoint","schema":{"type":"string","maxLength":255},"required":false,"description":"Só entregas a esta URL exata."},{"in":"query","name":"endpointId","schema":{"type":"string","pattern":"^(wbe|wbh)_.+$"},"required":false,"description":"Só entregas a este endpoint (o histórico inteiro dele, mesmo depois de a URL mudar)."},{"in":"query","name":"responsestatus","schema":{"type":"integer"},"required":false,"description":"Apelido de `responseStatus`."},{"in":"query","name":"onlyerrored","schema":{"type":"boolean"},"required":false,"description":"Apelido de `onlyErrored`."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listWebhookDispatches"}},"/v1/products/{productId}":{"get":{"tags":["Products"],"summary":"Consulta um produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","slug","salesPage","description","language","enabled","salesQty","type","category","externalReference","warrantyDays","images","fiscal","createdAt","updatedAt","variants"],"properties":{"id":{"type":"string","pattern":"^(prd|pro)_.+$","description":"Identificador público (prd_/pro_…)"},"name":{"type":"string","description":"Nome do produto."},"slug":{"type":"string","nullable":true,"description":"Slug, derivado do nome."},"type":{"enum":["physical","digital","other"],"type":"string","description":"`physical`, `digital` ou `other`."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"Perfil fiscal do produto; `null` quando não há.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o produto está à venda."},"category":{"type":"string","description":"Categoria."},"language":{"type":"string","nullable":true,"description":"Idioma do produto."},"salesQty":{"type":"integer","nullable":true,"description":"Número de vendas do produto; `null` quando desconhecido."},"variants":{"type":"array","items":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"description":"As variantes do produto."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"salesPage":{"type":"string","nullable":true,"description":"URL da página de vendas; `null` quando não há."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"warrantyDays":{"type":"integer","description":"Garantia oferecida ao comprador, em dias."},"imageAssetIds":{"nullable":true,"description":"Ids dos arquivos de imagem; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do produto; `null` quando não há."}},"additionalProperties":false},"example":{"id":"prd_0a1b2c3d4e5f60718293","name":"Acme Ltda","slug":"string","type":"physical","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"category":"string","language":"string","salesQty":0,"variants":[{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}],"createdAt":"string","salesPage":"string","updatedAt":"string","description":"string","warrantyDays":0,"externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getProduct"},"put":{"tags":["Products"],"summary":"Atualiza um produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","slug","salesPage","description","language","enabled","salesQty","type","category","externalReference","warrantyDays","images","fiscal","createdAt","updatedAt","variants"],"properties":{"id":{"type":"string","pattern":"^(prd|pro)_.+$","description":"Identificador público (prd_/pro_…)"},"name":{"type":"string","description":"Nome do produto."},"slug":{"type":"string","nullable":true,"description":"Slug, derivado do nome."},"type":{"enum":["physical","digital","other"],"type":"string","description":"`physical`, `digital` ou `other`."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"Perfil fiscal do produto; `null` quando não há.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o produto está à venda."},"category":{"type":"string","description":"Categoria."},"language":{"type":"string","nullable":true,"description":"Idioma do produto."},"salesQty":{"type":"integer","nullable":true,"description":"Número de vendas do produto; `null` quando desconhecido."},"variants":{"type":"array","items":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"description":"As variantes do produto."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"salesPage":{"type":"string","nullable":true,"description":"URL da página de vendas; `null` quando não há."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"warrantyDays":{"type":"integer","description":"Garantia oferecida ao comprador, em dias."},"imageAssetIds":{"nullable":true,"description":"Ids dos arquivos de imagem; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do produto; `null` quando não há."}},"additionalProperties":false},"example":{"id":"prd_0a1b2c3d4e5f60718293","name":"Acme Ltda","slug":"string","type":"physical","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"category":"string","language":"string","salesQty":0,"variants":[{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}],"createdAt":"string","salesPage":"string","updatedAt":"string","description":"string","warrantyDays":0,"externalReference":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateProduct__put","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":40,"minLength":1,"description":"Nome do produto (o `slug` é derivado dele)."},"type":{"enum":["physical","digital","other"],"type":"string","description":"`physical` (enviado), `digital` ou `other`."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","pattern":"^\\d{9}$","description":"Código NBS, 9 dígitos (serviço)."},"ncm":{"type":"string","pattern":"^\\d{8}$","description":"Código NCM, 8 dígitos (mercadoria)."},"cest":{"type":"string","pattern":"^\\d{7}$","description":"Código CEST, 7 dígitos (mercadoria com substituição tributária)."},"gtin":{"type":"string","pattern":"^(\\d{8}|\\d{12,14})$","description":"GTIN/EAN — 8, 12, 13 ou 14 dígitos."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` emite NFS-e, `goods` emite NF-e. Omitido: um produto `physical` é mercadoria, os outros são serviço."},"unit":{"type":"string","maxLength":6,"minLength":1,"description":"Unidade comercial (UN, KG, CX…)."},"origin":{"type":"integer","maximum":8,"minimum":0,"description":"Origem da mercadoria (tabela A do ICMS, 0 a 8; 0 = nacional)."},"cClassTrib":{"type":"string","pattern":"^\\d{6}$","description":"Classificação tributária do IBS/CBS (cClassTrib, 6 dígitos)."},"serviceCode":{"type":"string","pattern":"^\\d{1,2}\\.?\\d{2}$","description":"Item da lista de serviços da LC 116 (`01.07` ou `0107`)."},"cityServiceCode":{"type":"string","maxLength":20,"minLength":1,"description":"Código do serviço na sua prefeitura."}},"description":"Perfil fiscal do produto; `null` limpa.","additionalProperties":false},"images":{"type":"array","items":{"type":"string","format":"uri","description":"URL absoluta."},"maxItems":10,"description":"URLs de imagem. Para anexar um arquivo, envie-o antes (`POST /v1/assets/uploads` e depois a confirmação) e mande a URL do arquivo."},"enabled":{"type":"boolean","default":true,"description":"Se o produto está à venda."},"category":{"type":"string","maxLength":100,"minLength":1,"description":"Categoria, texto livre."},"language":{"type":"string","default":"pt-BR","maxLength":10,"description":"Idioma do produto (ex.: `pt-BR`)."},"salesPage":{"type":"string","maxLength":255,"description":"URL da página de vendas."},"description":{"type":"string","maxLength":400,"description":"Descrição."},"warrantyDays":{"type":"integer","maximum":3650,"minimum":7,"description":"Garantia oferecida ao comprador, em dias (7 a 3650)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador do produto."}},"additionalProperties":false},"example":{"name":"Acme Ltda","type":"physical","fiscal":{"nbs":"id_0a1b2c3d4e5f60718293","ncm":"id_0a1b2c3d4e5f60718293","cest":"id_0a1b2c3d4e5f60718293","gtin":"id_0a1b2c3d4e5f60718293","kind":"service","unit":"string","origin":0,"cClassTrib":"id_0a1b2c3d4e5f60718293","serviceCode":"id_0a1b2c3d4e5f60718293","cityServiceCode":"string"},"images":["https://example.com"],"enabled":true,"category":"string","language":"pt-BR","salesPage":"string","description":"string","warrantyDays":7,"externalReference":"string"}}},"required":true}},"patch":{"tags":["Products"],"summary":"Atualiza um produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","slug","salesPage","description","language","enabled","salesQty","type","category","externalReference","warrantyDays","images","fiscal","createdAt","updatedAt","variants"],"properties":{"id":{"type":"string","pattern":"^(prd|pro)_.+$","description":"Identificador público (prd_/pro_…)"},"name":{"type":"string","description":"Nome do produto."},"slug":{"type":"string","nullable":true,"description":"Slug, derivado do nome."},"type":{"enum":["physical","digital","other"],"type":"string","description":"`physical`, `digital` ou `other`."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"Perfil fiscal do produto; `null` quando não há.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o produto está à venda."},"category":{"type":"string","description":"Categoria."},"language":{"type":"string","nullable":true,"description":"Idioma do produto."},"salesQty":{"type":"integer","nullable":true,"description":"Número de vendas do produto; `null` quando desconhecido."},"variants":{"type":"array","items":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"description":"As variantes do produto."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"salesPage":{"type":"string","nullable":true,"description":"URL da página de vendas; `null` quando não há."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"warrantyDays":{"type":"integer","description":"Garantia oferecida ao comprador, em dias."},"imageAssetIds":{"nullable":true,"description":"Ids dos arquivos de imagem; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do produto; `null` quando não há."}},"additionalProperties":false},"example":{"id":"prd_0a1b2c3d4e5f60718293","name":"Acme Ltda","slug":"string","type":"physical","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"category":"string","language":"string","salesQty":0,"variants":[{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}],"createdAt":"string","salesPage":"string","updatedAt":"string","description":"string","warrantyDays":0,"externalReference":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateProduct","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":40,"minLength":1,"description":"Nome do produto (o `slug` é derivado dele)."},"type":{"enum":["physical","digital","other"],"type":"string","description":"`physical` (enviado), `digital` ou `other`."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","pattern":"^\\d{9}$","description":"Código NBS, 9 dígitos (serviço)."},"ncm":{"type":"string","pattern":"^\\d{8}$","description":"Código NCM, 8 dígitos (mercadoria)."},"cest":{"type":"string","pattern":"^\\d{7}$","description":"Código CEST, 7 dígitos (mercadoria com substituição tributária)."},"gtin":{"type":"string","pattern":"^(\\d{8}|\\d{12,14})$","description":"GTIN/EAN — 8, 12, 13 ou 14 dígitos."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` emite NFS-e, `goods` emite NF-e. Omitido: um produto `physical` é mercadoria, os outros são serviço."},"unit":{"type":"string","maxLength":6,"minLength":1,"description":"Unidade comercial (UN, KG, CX…)."},"origin":{"type":"integer","maximum":8,"minimum":0,"description":"Origem da mercadoria (tabela A do ICMS, 0 a 8; 0 = nacional)."},"cClassTrib":{"type":"string","pattern":"^\\d{6}$","description":"Classificação tributária do IBS/CBS (cClassTrib, 6 dígitos)."},"serviceCode":{"type":"string","pattern":"^\\d{1,2}\\.?\\d{2}$","description":"Item da lista de serviços da LC 116 (`01.07` ou `0107`)."},"cityServiceCode":{"type":"string","maxLength":20,"minLength":1,"description":"Código do serviço na sua prefeitura."}},"description":"Perfil fiscal do produto; `null` limpa.","additionalProperties":false},"images":{"type":"array","items":{"type":"string","format":"uri","description":"URL absoluta."},"maxItems":10,"description":"URLs de imagem. Para anexar um arquivo, envie-o antes (`POST /v1/assets/uploads` e depois a confirmação) e mande a URL do arquivo."},"enabled":{"type":"boolean","default":true,"description":"Se o produto está à venda."},"category":{"type":"string","maxLength":100,"minLength":1,"description":"Categoria, texto livre."},"language":{"type":"string","default":"pt-BR","maxLength":10,"description":"Idioma do produto (ex.: `pt-BR`)."},"salesPage":{"type":"string","maxLength":255,"description":"URL da página de vendas."},"description":{"type":"string","maxLength":400,"description":"Descrição."},"warrantyDays":{"type":"integer","maximum":3650,"minimum":7,"description":"Garantia oferecida ao comprador, em dias (7 a 3650)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador do produto."}},"additionalProperties":false},"example":{"name":"Acme Ltda","type":"physical","fiscal":{"nbs":"id_0a1b2c3d4e5f60718293","ncm":"id_0a1b2c3d4e5f60718293","cest":"id_0a1b2c3d4e5f60718293","gtin":"id_0a1b2c3d4e5f60718293","kind":"service","unit":"string","origin":0,"cClassTrib":"id_0a1b2c3d4e5f60718293","serviceCode":"id_0a1b2c3d4e5f60718293","cityServiceCode":"string"},"images":["https://example.com"],"enabled":true,"category":"string","language":"pt-BR","salesPage":"string","description":"string","warrantyDays":7,"externalReference":"string"}}},"required":true}},"delete":{"tags":["Products"],"summary":"Exclui um produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","pattern":"^(prd|pro)_.+$","description":"Id público do recurso excluído."},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"resource":{"enum":["product"],"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"prd_0a1b2c3d4e5f60718293","deleted":true,"resource":"product"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteProduct"}},"/v1/receivables/schedule":{"get":{"tags":["Receivables"],"summary":"Agenda de liberação por dia — recebíveis pendentes pela data prevista de liberação, garantia pela data de devolução, e os vencidos","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["environment","from","to","days","totals","overdue"],"properties":{"to":{"type":"string","description":"Fim da janela (ISO 8601, exclusivo)."},"days":{"type":"array","items":{"type":"object","required":["date","pendingCents","count","warrantyCents"],"properties":{"date":{"type":"string","description":"O dia (`YYYY-MM-DD`)."},"count":{"type":"integer","description":"Quantos recebíveis."},"pendingCents":{"type":"integer","description":"Recebíveis pendentes com liberação prevista para o dia, em centavos."},"warrantyCents":{"type":"integer","description":"Retenções de garantia a devolver no dia, em centavos."}},"additionalProperties":false},"description":"Os dias da janela que têm algo a liberar, em ordem."},"from":{"type":"string","description":"Início da janela (ISO 8601)."},"totals":{"type":"object","required":["pendingCents","count","warrantyCents"],"properties":{"count":{"type":"integer","description":"Total de recebíveis na janela."},"pendingCents":{"type":"integer","description":"Total pendente na janela, em centavos."},"warrantyCents":{"type":"integer","description":"Total de garantia a devolver na janela, em centavos."}},"description":"As somas da janela.","additionalProperties":false},"overdue":{"type":"object","required":["pendingCents","count"],"properties":{"count":{"type":"integer","description":"Quantos recebíveis atrasados."},"pendingCents":{"type":"integer","description":"Valor atrasado, em centavos."}},"description":"Recebíveis cuja data de liberação já passou e seguem pendentes.","additionalProperties":false},"environment":{"enum":["live","sandbox"],"type":"string","description":"O ambiente da agenda: `live` ou `sandbox`."}},"additionalProperties":false},"example":{"to":"string","days":[{"date":"string","count":0,"pendingCents":5000,"warrantyCents":5000}],"from":"string","totals":{"count":0,"pendingCents":5000,"warrantyCents":5000},"overdue":{"count":0,"pendingCents":5000},"environment":"live"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"from","schema":{"type":"string","format":"date-time"},"required":false,"description":"Início da agenda (ISO). Padrão: hoje, 00:00 de São Paulo"},{"in":"query","name":"to","schema":{"type":"string","format":"date-time"},"required":false,"description":"Fim da agenda (ISO, exclusivo). Padrão: 30 dias depois do início; teto 366"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"receivablesSchedule"}},"/v1/variants/{variantId}":{"get":{"tags":["Products - Variants"],"summary":"Consulta uma variante de produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"example":{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"variantId","schema":{"type":"string","pattern":"^(var|prv)_.+$"},"required":true,"description":"Identificador público (var_/prv_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getVariant"},"delete":{"tags":["Products - Variants"],"summary":"Exclui uma variante de produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Id público do recurso excluído."},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"resource":{"enum":["variant"],"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"var_0a1b2c3d4e5f60718293","deleted":true,"resource":"variant"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"variantId","schema":{"type":"string","pattern":"^(var|prv)_.+$"},"required":true,"description":"Identificador público (var_/prv_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteVariant"}},"/v1/addresses/{addressId}":{"get":{"tags":["Addresses"],"summary":"Consulta um endereço","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","ownerType","ownerId","street","number","complement","district","city","state","country","postcode","latitude","longitude","primary","line","line1","line2","line3","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$","description":"Identificador público (addr_/cad_/cadm_/add_…)"},"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"ownerId":{"type":"string","description":"Id público do dono."},"primary":{"type":"boolean","description":"Se é o endereço principal do dono."},"district":{"type":"string","nullable":true,"description":"Bairro."},"latitude":{"type":"string","nullable":true,"description":"Latitude, em graus decimais como texto; `null` quando desconhecida."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"postcode":{"type":"string","description":"CEP, só dígitos."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"longitude":{"type":"string","nullable":true,"description":"Longitude, em graus decimais como texto; `null` quando desconhecida."},"ownerType":{"enum":["vendor","customer","company","user"],"type":"string","description":"Quem é dono do endereço: um `customer`, a própria `company`, um `user` ou um `vendor`."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."}},"additionalProperties":false},"example":{"id":"addr_0a1b2c3d4e5f60718293","city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","_links":{},"number":"1000","street":"string","country":"string","ownerId":"string","primary":true,"district":"string","latitude":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"postcode":"string","createdAt":"string","longitude":"string","ownerType":"vendor","updatedAt":"string","complement":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"addressId","schema":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$"},"required":true,"description":"Identificador público (addr_/cad_/cadm_/add_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getAddress"},"put":{"tags":["Addresses"],"summary":"Atualiza um endereço","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","ownerType","ownerId","street","number","complement","district","city","state","country","postcode","latitude","longitude","primary","line","line1","line2","line3","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$","description":"Identificador público (addr_/cad_/cadm_/add_…)"},"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"ownerId":{"type":"string","description":"Id público do dono."},"primary":{"type":"boolean","description":"Se é o endereço principal do dono."},"district":{"type":"string","nullable":true,"description":"Bairro."},"latitude":{"type":"string","nullable":true,"description":"Latitude, em graus decimais como texto; `null` quando desconhecida."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"postcode":{"type":"string","description":"CEP, só dígitos."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"longitude":{"type":"string","nullable":true,"description":"Longitude, em graus decimais como texto; `null` quando desconhecida."},"ownerType":{"enum":["vendor","customer","company","user"],"type":"string","description":"Quem é dono do endereço: um `customer`, a própria `company`, um `user` ou um `vendor`."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."}},"additionalProperties":false},"example":{"id":"addr_0a1b2c3d4e5f60718293","city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","_links":{},"number":"1000","street":"string","country":"string","ownerId":"string","primary":true,"district":"string","latitude":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"postcode":"string","createdAt":"string","longitude":"string","ownerType":"vendor","updatedAt":"string","complement":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"addressId","schema":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$"},"required":true,"description":"Identificador público (addr_/cad_/cadm_/add_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateAddress","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","maxLength":100,"description":"Cidade."},"state":{"type":"string","maxLength":100,"description":"Estado (sigla de duas letras, ex.: `SP`)."},"number":{"type":"string","maxLength":100,"description":"Número."},"street":{"type":"string","maxLength":255,"description":"Logradouro."},"country":{"type":"string","maxLength":3,"minLength":2,"description":"Código do país (ISO 3166-1, ex.: `BR`)."},"primary":{"type":"boolean","description":"Tornar este o endereço principal do cliente."},"district":{"type":"string","maxLength":100,"description":"Bairro."},"latitude":{"type":"string","maxLength":16,"description":"Latitude, em graus decimais como texto."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"postcode":{"type":"string","pattern":"^\\d{5}-?\\d{3}$","description":"CEP, 8 dígitos — o hífen é aceito."},"longitude":{"type":"string","maxLength":16,"description":"Longitude, em graus decimais como texto."},"complement":{"type":"string","maxLength":255,"description":"Complemento (apartamento, sala, bloco…)."}},"additionalProperties":false},"example":{"city":"string","state":"string","number":"1000","street":"string","country":"string","primary":true,"district":"string","latitude":"string","metadata":{},"postcode":"id_0a1b2c3d4e5f60718293","longitude":"string","complement":"string"}}},"required":true}},"patch":{"tags":["Addresses"],"summary":"Atualiza um endereço","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","ownerType","ownerId","street","number","complement","district","city","state","country","postcode","latitude","longitude","primary","line","line1","line2","line3","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$","description":"Identificador público (addr_/cad_/cadm_/add_…)"},"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"ownerId":{"type":"string","description":"Id público do dono."},"primary":{"type":"boolean","description":"Se é o endereço principal do dono."},"district":{"type":"string","nullable":true,"description":"Bairro."},"latitude":{"type":"string","nullable":true,"description":"Latitude, em graus decimais como texto; `null` quando desconhecida."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"postcode":{"type":"string","description":"CEP, só dígitos."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"longitude":{"type":"string","nullable":true,"description":"Longitude, em graus decimais como texto; `null` quando desconhecida."},"ownerType":{"enum":["vendor","customer","company","user"],"type":"string","description":"Quem é dono do endereço: um `customer`, a própria `company`, um `user` ou um `vendor`."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."}},"additionalProperties":false},"example":{"id":"addr_0a1b2c3d4e5f60718293","city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","_links":{},"number":"1000","street":"string","country":"string","ownerId":"string","primary":true,"district":"string","latitude":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"postcode":"string","createdAt":"string","longitude":"string","ownerType":"vendor","updatedAt":"string","complement":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"addressId","schema":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$"},"required":true,"description":"Identificador público (addr_/cad_/cadm_/add_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateAddress__patch","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","maxLength":100,"description":"Cidade."},"state":{"type":"string","maxLength":100,"description":"Estado (sigla de duas letras, ex.: `SP`)."},"number":{"type":"string","maxLength":100,"description":"Número."},"street":{"type":"string","maxLength":255,"description":"Logradouro."},"country":{"type":"string","maxLength":3,"minLength":2,"description":"Código do país (ISO 3166-1, ex.: `BR`)."},"primary":{"type":"boolean","description":"Tornar este o endereço principal do cliente."},"district":{"type":"string","maxLength":100,"description":"Bairro."},"latitude":{"type":"string","maxLength":16,"description":"Latitude, em graus decimais como texto."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"postcode":{"type":"string","pattern":"^\\d{5}-?\\d{3}$","description":"CEP, 8 dígitos — o hífen é aceito."},"longitude":{"type":"string","maxLength":16,"description":"Longitude, em graus decimais como texto."},"complement":{"type":"string","maxLength":255,"description":"Complemento (apartamento, sala, bloco…)."}},"additionalProperties":false},"example":{"city":"string","state":"string","number":"1000","street":"string","country":"string","primary":true,"district":"string","latitude":"string","metadata":{},"postcode":"id_0a1b2c3d4e5f60718293","longitude":"string","complement":"string"}}},"required":true}},"delete":{"tags":["Addresses"],"summary":"Exclui um endereço","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","description":"Id público do recurso excluído."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"resource":{"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"string","_links":{},"deleted":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"resource":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"addressId","schema":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$"},"required":true,"description":"Identificador público (addr_/cad_/cadm_/add_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteAddress"}},"/v1/utils/types-of-refund":{"get":{"tags":["Utils"],"summary":"Lista as categorias de estorno","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["categoryId","name"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome da categoria."},"categoryId":{"type":"integer","description":"Id da categoria."}},"additionalProperties":false},"description":"As categorias de estorno."}},"additionalProperties":false},"example":{"data":[{"name":"Acme Ltda","categoryId":0}]}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"utilsTypesOfRefund"}},"/v1/customers/{customerId}":{"get":{"tags":["Customers"],"summary":"Consulta um cliente","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","firstName","lastName","email","document","telephone","birthdate","gender","available","delinquent","externalReference","additionalEmails","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"cards":{"type":"array","items":{"type":"object","required":["id","holderName","brand","firstDigits","lastDigits","expirationMonth","expirationYear","primary","active","valid","verified","associated","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(card)_.+$","description":"Identificador público (card_…)"},"brand":{"type":"string","description":"Bandeira do cartão (ex.: `visa`, `mastercard`)."},"valid":{"type":"boolean","description":"Se o cartão passou na validação."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"active":{"type":"boolean","description":"Se o cartão pode ser cobrado."},"primary":{"type":"boolean","description":"Se é o cartão principal do cliente."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"verified":{"type":"boolean","description":"Se o cartão foi verificado com o emissor."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"associated":{"type":"boolean","nullable":true,"description":"Se o cartão está vinculado ao cliente para cobrança. `null` = pendente: o cartão entrou por uma tela do comprador e ainda não tem cobrança aprovada."},"holderName":{"type":"string","nullable":true,"description":"Nome impresso no cartão."},"lastDigits":{"type":"string","description":"Quatro últimos dígitos do cartão."},"firstDigits":{"type":"string","description":"Seis primeiros dígitos do cartão (BIN)."},"expirationYear":{"type":"string","description":"Ano de validade (`YYYY`)."},"expirationMonth":{"type":"string","description":"Mês de validade (`MM`)."}},"additionalProperties":false},"description":"Os cartões salvos do cliente (só na leitura individual)."},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail; `null` quando não há."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"gender":{"type":"string","nullable":true,"description":"Gênero (`male`, `female`, `other`); `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","nullable":true,"description":"Tipo do documento; `null` quando não há."},"number":{"type":"string","nullable":true,"description":"Número do documento (dígitos em CPF/CNPJ); `null` quando não há."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","description":"Sobrenome."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"addresses":{"type":"array","items":{"type":"object","required":["id","ownerType","ownerId","street","number","complement","district","city","state","country","postcode","latitude","longitude","primary","line","line1","line2","line3","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(addr|cad|cadm|add)_.+$","description":"Identificador público (addr_/cad_/cadm_/add_…)"},"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"ownerId":{"type":"string","description":"Id público do dono."},"primary":{"type":"boolean","description":"Se é o endereço principal do dono."},"district":{"type":"string","nullable":true,"description":"Bairro."},"latitude":{"type":"string","nullable":true,"description":"Latitude, em graus decimais como texto; `null` quando desconhecida."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"postcode":{"type":"string","description":"CEP, só dígitos."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"longitude":{"type":"string","nullable":true,"description":"Longitude, em graus decimais como texto; `null` quando desconhecida."},"ownerType":{"enum":["vendor","customer","company","user"],"type":"string","description":"Quem é dono do endereço: um `customer`, a própria `company`, um `user` ou um `vendor`."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."}},"additionalProperties":false},"description":"Os endereços do cliente (só na leitura individual)."},"available":{"type":"boolean","description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","description":"Se o cliente tem pagamentos em atraso."},"transactions":{"type":"array","items":{"type":"object","required":["id","customId","customerId","cardBrand","amount","originalAmount","status","method","currency","fees","approvedAt","updatedAt","createdAt","images"],"properties":{"id":{"type":"string","pattern":"^(tra|trx)_.+$","description":"Identificador público (tra_/trx_…)"},"fees":{"type":"integer","description":"Total de taxas, em centavos."},"amount":{"type":"string","description":"Valor cobrado, em centavos (como texto)."},"images":{"type":"array","items":{"type":"string"},"description":"URLs das imagens dos itens."},"method":{"type":"string","description":"Meio de pagamento."},"status":{"type":"string","description":"Status da cobrança."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"customId":{"type":"string","nullable":true,"description":"O seu id personalizado da cobrança; `null` em cobranças antigas."},"cardBrand":{"type":"string","nullable":true,"description":"Bandeira do cartão; `null` nos outros meios."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"approvedAt":{"type":"string","nullable":true,"description":"Quando a cobrança foi aprovada; `null` nos demais casos."},"customerId":{"type":"string","pattern":"^(cus)_.+$","nullable":true,"description":"O comprador."},"originalAmount":{"type":"string","description":"Valor antes dos descontos, em centavos (como texto)."}},"additionalProperties":false},"description":"As cobranças mais recentes do cliente (só na leitura individual)."},"subscriptions":{"type":"array","items":{"type":"object","required":["id","status","currency","method","type","currentCycle","customer","billing","canceledAt","cancellation","discount","discounts","renewalTerms","shippable","shipping","spplited","splits","items","callback","geolocation","externalReference","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(subs|sub)_.+$","description":"Identificador público (subs_/sub_…)"},"type":{"type":"string","nullable":true,"description":"Tipo da assinatura (`recurring`)."},"items":{"type":"array","items":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"description":"Os itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"method":{"type":"string","nullable":true,"description":"Como os ciclos são cobrados: `credit`, `pix` ou `billet`."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"Splits de cada cobrança de ciclo; `null` quando não há."},"status":{"enum":["active","trialing","pending","paused","pastdue","unpaid","canceled"],"type":"string","description":"Status: `active`, `trialing`, `pending`, `paused`, `pastdue`, `unpaid` ou `canceled`."},"billing":{"type":"object","required":["frequency","frequencyCount","endDate","exactDay","freeTrialDays","autoRenew","address"],"properties":{"address":{"type":"object","required":["street","number","complement","district","city","state","country","postcode","line","fingerprint","line1","line2","line3"],"properties":{"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","nullable":true,"description":"Bairro."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."},"fingerprint":{"type":"string","nullable":true,"description":"Impressão digital do endereço (deduplicação)."}},"description":"O endereço do pagador (usado no boleto de cada ciclo). Todos os campos `null` quando não há.","additionalProperties":false},"endDate":{"type":"string","nullable":true,"description":"Quando a assinatura termina; `null` = nunca."},"exactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que é cobrada; `null` quando não é fixo."},"autoRenew":{"type":"boolean","description":"Se a assinatura se renova sozinha no fim de cada período (`false` depois de um cancelamento no fim do período)."},"frequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança: `daily`, `weekly`, `monthly` ou `yearly`."},"freeTrialDays":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"frequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo."}},"description":"Periodicidade da cobrança e endereço do pagador.","additionalProperties":false},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","description":"URL que recebe os webhooks desta assinatura."}},"description":"Webhook próprio; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"customer":{"type":"object","required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","additionalEmails","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do cliente (`cus_…`)."},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail."},"gender":{"type":"string","nullable":true,"description":"Gênero; `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento."},"number":{"type":"string","nullable":true,"description":"Número do documento."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do cliente."}},"description":"O comprador.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"number","description":"O desconto."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado; `null` quando não há.","additionalProperties":false},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shipping":{"type":"object","nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há.","additionalProperties":{}},"spplited":{"type":"boolean","description":"Se as cobranças dos ciclos são divididas com outras contas (ver `splits`). O nome mantém a grafia histórica."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a assinatura tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando a assinatura foi encerrada; `null` enquanto está viva."},"geolocation":{"type":"object","nullable":true,"description":"Sinais de dispositivo e localização do comprador, como enviados; `null` quando não há.","additionalProperties":{}},"cancellation":{"type":"object","nullable":true,"required":["reasonCode","reason","canceledBy"],"properties":{"reason":{"type":"string","nullable":true,"description":"O texto livre escrito por quem cancelou."},"canceledBy":{"enum":["seller","customer","platform"],"type":"string","nullable":true,"description":"`seller` (API ou painel), `customer` (portal) ou `platform` (régua de cobrança, chargeback, estorno)."},"reasonCode":{"enum":["price","not_using","technical_issue","switched_provider","other"],"type":"string","nullable":true,"description":"O motivo da lista; `null` nos cancelamentos antigos e nos da própria plataforma."}},"description":"Por que foi cancelada; `null` enquanto ninguém pediu o cancelamento.","additionalProperties":false},"currentCycle":{"type":"object","nullable":true,"required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"description":"O ciclo de cobrança atual; `null` quando não há.","additionalProperties":false},"pixAutomatic":{"type":"object","nullable":true,"required":["status","journey","qrCodeEmv","qrCodeUrl","valueCents","firstChargeDate","approvedAt","endReason"],"properties":{"status":{"enum":["pending","awaitingAuthorization","active","rejected","ended"],"type":"string","description":"`pending` (sendo criado) · `awaitingAuthorization` (QR code exibido) · `active` (debitado a cada ciclo) · `rejected` (o pagador recusou ou revogou) · `ended`. Depois de `rejected`/`ended` os ciclos são cobrados por um QR code cada."},"journey":{"enum":["paymentOnApproval","onlyRecurrency"],"type":"string","description":"`paymentOnApproval`: o primeiro ciclo é pago junto com a autorização; `onlyRecurrency`: só a recorrência é autorizada."},"endReason":{"type":"string","nullable":true,"description":"Por que terminou; `null` enquanto ativo."},"qrCodeEmv":{"type":"string","nullable":true,"description":"O QR code de autorização (copia e cola) — só enquanto `awaitingAuthorization`."},"qrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code de autorização — só enquanto `awaitingAuthorization`."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o pagador autorizou; `null` até lá."},"valueCents":{"type":"integer","description":"O valor fixo debitado a cada ciclo, em centavos."},"firstChargeDate":{"type":"string","description":"Data do primeiro débito."}},"description":"Só na leitura individual; `null` quando a assinatura não é paga por Pix Automático.","additionalProperties":false},"renewalTerms":{"type":"object","nullable":true,"required":["shipping","shippingAmount","methodDiscount","discountMethod","discountPercentage"],"properties":{"shipping":{"type":"boolean","description":"Se o frete é cobrado em cada renovação."},"discountMethod":{"enum":["credit","pix","billet"],"type":"string","nullable":true,"description":"O meio que concedeu o desconto no checkout; `null` quando nenhum."},"methodDiscount":{"type":"boolean","description":"Se o desconto do meio de pagamento vale nas renovações cobradas por `discountMethod`."},"shippingAmount":{"type":"integer","description":"O frete cotado no checkout, em centavos (0 = sem frete)."},"discountPercentage":{"type":"number","description":"O desconto desse meio, como percentual (ex.: 5 = 5%)."}},"description":"O que cada renovação cobra além dos itens, congelado na criação; `null` = nada congelado (as renovações cobram itens menos cupons).","additionalProperties":false},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da assinatura; `null` quando não há."}},"additionalProperties":false},"description":"As assinaturas mais recentes do cliente (só na leitura individual)."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails do comprador; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador deste cliente; `null` quando não há."}},"additionalProperties":false},"example":{"id":"cus_0a1b2c3d4e5f60718293","cards":[{"id":"card_0a1b2c3d4e5f60718293","brand":"string","valid":true,"_links":{},"active":true,"primary":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"verified":true,"createdAt":"string","updatedAt":"string","associated":true,"holderName":"JOAO SILVA","lastDigits":"string","firstDigits":"string","expirationYear":"string","expirationMonth":"string"}],"email":"buyer@example.com","_links":{},"gender":"string","document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"addresses":[{"id":"addr_0a1b2c3d4e5f60718293","city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","_links":{},"number":"1000","street":"string","country":"string","ownerId":"string","primary":true,"district":"string","latitude":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"postcode":"string","createdAt":"string","longitude":"string","ownerType":"vendor","updatedAt":"string","complement":"string"}],"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"transactions":[{"id":"tra_0a1b2c3d4e5f60718293","fees":5000,"amount":"string","images":["string"],"method":"string","status":"string","currency":"BRL","customId":"string","cardBrand":"string","createdAt":"string","updatedAt":"string","approvedAt":"string","customerId":"cus_0a1b2c3d4e5f60718293","originalAmount":"string"}],"subscriptions":[{"id":"subs_0a1b2c3d4e5f60718293","type":"string","items":[{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","images":["string"],"enabled":true,"currency":"BRL","metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}],"_links":{},"method":"string","splits":[{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"liable":true,"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}],"status":"active","billing":{"address":{"city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","number":"1000","street":"string","country":"string","district":"string","postcode":"string","complement":"string","fingerprint":"string"},"endDate":"string","exactDay":0,"autoRenew":true,"frequency":"string","freeTrialDays":0,"frequencyCount":0},"callback":{"active":true,"webhookUrl":"string"},"currency":"BRL","customer":{"id":"string","email":"buyer@example.com","gender":"string","document":{"type":"string","number":"12345678909"},"lastName":"Silva","metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"},"discount":{"type":"string","value":5000,"percentageOfAmount":5000},"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shipping":{},"spplited":true,"createdAt":"string","discounts":[],"shippable":true,"updatedAt":"string","canceledAt":"string","geolocation":{},"cancellation":{"reason":"string","canceledBy":"seller","reasonCode":"price"},"currentCycle":{"id":"scy_0a1b2c3d4e5f60718293","cycle":0,"status":"string","dueDate":"string","endDate":"string","billedAt":"string","createdAt":"string","startDate":"string","updatedAt":"string"},"pixAutomatic":{"status":"pending","journey":"paymentOnApproval","endReason":"string","qrCodeEmv":"string","qrCodeUrl":"string","approvedAt":"string","valueCents":5000,"firstChargeDate":"string"},"renewalTerms":{"shipping":true,"discountMethod":"credit","methodDiscount":true,"shippingAmount":5000,"discountPercentage":0},"externalReference":"string"}],"additionalEmails":["string"],"externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"customerId","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":true,"description":"Identificador público (cus_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getCustomer"},"put":{"tags":["Customers"],"summary":"Atualiza um cliente","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","firstName","lastName","email","document","telephone","birthdate","gender","available","delinquent","externalReference","additionalEmails","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail; `null` quando não há."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"gender":{"type":"string","nullable":true,"description":"Gênero (`male`, `female`, `other`); `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","nullable":true,"description":"Tipo do documento; `null` quando não há."},"number":{"type":"string","nullable":true,"description":"Número do documento (dígitos em CPF/CNPJ); `null` quando não há."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","description":"Sobrenome."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails do comprador; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador deste cliente; `null` quando não há."}},"additionalProperties":false},"example":{"id":"cus_0a1b2c3d4e5f60718293","email":"buyer@example.com","_links":{},"gender":"string","document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"customerId","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":true,"description":"Identificador público (cus_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateCustomer__put","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Endereço de e-mail do comprador."},"gender":{"enum":["male","female","other"],"type":"string","description":"Gênero: `male`, `female` ou `other`."},"document":{"type":"object","properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","description":"Tipo do documento: `cpf`, `cnpj` ou `passport`."},"number":{"type":"string","maxLength":20,"minLength":5,"description":"Número do documento: dígitos do CPF ou CNPJ, ou o número do passaporte."}},"description":"Documento do comprador (CPF, CNPJ ou passaporte). As duas partes são opcionais: pode vir depois, ou com a cobrança.","additionalProperties":false},"lastName":{"type":"string","maxLength":255,"minLength":1,"description":"Sobrenome."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"birthdate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data de nascimento, `YYYY-MM-DD`."},"firstName":{"type":"string","maxLength":255,"minLength":2,"description":"Nome."},"telephone":{"type":"object","properties":{"line":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":7,"description":"O número inteiro com código do país e DDD (ex.: `5511987654321`). O único telefone que chega ao provedor de pagamento."},"number":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":6,"description":"Número local, só dígitos."},"areaCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"DDD (ex.: `11`)."},"countryCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"Código do país (ex.: `55`)."}},"description":"Telefone do comprador, em partes. Cada parte é opcional; `line` é o número inteiro.","additionalProperties":false},"additionalEmails":{"type":"array","items":{"type":"string","format":"email","description":"Endereço de e-mail (normalizado em minúsculas)."},"maxItems":20,"description":"Outros e-mails do comprador (até 20)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador deste cliente (texto livre, devolvido como veio)."}},"additionalProperties":false},"example":{"email":"buyer@example.com","gender":"male","document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","metadata":{},"birthdate":"1990-05-20","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"additionalEmails":["buyer@example.com"],"externalReference":"string"}}},"required":true}},"patch":{"tags":["Customers"],"summary":"Atualiza um cliente","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","firstName","lastName","email","document","telephone","birthdate","gender","available","delinquent","externalReference","additionalEmails","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail; `null` quando não há."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"gender":{"type":"string","nullable":true,"description":"Gênero (`male`, `female`, `other`); `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","nullable":true,"description":"Tipo do documento; `null` quando não há."},"number":{"type":"string","nullable":true,"description":"Número do documento (dígitos em CPF/CNPJ); `null` quando não há."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","description":"Sobrenome."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails do comprador; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador deste cliente; `null` quando não há."}},"additionalProperties":false},"example":{"id":"cus_0a1b2c3d4e5f60718293","email":"buyer@example.com","_links":{},"gender":"string","document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"customerId","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":true,"description":"Identificador público (cus_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateCustomer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Endereço de e-mail do comprador."},"gender":{"enum":["male","female","other"],"type":"string","description":"Gênero: `male`, `female` ou `other`."},"document":{"type":"object","properties":{"type":{"enum":["cpf","cnpj","passport"],"type":"string","description":"Tipo do documento: `cpf`, `cnpj` ou `passport`."},"number":{"type":"string","maxLength":20,"minLength":5,"description":"Número do documento: dígitos do CPF ou CNPJ, ou o número do passaporte."}},"description":"Documento do comprador (CPF, CNPJ ou passaporte). As duas partes são opcionais: pode vir depois, ou com a cobrança.","additionalProperties":false},"lastName":{"type":"string","maxLength":255,"minLength":1,"description":"Sobrenome."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"birthdate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data de nascimento, `YYYY-MM-DD`."},"firstName":{"type":"string","maxLength":255,"minLength":2,"description":"Nome."},"telephone":{"type":"object","properties":{"line":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":7,"description":"O número inteiro com código do país e DDD (ex.: `5511987654321`). O único telefone que chega ao provedor de pagamento."},"number":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":6,"description":"Número local, só dígitos."},"areaCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"DDD (ex.: `11`)."},"countryCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"Código do país (ex.: `55`)."}},"description":"Telefone do comprador, em partes. Cada parte é opcional; `line` é o número inteiro.","additionalProperties":false},"additionalEmails":{"type":"array","items":{"type":"string","format":"email","description":"Endereço de e-mail (normalizado em minúsculas)."},"maxItems":20,"description":"Outros e-mails do comprador (até 20)."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador deste cliente (texto livre, devolvido como veio)."}},"additionalProperties":false},"example":{"email":"buyer@example.com","gender":"male","document":{"type":"cpf","number":"12345678909"},"lastName":"Silva","metadata":{},"birthdate":"1990-05-20","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"additionalEmails":["buyer@example.com"],"externalReference":"string"}}},"required":true}},"delete":{"tags":["Customers"],"summary":"Exclui um cliente","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","description":"Id público do recurso excluído."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"resource":{"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"string","_links":{},"deleted":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"resource":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"customerId","schema":{"type":"string","pattern":"^(cus)_.+$"},"required":true,"description":"Identificador público (cus_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteCustomer"}},"/v1/simulators/installment":{"get":{"tags":["Simulators"],"summary":"Simula as taxas e os totais de um número de parcelas (cartão/NuPay)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["resource","isCustom","amount","original","totalFees","_links"],"properties":{"_links":{"type":"object","required":["self","installments","paymentMethods"],"properties":{"self":{"type":"object","required":["href","method"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."}},"description":"Um link para uma operação relacionada.","additionalProperties":false},"installments":{"type":"object","required":["href","method"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."}},"description":"Um link para uma operação relacionada.","additionalProperties":false},"paymentMethods":{"type":"object","required":["href","method"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"description":"Links para os outros simuladores.","additionalProperties":false},"amount":{"type":"object","required":["cents","decimal"],"properties":{"cents":{"type":"integer","description":"Em centavos."},"decimal":{"type":"number","description":"Em reais (decimal)."}},"description":"O que o comprador paga.","additionalProperties":false},"isCustom":{"type":"boolean","description":"Se um `fee` personalizado foi usado no lugar da configuração da conta."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"original":{"type":"object","required":["cents","decimal"],"properties":{"cents":{"type":"integer","description":"Em centavos."},"decimal":{"type":"number","description":"Em reais (decimal)."}},"description":"O valor simulado.","additionalProperties":false},"resource":{"enum":["nupay","credit"],"type":"string","description":"O meio simulado."},"totalFees":{"type":"object","required":["cents","decimal"],"properties":{"cents":{"type":"integer","description":"Em centavos."},"decimal":{"type":"number","description":"Em reais (decimal)."}},"description":"As taxas por cima do valor.","additionalProperties":false}},"additionalProperties":false},"example":{"_links":{"self":{"href":"string","method":"string"},"installments":{"href":"string","method":"string"},"paymentMethods":{"href":"string","method":"string"}},"amount":{"cents":5000,"decimal":0},"isCustom":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"original":{"cents":5000,"decimal":0},"resource":"nupay","totalFees":{"cents":5000,"decimal":0}}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"amount","schema":{"type":"integer","maximum":20000000,"minimum":500},"required":true,"description":"Valor a simular, em centavos (mínimo 500)."},{"in":"query","name":"fee","schema":{"type":"number","maximum":100,"minimum":0},"required":false,"description":"Juros a simular, como percentual (0–100), no lugar dos configurados na sua conta."},{"in":"query","name":"installment","schema":{"type":"integer","maximum":24,"minimum":1},"required":true,"description":"Número de parcelas."},{"in":"query","name":"resource","schema":{"enum":["nupay","credit"],"type":"string","default":"credit"},"required":false,"description":"`credit` ou `nupay`."},{"in":"query","name":"brand","schema":{"type":"string","maxLength":50},"required":false,"description":"Aceito por compatibilidade; não muda os totais."}],"operationId":"simulateInstallment"}},"/v1/utils/types-of-company":{"get":{"tags":["Utils"],"summary":"Lista as categorias de empresa","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["categoryId","mcc","code","name","description"],"properties":{"mcc":{"type":"string","nullable":true,"description":"Código de categoria do estabelecimento (MCC)."},"code":{"type":"string","nullable":true,"description":"Código da categoria."},"name":{"type":"string","nullable":true,"description":"Nome da categoria."},"categoryId":{"type":"integer","description":"Id da categoria."},"description":{"type":"string","nullable":true,"description":"Descrição."}},"additionalProperties":false},"description":"As categorias de negócio com que uma empresa pode se cadastrar."}},"additionalProperties":false},"example":{"data":[{"mcc":"string","code":"string","name":"Acme Ltda","categoryId":0,"description":"string"}]}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"utilsTypesOfCompany"}},"/v1/checkouts/payment-links":{"get":{"tags":["Checkout"],"summary":"Lista os links de pagamento","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","name","type","enabled","accessId","signature","accessFullUrl","sessionId","editable","items","discounts","customInputs","expiresAt","availableAt","templateId","integrationId","domainId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(link)_.+$","description":"Identificador público (link_…)"},"name":{"type":"string","description":"Nome do link."},"type":{"type":"string","nullable":true,"description":"Tipo do link (histórico; sempre o tipo persistido)."},"items":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"O carrinho fixo do link."},"enabled":{"type":"boolean","description":"Se o link abre."},"accessId":{"type":"string","description":"O id público de acesso na URL."},"domainId":{"type":"string","nullable":true,"description":"O host em que a URL é montada; `null` = a escolha automática."},"editable":{"type":"boolean","description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Códigos de cupom aplicados quando o link abre; `null` quando não há."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o link deixa de abrir; `null` = nunca."},"sessionId":{"type":"string","nullable":true,"description":"A sessão de checkout ligada ao link, quando há."},"signature":{"type":"string","description":"A assinatura da URL."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"templateId":{"type":"string","nullable":true,"description":"O template de checkout; `null` = o checkout padrão."},"availableAt":{"type":"string","nullable":true,"description":"Quando o link passa a abrir; `null` = já abre."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"nullable":true,"description":"Campos extras que o checkout pede ao comprador; `null` quando não há."},"accessFullUrl":{"type":"string","nullable":true,"description":"A URL para compartilhar com os compradores."},"integrationId":{"type":"string","nullable":true,"description":"A integração a que uma venda pelo link pertence; `null` quando não há."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."}},"additionalProperties":false},"example":{"data":[{"id":"link_0a1b2c3d4e5f60718293","name":"Acme Ltda","type":"string","items":[{}],"enabled":true,"accessId":"string","domainId":"string","editable":true,"metadata":{},"createdAt":"string","discounts":[],"expiresAt":"string","sessionId":"string","signature":"string","updatedAt":"string","templateId":"string","availableAt":"string","customInputs":[{}],"accessFullUrl":"string","integrationId":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"offset":0,"hasMore":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"status","schema":{"enum":["enabled","disabled"],"type":"string"},"required":false,"description":"Só links ligados (`enabled`) ou desligados (`disabled`)."},{"in":"query","name":"templateId","schema":{"anyOf":[{"type":"string","pattern":"^(tmpl|ckt)_.+$","description":"Identificador público (tmpl_/ckt_…)"},{"enum":["default"],"type":"string"}]},"required":false,"description":"Só links neste template de checkout, ou `default` para os sem template."},{"in":"query","name":"domainId","schema":{"type":"string","pattern":"^(dmn|host|cdm)_.+$"},"required":false,"description":"Identificador público (dmn_/host_/cdm_…)"},{"in":"query","name":"q","schema":{"type":"string","maxLength":120,"minLength":1},"required":false,"description":"Links cujo nome contém este texto (sem diferenciar maiúsculas)."},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listCheckoutPaymentLinks"},"post":{"tags":["Checkout"],"summary":"Cria um link de pagamento","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","type","enabled","accessId","signature","accessFullUrl","sessionId","editable","items","discounts","customInputs","expiresAt","availableAt","templateId","integrationId","domainId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(link)_.+$","description":"Identificador público (link_…)"},"name":{"type":"string","description":"Nome do link."},"type":{"type":"string","nullable":true,"description":"Tipo do link (histórico; sempre o tipo persistido)."},"items":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"O carrinho fixo do link."},"enabled":{"type":"boolean","description":"Se o link abre."},"accessId":{"type":"string","description":"O id público de acesso na URL."},"domainId":{"type":"string","nullable":true,"description":"O host em que a URL é montada; `null` = a escolha automática."},"editable":{"type":"boolean","description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Códigos de cupom aplicados quando o link abre; `null` quando não há."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o link deixa de abrir; `null` = nunca."},"sessionId":{"type":"string","nullable":true,"description":"A sessão de checkout ligada ao link, quando há."},"signature":{"type":"string","description":"A assinatura da URL."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"templateId":{"type":"string","nullable":true,"description":"O template de checkout; `null` = o checkout padrão."},"availableAt":{"type":"string","nullable":true,"description":"Quando o link passa a abrir; `null` = já abre."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"nullable":true,"description":"Campos extras que o checkout pede ao comprador; `null` quando não há."},"accessFullUrl":{"type":"string","nullable":true,"description":"A URL para compartilhar com os compradores."},"integrationId":{"type":"string","nullable":true,"description":"A integração a que uma venda pelo link pertence; `null` quando não há."}},"additionalProperties":false},"example":{"id":"link_0a1b2c3d4e5f60718293","name":"Acme Ltda","type":"string","items":[{}],"enabled":true,"accessId":"string","domainId":"string","editable":true,"metadata":{},"createdAt":"string","discounts":[],"expiresAt":"string","sessionId":"string","signature":"string","updatedAt":"string","templateId":"string","availableAt":"string","customInputs":[{}],"accessFullUrl":"string","integrationId":"string"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createCheckoutPaymentLink","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","items"],"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"description":"Nome do link, para a sua referência."},"items":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Uma variante do seu catálogo."},"quantity":{"type":"integer","default":1,"maximum":100000,"minimum":1,"description":"Quantidade."}},"description":"Uma linha do carrinho do link.","additionalProperties":false},"maxItems":100,"minItems":1,"description":"O carrinho fixo do link (1 a 100 linhas)."},"domainId":{"type":"string","pattern":"^(dmn|host|cdm)_.+$","description":"O host em que a URL é montada: um dos seus domínios de checkout prontos, ou `dmn_shared` (o host da plataforma). Omitido = o seu domínio pronto mais antigo, senão o host da plataforma."},"editable":{"type":"boolean","default":false,"description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"discounts":{"type":"array","items":{"type":"string","maxLength":50,"minLength":1},"maxItems":20,"description":"Códigos de cupom aplicados quando o link abre (validados na cobrança)."},"expiresAt":{"type":"string","format":"date-time","description":"Quando o link deixa de abrir."},"templateId":{"type":"string","pattern":"^(tmpl|ckt)_.+$","description":"Um template de checkout seu (aparência); omitido = o checkout padrão."},"availableAt":{"type":"string","format":"date-time","description":"Quando o link passa a abrir."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"maxItems":50,"description":"Campos extras que o checkout pede ao comprador (JSON livre, até 50)."},"integrationId":{"type":"string","pattern":"^(app)_.+$","description":"A integração a que uma venda por este link pertence (`app_…`): a sessão de checkout é marcada com ela."}},"additionalProperties":false},"example":{"name":"Acme Ltda","items":[{"id":"var_0a1b2c3d4e5f60718293","quantity":1}],"domainId":"dmn_0a1b2c3d4e5f60718293","editable":false,"metadata":{},"discounts":["string"],"expiresAt":"2026-01-15T12:00:00.000Z","templateId":"tmpl_0a1b2c3d4e5f60718293","availableAt":"2026-01-15T12:00:00.000Z","customInputs":[{}],"integrationId":"app_0a1b2c3d4e5f60718293"}}},"required":true}}},"/v1/marketplace/kyc/{token}":{"get":{"tags":["Marketplace"],"summary":"Pré-visualiza um link de credenciamento (validade + nome da sub-conta)","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["companyName","expiresAt","requestedBy"],"properties":{"expiresAt":{"type":"string","description":"Quando o link expira."},"companyName":{"type":"string","nullable":true,"description":"Nome da sub-conta, para o cabeçalho do formulário."},"requestedBy":{"type":"object","nullable":true,"required":["name"],"properties":{"name":{"type":"string","description":"Nome da plataforma."}},"description":"A plataforma que pediu os documentos; `null` quando ela não tem nome.","additionalProperties":false}},"additionalProperties":false},"example":{"expiresAt":"string","companyName":"string","requestedBy":{"name":"Acme Ltda"}}}},"description":"Sucesso"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"previewKycLink"}},"/v1/simulators/installments":{"get":{"tags":["Simulators"],"summary":"Simula a tabela de parcelamento de um valor","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["planId","resource","installments","_links"],"properties":{"_links":{"type":"object","required":["self","installment","paymentMethods"],"properties":{"self":{"type":"object","required":["href","method"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."}},"description":"Um link para uma operação relacionada.","additionalProperties":false},"installment":{"type":"object","required":["href","method"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."}},"description":"Um link para uma operação relacionada.","additionalProperties":false},"paymentMethods":{"type":"object","required":["href","method"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"description":"Links para os outros simuladores.","additionalProperties":false},"planId":{"type":"string","nullable":true,"description":"O plano de taxas usado; `null` quando a conta não tem."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"resource":{"enum":["credit","nupay"],"type":"string","description":"O meio simulado."},"installments":{"type":"array","items":{"type":"object","required":["installment","installmentAmountCents","totalAmountCents","extraFee","description"],"properties":{"extraFee":{"type":"boolean","description":"Se o comprador paga juros nesta opção."},"description":{"type":"string","description":"A opção, em texto (ex.: `3x de R$ 17,20`)."},"installment":{"type":"integer","description":"Número de parcelas."},"totalAmountCents":{"type":"integer","description":"Total pago pelo comprador, em centavos (igual a `amount` quando sem juros)."},"installmentAmountCents":{"type":"integer","description":"Valor de cada parcela, em centavos."}},"description":"Uma opção de parcelamento.","additionalProperties":false},"description":"As opções de parcelamento, de 1 até o máximo da sua conta."}},"additionalProperties":false},"example":{"_links":{"self":{"href":"string","method":"string"},"installment":{"href":"string","method":"string"},"paymentMethods":{"href":"string","method":"string"}},"planId":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"resource":"credit","installments":[{"extraFee":true,"description":"string","installment":0,"totalAmountCents":5000,"installmentAmountCents":5000}]}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"amount","schema":{"type":"integer","maximum":20000000,"minimum":500},"required":true,"description":"Valor a simular, em centavos (mínimo 500)."},{"in":"query","name":"fee","schema":{"type":"number","maximum":100,"minimum":0},"required":false,"description":"Juros a simular, como percentual (0–100), no lugar dos configurados na sua conta."},{"in":"query","name":"resource","schema":{"enum":["credit","nupay"],"type":"string","default":"credit"},"required":false,"description":"`credit` ou `nupay`."},{"in":"query","name":"model","schema":{"type":"string","maxLength":50},"required":false,"description":"Aceito por compatibilidade; sem efeito."}],"operationId":"simulateInstallments"}},"/v1/utils/types-of-webhooks":{"get":{"tags":["Utils"],"summary":"Lista os tipos de evento de webhook disponíveis","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["key","group","description"],"properties":{"key":{"type":"string","description":"Tipo do evento (ex.: `transaction.approved`)."},"group":{"type":"string","description":"O grupo de recursos a que pertence."},"description":{"type":"string","description":"Quando é enviado."}},"additionalProperties":false},"description":"Os tipos de evento que um endpoint de webhook pode assinar."}},"additionalProperties":false},"example":{"data":[{"key":"string","group":"string","description":"string"}]}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"utilsTypesOfWebhooks"}},"/v1/balance/debt-settlements":{"get":{"tags":["Finance"],"summary":"Lista as quitações de dívida (o registro de cada acerto de saldo negativo)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["object","id","status","owedAtIssuance","amount","paidAmount","refundedAmount","currency","pix","expiresAt","paidAt","createdAt"],"properties":{"id":{"type":"string","description":"Id público da quitação."},"pix":{"type":"object","nullable":true,"required":["qrCodeEmv"],"properties":{"qrCodeEmv":{"type":"string","nullable":true,"description":"Código copia e cola do Pix."}},"description":"O Pix a pagar — só enquanto `pending`.","additionalProperties":false},"amount":{"type":"integer","description":"Valor do Pix, em centavos."},"object":{"enum":["debt_settlement"],"type":"string","description":"Sempre `debt_settlement`."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi pago; `null` até lá."},"status":{"enum":["pending","paid","expired","refunded"],"type":"string","description":"`pending` (Pix em aberto), `paid`, `expired` (não pago) ou `refunded`."},"currency":{"enum":["BRL"],"type":"string","description":"Sempre `BRL`."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o Pix expira."},"paidAmount":{"type":"integer","nullable":true,"description":"O que foi pago, em centavos; `null` até ser pago. O que passar da dívida vira saldo disponível."},"owedAtIssuance":{"type":"integer","description":"O que se devia quando o Pix foi emitido, em centavos."},"refundedAmount":{"type":"integer","description":"O que foi estornado dele, em centavos."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"string","pix":{"qrCodeEmv":"string"},"amount":5000,"object":"debt_settlement","paidAt":"string","status":"pending","currency":"BRL","createdAt":"string","expiresAt":"string","paidAmount":5000,"owedAtIssuance":0,"refundedAmount":5000}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listDebtSettlements"},"post":{"tags":["Finance"],"summary":"Emite (ou devolve o já aberto) Pix para quitar um saldo negativo","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["object","id","status","owedAtIssuance","amount","paidAmount","refundedAmount","currency","pix","expiresAt","paidAt","createdAt"],"properties":{"id":{"type":"string","description":"Id público da quitação."},"pix":{"type":"object","nullable":true,"required":["qrCodeEmv"],"properties":{"qrCodeEmv":{"type":"string","nullable":true,"description":"Código copia e cola do Pix."}},"description":"O Pix a pagar — só enquanto `pending`.","additionalProperties":false},"amount":{"type":"integer","description":"Valor do Pix, em centavos."},"object":{"enum":["debt_settlement"],"type":"string","description":"Sempre `debt_settlement`."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi pago; `null` até lá."},"status":{"enum":["pending","paid","expired","refunded"],"type":"string","description":"`pending` (Pix em aberto), `paid`, `expired` (não pago) ou `refunded`."},"currency":{"enum":["BRL"],"type":"string","description":"Sempre `BRL`."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o Pix expira."},"paidAmount":{"type":"integer","nullable":true,"description":"O que foi pago, em centavos; `null` até ser pago. O que passar da dívida vira saldo disponível."},"owedAtIssuance":{"type":"integer","description":"O que se devia quando o Pix foi emitido, em centavos."},"refundedAmount":{"type":"integer","description":"O que foi estornado dele, em centavos."}},"additionalProperties":false},"example":{"id":"string","pix":{"qrCodeEmv":"string"},"amount":5000,"object":"debt_settlement","paidAt":"string","status":"pending","currency":"BRL","createdAt":"string","expiresAt":"string","paidAmount":5000,"owedAtIssuance":0,"refundedAmount":5000}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createDebtSettlement"}},"/v1/marketplace/sub-accounts":{"get":{"tags":["Marketplace"],"summary":"Lista as suas sub-contas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","name","status","platformFee","planId","createdAt","kycSubmittedAt","approvedAt","volume30dCents"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"name":{"type":"string","description":"Nome do vendedor."},"planId":{"type":"string","pattern":"^(rate)_.+$","nullable":true,"description":"O plano de taxas atribuído; `null` quando a sub-conta usa `platformFee` ou nenhum."},"status":{"type":"string","nullable":true,"description":"Status do cadastro: `pending`, `analyzing`, `awaiting-documents`, `active`, `disabled`…"},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o cadastro foi aprovado; `null` quando nunca."},"platformFee":{"type":"object","nullable":true,"required":["type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor em centavos, conforme `type`."}},"description":"A taxa da plataforma sobre as vendas da sub-conta; `null` quando não há (ou quando vale um plano de taxas).","additionalProperties":false},"kycSubmittedAt":{"type":"string","nullable":true,"description":"Quando a sub-conta concluiu o cadastro e a análise começou; `null` enquanto ela ainda não enviou."},"volume30dCents":{"type":"integer","nullable":true,"description":"Vendas aprovadas da sub-conta nos últimos 30 dias, em centavos (só produção); `null` quando não foi possível ler."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."}},"additionalProperties":false},"example":{"data":[{"id":"bus_0a1b2c3d4e5f60718293","name":"Acme Ltda","planId":"rate_0a1b2c3d4e5f60718293","status":"string","createdAt":"string","approvedAt":"string","platformFee":{"type":"percentage","value":5000},"kycSubmittedAt":"string","volume30dCents":5000}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"offset":0,"hasMore":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"status","schema":{"type":"string","maxLength":40,"minLength":1},"required":false,"description":"Só sub-contas com este status (`pending`, `analyzing`, `awaiting-documents`, `active`…)."},{"in":"query","name":"q","schema":{"type":"string","maxLength":120,"minLength":1},"required":false,"description":"Sub-contas cujo nome contém este texto (sem diferenciar maiúsculas)."},{"in":"query","name":"planId","schema":{"anyOf":[{"type":"string","pattern":"^(rate)_.+$","description":"Identificador público (rate_…)"},{"enum":["none"],"type":"string"}]},"required":false,"description":"Só sub-contas neste plano de taxas, ou `none` para as sem plano."}],"operationId":"listSubAccounts"},"post":{"tags":["Marketplace"],"summary":"Cria uma sub-conta sob a sua conta","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","status","platformFee","planId","createdAt","kycSubmittedAt","approvedAt","volume30dCents"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"name":{"type":"string","description":"Nome do vendedor."},"planId":{"type":"string","pattern":"^(rate)_.+$","nullable":true,"description":"O plano de taxas atribuído; `null` quando a sub-conta usa `platformFee` ou nenhum."},"status":{"type":"string","nullable":true,"description":"Status do cadastro: `pending`, `analyzing`, `awaiting-documents`, `active`, `disabled`…"},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o cadastro foi aprovado; `null` quando nunca."},"platformFee":{"type":"object","nullable":true,"required":["type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor em centavos, conforme `type`."}},"description":"A taxa da plataforma sobre as vendas da sub-conta; `null` quando não há (ou quando vale um plano de taxas).","additionalProperties":false},"kycSubmittedAt":{"type":"string","nullable":true,"description":"Quando a sub-conta concluiu o cadastro e a análise começou; `null` enquanto ela ainda não enviou."},"volume30dCents":{"type":"integer","nullable":true,"description":"Vendas aprovadas da sub-conta nos últimos 30 dias, em centavos (só produção); `null` quando não foi possível ler."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","name":"Acme Ltda","planId":"rate_0a1b2c3d4e5f60718293","status":"string","createdAt":"string","approvedAt":"string","platformFee":{"type":"percentage","value":5000},"kycSubmittedAt":"string","volume30dCents":5000}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"createSubAccount","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["companyName"],"properties":{"planId":{"type":"string","pattern":"^(rate)_.+$","description":"Um plano de taxas seu (`rate_…`), no lugar de `platformFee`. Omita os dois para deixar a sub-conta sem taxa."},"companyName":{"type":"string","maxLength":100,"minLength":1,"description":"Nome do vendedor."},"platformFee":{"type":"object","required":["type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` (de cada venda) ou `flat` (centavos por venda)."},"value":{"type":"number","minimum":0,"description":"O percentual (0–100) ou o valor em centavos, conforme `type`.","exclusiveMinimum":true}},"description":"A taxa da plataforma que você cobra sobre as vendas da sub-conta: um percentual ou um valor fixo.","additionalProperties":false}},"additionalProperties":false},"example":{"planId":"rate_0a1b2c3d4e5f60718293","companyName":"string","platformFee":{"type":"percentage","value":5000}}}},"required":true},"x-account-level":"always"}},"/v1/withdrawals/destinations":{"get":{"tags":["Withdrawals"],"summary":"Para onde os saques são pagos (o destino por chave Pix das vendas no Pix)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["pixKey"],"properties":{"pixKey":{"type":"object","nullable":true,"required":["appliesTo","keyType","keyMasked","holderName","status","canRecheck","recheckAvailableInSeconds","checkedAt"],"properties":{"status":{"enum":["active","pending","keyNotRegistered","documentMissing","blocked","inactive"],"type":"string","description":"`active` (os saques fluem) · `pending` (em conferência) · `keyNotRegistered` (cadastre a chave do seu CPF/CNPJ no seu banco) · `documentMissing` · `blocked` · `inactive`."},"keyType":{"enum":["cpf","cnpj"],"type":"string","nullable":true,"description":"Tipo da chave Pix: `cpf` ou `cnpj`."},"appliesTo":{"enum":["pixSales"],"type":"string","description":"Sempre `pixSales`: este destino recebe a parte do saque que veio do Pix."},"checkedAt":{"type":"string","nullable":true,"description":"Quando a chave foi conferida pela última vez; `null` quando nunca."},"keyMasked":{"type":"string","nullable":true,"description":"A chave Pix, mascarada."},"canRecheck":{"type":"boolean","description":"Se `POST /v1/withdrawals/destinations/pix-key/recheck` pode ser chamado agora."},"holderName":{"type":"string","nullable":true,"description":"Nome do titular da chave."},"recheckAvailableInSeconds":{"type":"integer","description":"Segundos até a próxima reconferência ser permitida (0 = agora)."}},"description":"`null` quando as suas vendas no Pix não ficam separadas (cada parte de um saque vai para a conta bancária escolhida).","additionalProperties":false}},"additionalProperties":false},"example":{"pixKey":{"status":"active","keyType":"cpf","appliesTo":"pixSales","checkedAt":"string","keyMasked":"string","canRecheck":true,"holderName":"JOAO SILVA","recheckAvailableInSeconds":0}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getWithdrawalDestinations"}},"/v1/utils/card-bin-validation":{"get":{"tags":["Utils"],"summary":"Detecta a bandeira de um cartão pelo BIN","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["valid","bin","brand","length","luhnValid","intel"],"properties":{"bin":{"type":"string","description":"O BIN (primeiros dígitos) que foi conferido."},"brand":{"type":"string","description":"Bandeira detectada (ex.: `visa`, `mastercard`)."},"intel":{"type":"object","nullable":true,"required":["scheme","type","category","bank","country"],"properties":{"bank":{"type":"string","nullable":true,"description":"Banco emissor."},"type":{"type":"string","nullable":true,"description":"`credit`, `debit` ou `prepaid`."},"scheme":{"type":"string","nullable":true,"description":"Bandeira do cartão (ex.: `visa`)."},"country":{"type":"string","nullable":true,"description":"País do emissor."},"category":{"type":"string","nullable":true,"description":"Categoria do cartão (ex.: `classic`, `platinum`)."}},"description":"Dados do registro de emissores; `null` a não ser com `lookup=true` e o registro respondendo.","additionalProperties":false},"valid":{"type":"boolean","description":"Se o BIN pertence a uma bandeira conhecida."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"length":{"type":"integer","description":"Quantidade de dígitos recebidos."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"luhnValid":{"type":"boolean","nullable":true,"description":"Se o número inteiro passa na verificação de Luhn; `null` quando só um BIN foi enviado."}},"additionalProperties":false},"example":{"bin":"string","brand":"string","intel":{"bank":"string","type":"string","scheme":"string","country":"string","category":"string"},"valid":true,"_links":{},"length":0,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"luhnValid":true}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"numbering","schema":{"type":"string","maxLength":19,"minLength":6},"required":true,"description":"Os 6+ primeiros dígitos do cartão (BIN), ou o número inteiro."},{"in":"query","name":"lookup","schema":{"type":"boolean"},"required":false,"description":"`true` também consulta o BIN no registro de emissores (banco, tipo, país). Desligado por padrão."}],"operationId":"utilsCardBinValidation"}},"/v1/utils/postcode-validation":{"get":{"tags":["Utils"],"summary":"Valida um CEP (formato brasileiro)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["valid","postcode","country","street","complement","district","city","state","address"],"properties":{"city":{"type":"string","nullable":true,"description":"Cidade; `null` quando não resolvida."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras); `null` quando não resolvido."},"valid":{"type":"boolean","description":"Se o CEP é válido."},"street":{"type":"string","nullable":true,"description":"Logradouro; `null` quando não resolvido."},"address":{"type":"object","nullable":true,"required":["postcode","street","complement","district","city","state"],"properties":{"city":{"type":"string","description":"Cidade."},"state":{"type":"string","description":"Estado (sigla de duas letras)."},"street":{"type":"string","nullable":true,"description":"Logradouro; `null` num CEP que cobre uma cidade inteira."},"district":{"type":"string","nullable":true,"description":"Bairro."},"postcode":{"type":"string","description":"CEP, só dígitos."},"complement":{"type":"string","nullable":true,"description":"Complemento do logradouro (ex.: o lado da rua)."}},"description":"O mesmo endereço, aninhado; `null` quando a consulta não resolveu.","additionalProperties":false},"country":{"type":"string","description":"Código do país."},"district":{"type":"string","nullable":true,"description":"Bairro; `null` quando não resolvido."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"postcode":{"type":"string","description":"O CEP, só dígitos."},"complement":{"type":"string","nullable":true,"description":"Complemento do logradouro; `null` quando não resolvido."}},"additionalProperties":false},"example":{"city":"string","state":"string","valid":true,"street":"string","address":{"city":"string","state":"string","street":"string","district":"string","postcode":"string","complement":"string"},"country":"string","district":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"postcode":"string","complement":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"postcode","schema":{"type":"string","maxLength":20,"minLength":1},"required":true,"description":"O CEP a validar; o hífen é aceito."},{"in":"query","name":"country","schema":{"type":"string","maxLength":10},"required":false,"description":"Código do país (padrão `BR`)."}],"operationId":"utilsPostcodeValidation"}},"/v1/webhooks/events/{eventId}":{"get":{"tags":["Webhooks"],"summary":"Consulta um evento de webhook + as entregas dele","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","type","resource","resourceId","source","delivered","attempts","createdAt"],"properties":{"id":{"type":"string","pattern":"^(wbh)_.+$","description":"Identificador público (wbh_…)"},"data":{"description":"O conteúdo do evento, como enviado à sua URL."},"type":{"type":"string","description":"Tipo do evento, no formato `recurso.acao`."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"source":{"type":"string","description":"Origem do evento na plataforma."},"attempts":{"type":"integer","description":"Tentativas de entrega feitas, somando todos os endpoints."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"resource":{"type":"string","description":"O recurso de que o evento trata (ex.: `transaction`)."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"delivered":{"type":"boolean","description":"Se todos os endpoints assinantes receberam a entrega com sucesso."},"dispatches":{"type":"array","items":{"type":"object","required":["id","eventId","eventType","endpointId","endpoint","status","attempts","responseStatusCode","responseBody","responseTime","nextAttemptAt","lastAttemptAt","successAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(wdi)_.+$","description":"Identificador público (wdi_…)"},"status":{"enum":["pending","success","failed","retrying","canceled"],"type":"string","description":"`pending`, `success`, `failed`, `retrying` ou `canceled`."},"eventId":{"type":"string","pattern":"^(wbh)_.+$","nullable":true,"description":"O evento entregue; `null` numa entrega sintética (ping de teste)."},"attempts":{"type":"integer","description":"Tentativas feitas até agora."},"endpoint":{"type":"string","description":"A URL para onde foi entregue."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"eventType":{"type":"string","nullable":true,"description":"Tipo do evento entregue (ex.: `transaction.approved`); `null` numa entrega sintética."},"successAt":{"type":"string","nullable":true,"description":"Quando a entrega deu certo; `null` até lá."},"endpointId":{"type":"string","pattern":"^(wbe|wbh)_.+$","nullable":true,"description":"O endpoint para onde foi entregue."},"responseBody":{"type":"string","nullable":true,"description":"Corpo que o seu endpoint respondeu (primeiros 8 KB); `null` quando não houve."},"responseTime":{"type":"integer","nullable":true,"description":"Quanto tempo o seu endpoint levou para responder, em milissegundos."},"lastAttemptAt":{"type":"string","nullable":true,"description":"Quando a última tentativa foi feita."},"nextAttemptAt":{"type":"string","nullable":true,"description":"Quando a próxima tentativa está marcada; `null` quando não há."},"responseStatusCode":{"type":"integer","nullable":true,"description":"Status HTTP que o seu endpoint respondeu; `null` quando não respondeu."}},"additionalProperties":false},"description":"As entregas deste evento, uma por endpoint (só na leitura individual)."},"resourceId":{"type":"string","nullable":true,"description":"Id público desse recurso."}},"additionalProperties":false},"example":{"id":"wbh_0a1b2c3d4e5f60718293","type":"string","_links":{},"source":"string","attempts":0,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"resource":"string","createdAt":"string","delivered":true,"dispatches":[{"id":"wdi_0a1b2c3d4e5f60718293","status":"pending","eventId":"wbh_0a1b2c3d4e5f60718293","attempts":0,"endpoint":"string","createdAt":"string","eventType":"string","successAt":"string","endpointId":"wbe_0a1b2c3d4e5f60718293","responseBody":"string","responseTime":0,"lastAttemptAt":"string","nextAttemptAt":"string","responseStatusCode":0}],"resourceId":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"eventId","schema":{"type":"string","pattern":"^(wbh)_.+$"},"required":true,"description":"Identificador público (wbh_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getWebhookEvent"}},"/v1/marketplace/plans/{planId}":{"get":{"tags":["Marketplace"],"summary":"Consulta um plano de taxas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","pix","boleto","credit","debit","withdrawalFee","createdAt"],"properties":{"id":{"type":"string","pattern":"^(rate)_.+$","description":"Identificador público (rate_…)"},"pix":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"name":{"type":"string","nullable":true,"description":"Nome do plano."},"debit":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"boleto":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"credit":{"type":"object","required":["percent","fixed","installments","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."},"installments":{"type":"array","items":{"type":"object","required":["n","percent"],"properties":{"n":{"type":"integer","description":"Número de parcelas."},"percent":{"type":"number","description":"Taxa para esse número de parcelas."}},"additionalProperties":false},"nullable":true,"description":"Taxa por número de parcelas; `null` quando o mesmo `percent` vale para todas."}},"description":"A taxa das vendas no cartão de crédito.","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"withdrawalFee":{"type":"number","nullable":true,"description":"Taxa fixa cobrada da sub-conta em cada saque, em centavos; `null` quando não há."}},"additionalProperties":false},"example":{"id":"rate_0a1b2c3d4e5f60718293","pix":{"fixed":0,"percent":0,"releaseDays":0},"name":"Acme Ltda","debit":{"fixed":0,"percent":0,"releaseDays":0},"boleto":{"fixed":0,"percent":0,"releaseDays":0},"credit":{"fixed":0,"percent":0,"releaseDays":0,"installments":[{"n":0,"percent":0}]},"createdAt":"string","withdrawalFee":5000}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"planId","schema":{"type":"string","pattern":"^(rate)_.+$"},"required":true,"description":"Identificador público (rate_…)"}],"operationId":"getMarketplacePlan"},"patch":{"tags":["Marketplace"],"summary":"Atualiza um plano de taxas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","pix","boleto","credit","debit","withdrawalFee","createdAt"],"properties":{"id":{"type":"string","pattern":"^(rate)_.+$","description":"Identificador público (rate_…)"},"pix":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"name":{"type":"string","nullable":true,"description":"Nome do plano."},"debit":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"boleto":{"type":"object","required":["percent","fixed","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"credit":{"type":"object","required":["percent","fixed","installments","releaseDays"],"properties":{"fixed":{"type":"number","description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","description":"Taxa como percentual da venda."},"releaseDays":{"type":"number","nullable":true,"description":"Dias até o dinheiro ser liberado para a sub-conta; `null` = o seu próprio prazo."},"installments":{"type":"array","items":{"type":"object","required":["n","percent"],"properties":{"n":{"type":"integer","description":"Número de parcelas."},"percent":{"type":"number","description":"Taxa para esse número de parcelas."}},"additionalProperties":false},"nullable":true,"description":"Taxa por número de parcelas; `null` quando o mesmo `percent` vale para todas."}},"description":"A taxa das vendas no cartão de crédito.","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"withdrawalFee":{"type":"number","nullable":true,"description":"Taxa fixa cobrada da sub-conta em cada saque, em centavos; `null` quando não há."}},"additionalProperties":false},"example":{"id":"rate_0a1b2c3d4e5f60718293","pix":{"fixed":0,"percent":0,"releaseDays":0},"name":"Acme Ltda","debit":{"fixed":0,"percent":0,"releaseDays":0},"boleto":{"fixed":0,"percent":0,"releaseDays":0},"credit":{"fixed":0,"percent":0,"releaseDays":0,"installments":[{"n":0,"percent":0}]},"createdAt":"string","withdrawalFee":5000}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"planId","schema":{"type":"string","pattern":"^(rate)_.+$"},"required":true,"description":"Identificador público (rate_…)"}],"operationId":"updateMarketplacePlan","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pix":{"type":"object","properties":{"fixed":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa como percentual da venda (0–100)."},"releaseDays":{"type":"integer","maximum":365,"minimum":0,"description":"Dias até o dinheiro deste meio ser liberado para a sub-conta (nunca antes de você recebê-lo)."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"name":{"type":"string","maxLength":100,"minLength":1,"description":"Nome do plano."},"debit":{"type":"object","properties":{"fixed":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa como percentual da venda (0–100)."},"releaseDays":{"type":"integer","maximum":365,"minimum":0,"description":"Dias até o dinheiro deste meio ser liberado para a sub-conta (nunca antes de você recebê-lo)."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"boleto":{"type":"object","properties":{"fixed":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa como percentual da venda (0–100)."},"releaseDays":{"type":"integer","maximum":365,"minimum":0,"description":"Dias até o dinheiro deste meio ser liberado para a sub-conta (nunca antes de você recebê-lo)."}},"description":"A taxa de um meio de pagamento.","additionalProperties":false},"credit":{"type":"object","properties":{"fixed":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa por venda, em centavos."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa como percentual da venda (0–100)."},"releaseDays":{"type":"integer","maximum":365,"minimum":0,"description":"Dias até o dinheiro deste meio ser liberado para a sub-conta (nunca antes de você recebê-lo)."},"installments":{"type":"array","items":{"type":"object","required":["n","percent"],"properties":{"n":{"type":"integer","maximum":36,"minimum":1,"description":"Número de parcelas."},"percent":{"type":"number","maximum":100,"minimum":0,"description":"Taxa para esse número de parcelas (0–100)."}},"additionalProperties":false},"maxItems":36,"description":"Taxa por número de parcelas, sobrepondo `percent`."}},"description":"A taxa das vendas no cartão de crédito, opcionalmente por número de parcelas.","additionalProperties":false},"withdrawalFee":{"type":"integer","maximum":10000000,"minimum":0,"description":"Taxa fixa cobrada da sub-conta em cada saque, em centavos."}},"additionalProperties":false},"example":{"pix":{"fixed":0,"percent":0,"releaseDays":0},"name":"Acme Ltda","debit":{"fixed":0,"percent":0,"releaseDays":0},"boleto":{"fixed":0,"percent":0,"releaseDays":0},"credit":{"fixed":0,"percent":0,"releaseDays":0,"installments":[{"n":1,"percent":0}]},"withdrawalFee":5000}}},"required":true},"x-account-level":"always"},"delete":{"tags":["Marketplace"],"summary":"Exclui um plano de taxas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","deleted"],"properties":{"id":{"type":"string","description":"Id público do plano excluído."},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."}},"additionalProperties":false},"example":{"id":"string","deleted":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"planId","schema":{"type":"string","pattern":"^(rate)_.+$"},"required":true,"description":"Identificador público (rate_…)"}],"operationId":"deleteMarketplacePlan","x-account-level":"always"}},"/v1/receivables/{receivableId}":{"get":{"tags":["Receivables"],"summary":"Consulta um recebível","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","transactionId","recipient","split","status","amount","grossAmount","antecipationFee","installmentNumber","currency","description","authorizationCode","liable","released","expectedOn","paidAt","refundedAt","canceledAt","chargedBackAt","disputedAt","fraudChekingAt","chargeProcessingFee","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(rec)_.+$","description":"Identificador público (rec_…)"},"split":{"type":"string","nullable":true,"description":"O split de que vem; `null` quando é do próprio vendedor."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","description":"Valor líquido, em centavos (o que chega ao saldo)."},"liable":{"type":"boolean","nullable":true,"description":"Se o recebedor arca com os chargebacks dele."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi liberado para o saldo; `null` até lá."},"status":{"type":"string","description":"Status: `pending` (aguardando a data de liberação), `paid` (liberado para o saldo), `canceled`, `refunded`, `chargeback`…"},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"released":{"type":"boolean","nullable":true,"description":"Se foi liberado para o saldo disponível."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que o recebe (`bus_…`)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando foi cancelado; `null` quando não foi."},"disputedAt":{"type":"string","nullable":true,"description":"Quando entrou em disputa; `null` quando não entrou."},"expectedOn":{"type":"string","nullable":true,"description":"Data prevista de liberação."},"refundedAt":{"type":"string","nullable":true,"description":"Quando foi estornado; `null` quando não foi."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"grossAmount":{"type":"integer","description":"Valor bruto, em centavos (antes das taxas)."},"chargedBackAt":{"type":"string","nullable":true,"description":"Quando sofreu chargeback; `null` quando não sofreu."},"transactionId":{"type":"string","pattern":"^(tra|trx)_.+$","nullable":true,"description":"A cobrança de que o recebível vem."},"fraudChekingAt":{"type":"string","nullable":true,"description":"Quando foi retido para análise de fraude; `null` quando não foi. O nome mantém a grafia histórica."},"antecipationFee":{"type":"number","nullable":true,"description":"Taxa cobrada para antecipá-lo, em centavos; `null` quando não foi antecipado. O nome mantém a grafia histórica."},"authorizationCode":{"type":"string","nullable":true,"description":"Código de autorização da cobrança; `null` em Pix/boleto."},"installmentNumber":{"type":"integer","nullable":true,"description":"Parcela da cobrança a que pertence; `null` em pagamento à vista."},"chargeProcessingFee":{"type":"boolean","nullable":true,"description":"Se o recebedor paga a taxa de processamento dele."}},"additionalProperties":false},"example":{"id":"rec_0a1b2c3d4e5f60718293","split":"string","_links":{},"amount":5000,"liable":true,"paidAt":"string","status":"string","currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"released":true,"createdAt":"string","recipient":"string","updatedAt":"string","canceledAt":"string","disputedAt":"string","expectedOn":"string","refundedAt":"string","description":"string","grossAmount":5000,"chargedBackAt":"string","transactionId":"tra_0a1b2c3d4e5f60718293","fraudChekingAt":"string","antecipationFee":5000,"authorizationCode":"string","installmentNumber":0,"chargeProcessingFee":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"receivableId","schema":{"type":"string","pattern":"^(rec)_.+$"},"required":true,"description":"Identificador público (rec_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getReceivable"}},"/v1/simulators/payment-methods":{"get":{"tags":["Simulators"],"summary":"Simula as taxas e os totais de um meio de pagamento","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["planId","resource","isCustom","amount","original","totalFees","_links"],"properties":{"_links":{"type":"object","required":["self","installment","installments"],"properties":{"self":{"type":"object","required":["href","method"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."}},"description":"Um link para uma operação relacionada.","additionalProperties":false},"installment":{"type":"object","required":["href","method"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."}},"description":"Um link para uma operação relacionada.","additionalProperties":false},"installments":{"type":"object","required":["href","method"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"description":"Links para os outros simuladores.","additionalProperties":false},"amount":{"type":"object","required":["cents","decimal"],"properties":{"cents":{"type":"integer","description":"Em centavos."},"decimal":{"type":"number","description":"Em reais (decimal)."}},"description":"O que o comprador paga.","additionalProperties":false},"planId":{"type":"string","nullable":true,"description":"O plano de taxas usado; `null` quando a conta não tem."},"isCustom":{"type":"boolean","description":"Se um `fee` personalizado foi usado no lugar da configuração da conta."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"original":{"type":"object","required":["cents","decimal"],"properties":{"cents":{"type":"integer","description":"Em centavos."},"decimal":{"type":"number","description":"Em reais (decimal)."}},"description":"O valor simulado.","additionalProperties":false},"resource":{"enum":["nupay","credit","billet","pix"],"type":"string","description":"O meio simulado."},"totalFees":{"type":"object","required":["cents","decimal"],"properties":{"cents":{"type":"integer","description":"Em centavos."},"decimal":{"type":"number","description":"Em reais (decimal)."}},"description":"As taxas por cima do valor.","additionalProperties":false}},"additionalProperties":false},"example":{"_links":{"self":{"href":"string","method":"string"},"installment":{"href":"string","method":"string"},"installments":{"href":"string","method":"string"}},"amount":{"cents":5000,"decimal":0},"planId":"string","isCustom":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"original":{"cents":5000,"decimal":0},"resource":"nupay","totalFees":{"cents":5000,"decimal":0}}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"amount","schema":{"type":"integer","maximum":20000000,"minimum":500},"required":true,"description":"Valor a simular, em centavos (mínimo 500)."},{"in":"query","name":"fee","schema":{"type":"number","maximum":100,"minimum":0},"required":false,"description":"Juros a simular, como percentual (0–100), no lugar dos configurados na sua conta."},{"in":"query","name":"installment","schema":{"type":"integer","maximum":24,"minimum":1},"required":false,"description":"Número de parcelas (cartão e NuPay)."},{"in":"query","name":"method","schema":{"enum":["nupay","credit","billet","pix"],"type":"string"},"required":true,"description":"O meio de pagamento a simular."},{"in":"query","name":"brand","schema":{"type":"string","maxLength":50},"required":false,"description":"Aceito por compatibilidade; não muda os totais."}],"operationId":"simulatePaymentMethods"}},"/v1/withdrawals/{withdrawalId}":{"get":{"tags":["Withdrawals"],"summary":"Consulta um saque","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","walletId","amount","fee","status","method","currency","transferCode","paidAt","approvedAt","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(cash)_.+$","description":"Identificador público (cash_…)"},"fee":{"type":"integer","description":"Taxa do saque, em centavos."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","description":"Valor sacado, em centavos."},"method":{"type":"string","nullable":true,"description":"Como é pago (ex.: `pix`, `ted`)."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi pago; `null` até lá."},"status":{"type":"string","description":"Status: `pending`, `processing`, `paid`, `canceled`, `failed`…"},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"walletId":{"type":"string","pattern":"^(wall)_.+$","nullable":true,"description":"A conta bancária em que é pago; `null` quando pago na sua chave Pix."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"approvedAt":{"type":"string","nullable":true,"description":"Quando foi aprovado para pagamento; `null` até lá."},"transferCode":{"type":"string","nullable":true,"description":"Identificador da transferência no banco; `null` até ser pago."},"receivingBankAccount":{"type":"object","nullable":true,"required":["holderName","document","bankCode","bankName","routingNumber","accountNumber","type","pixKey"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo da conta."},"pixKey":{"type":"string","nullable":true,"description":"Chave Pix, quando pago a uma."},"bankCode":{"type":"string","nullable":true,"description":"Código do banco."},"bankName":{"type":"string","nullable":true,"description":"Nome do banco."},"document":{"type":"string","nullable":true,"description":"CPF/CNPJ do titular."},"holderName":{"type":"string","nullable":true,"description":"Nome do titular da conta."},"accountNumber":{"type":"string","nullable":true,"description":"Número da conta."},"routingNumber":{"type":"string","nullable":true,"description":"Agência."}},"description":"Retrato da conta bancária de destino, tirado quando o saque foi pedido.","additionalProperties":false}},"additionalProperties":false},"example":{"id":"cash_0a1b2c3d4e5f60718293","fee":5000,"_links":{},"amount":5000,"method":"string","paidAt":"string","status":"string","currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"walletId":"wall_0a1b2c3d4e5f60718293","createdAt":"string","updatedAt":"string","approvedAt":"string","transferCode":"string","receivingBankAccount":{"type":"string","pixKey":"string","bankCode":"string","bankName":"string","document":"string","holderName":"JOAO SILVA","accountNumber":"string","routingNumber":"string"}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"withdrawalId","schema":{"type":"string","pattern":"^(cash)_.+$"},"required":true,"description":"Identificador público (cash_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getWithdrawal"}},"/v1/utils/rules-of-recurrencies":{"get":{"tags":["Utils"],"summary":"Regras de recorrência suportadas (assinaturas/preços)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["frequencies","frequencyCount","pricingTypes","pricingSchemas","billingTypes","trialIntervals"],"properties":{"frequencies":{"type":"array","items":{"type":"string"},"description":"Unidades do intervalo de cobrança (`daily`, `weekly`, `monthly`, `yearly`)."},"billingTypes":{"type":"array","items":{"type":"string"},"description":"Tipos de cobrança (`prepaid`, `postpaid`, `exactday`)."},"pricingTypes":{"type":"array","items":{"type":"string"},"description":"Tipos de preço (`oneTime`, `recurring`)."},"frequencyCount":{"type":"object","required":["min","max"],"properties":{"max":{"type":"integer","description":"Máximo."},"min":{"type":"integer","description":"Mínimo."}},"description":"Faixa permitida de unidades por ciclo.","additionalProperties":false},"pricingSchemas":{"type":"array","items":{"type":"string"},"description":"Esquemas de preço (`unit`, `tiered`, `package`)."},"trialIntervals":{"type":"array","items":{"type":"string"},"description":"Unidades do intervalo de teste."}},"description":"As regras de recorrência que o catálogo e as assinaturas aceitam.","additionalProperties":false}},"additionalProperties":false},"example":{"data":{"frequencies":["string"],"billingTypes":["string"],"pricingTypes":["string"],"frequencyCount":{"max":0,"min":0},"pricingSchemas":["string"],"trialIntervals":["string"]}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"utilsRulesOfRecurrencies"}},"/v1/utils/types-of-bankaccounts":{"get":{"tags":["Utils"],"summary":"Lista os bancos suportados","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["bankId","bankCode","name"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome do banco."},"bankId":{"type":"integer","description":"Id interno do banco."},"bankCode":{"type":"string","nullable":true,"description":"Código do banco (COMPE)."}},"additionalProperties":false},"description":"Os bancos em que uma conta de recebimento pode ser cadastrada."}},"additionalProperties":false},"example":{"data":[{"name":"Acme Ltda","bankId":0,"bankCode":"string"}]}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"operationId":"utilsTypesOfBankAccounts"}},"/v1/webhooks/{id}/rotate-secret":{"post":{"tags":["Webhooks"],"summary":"Rotaciona o segredo de assinatura do endpoint","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","endpoint","enabled","disabledReason","disabledAt","disabledCanceledDispatches","events","forceActive","shotsQty","failedShotsQty","lastDeliveryAt","metadata","createdAt","updatedAt","secret"],"properties":{"id":{"type":"string","pattern":"^(wbe|wbh)_.+$","description":"Identificador público (wbe_/wbh_…)"},"name":{"type":"string","description":"Nome do endpoint."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"events":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Os tipos de evento entregues; `null` com `forceActive`."},"secret":{"type":"string","description":"O segredo de assinatura do endpoint — mostrado UMA vez, aqui. Use-o para verificar a assinatura de cada entrega."},"enabled":{"type":"boolean","description":"Se o endpoint recebe entregas."},"endpoint":{"type":"string","description":"A URL que recebe os eventos."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shotsQty":{"type":"integer","description":"Total de entregas tentadas."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"disabledAt":{"type":"string","nullable":true,"description":"Quando foi desativado; `null` enquanto ativo."},"forceActive":{"type":"boolean","description":"Se todos os tipos de evento são entregues."},"disabledReason":{"enum":["seller","circuitBreaker","staff"],"type":"string","nullable":true,"description":"Quem desativou: `seller` (você), `circuitBreaker` (a proteção automática, depois de falhas seguidas) ou `staff`; `null` enquanto ativo."},"failedShotsQty":{"type":"integer","description":"Entregas que falharam."},"lastDeliveryAt":{"type":"string","nullable":true,"description":"Quando a última entrega foi feita; `null` quando não houve."},"disabledCanceledDispatches":{"type":"integer","nullable":true,"description":"Quantas entregas pendentes a desativação cancelou; `null` quando você mesmo desativou."}},"additionalProperties":false},"example":{"id":"wbe_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"events":["string"],"secret":"string","enabled":true,"endpoint":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shotsQty":0,"createdAt":"string","updatedAt":"string","disabledAt":"string","forceActive":true,"disabledReason":"seller","failedShotsQty":0,"lastDeliveryAt":"string","disabledCanceledDispatches":0}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","pattern":"^(wbe|wbh)_.+$"},"required":true,"description":"Identificador público (wbe_/wbh_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"rotateWebhookSecret"}},"/v1/transactions/{transactionId}":{"get":{"tags":["Transactions"],"summary":"Consulta uma transação","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","customId","amount","originalAmount","fees","net","status","method","currency","payment","discount","discounts","customer","billing","externalReference","shippable","spplited","items","receivables","splits","refunds","disputes","timeline","callback","utm","processingTimeMs","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(tra|trx)_.+$","description":"Identificador público (tra_/trx_…)"},"net":{"type":"integer","description":"O que você recebe: `amount − fees`, em centavos."},"utm":{"type":"object","nullable":true,"properties":{"term":{"type":"string","description":"`utm_term`."},"medium":{"type":"string","description":"`utm_medium`."},"source":{"type":"string","description":"`utm_source`."},"content":{"type":"string","description":"`utm_content`."},"campaign":{"type":"string","description":"`utm_campaign`."}},"description":"Atribuição de marketing da venda; `null` quando não há.","additionalProperties":false},"fees":{"type":"integer","description":"Total de taxas retidas, em centavos."},"items":{"type":"array","items":{"type":"object","required":["id","name","unitPrice","quantity","currency","description","images","isUpsell","isOrderbump","variantId","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(item|tri)_.+$","description":"Identificador público (item_/tri_…)"},"name":{"type":"string","description":"Nome do item."},"images":{"type":"array","items":{"type":"string"},"nullable":true,"description":"URLs das imagens do item; `null` quando não há."},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"isUpsell":{"type":"boolean","nullable":true,"description":"Se o item foi adicionado por uma oferta de upsell."},"metadata":{"nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há."},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário, em centavos."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"variantId":{"type":"string","nullable":true,"description":"A variante do catálogo; `null` num item avulso."},"description":{"type":"string","nullable":true,"description":"Descrição do item."},"isOrderbump":{"type":"boolean","nullable":true,"description":"Se o item foi adicionado por um order bump."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"nullable":true,"description":"Itens do carrinho; `null` quando a cobrança não teve itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","description":"Valor cobrado, em centavos (depois dos descontos)."},"method":{"enum":["credit","pix","billet","nupay"],"type":"string","description":"Meio de pagamento."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","receivable","amount","grossAmount","percentage","description","chargeProcessingFee","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do split."},"amount":{"type":"integer","description":"Fatia líquida, em centavos."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"percentage":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"A fatia como percentual, quando foi definida assim."},"receivable":{"type":"string","nullable":true,"description":"O recebível criado para a fatia."},"description":{"type":"string","nullable":true,"description":"Descrição."},"grossAmount":{"type":"integer","description":"Fatia bruta, em centavos."},"chargeProcessingFee":{"type":"boolean","nullable":true,"description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"As fatias desta cobrança destinadas a outras contas; `null` quando não há split."},"status":{"enum":["pending","pre-authorized","approved","failed","refused","canceled","refunded","chargeback","dispute","fraud-review","analyzing","awaiting"],"type":"string","description":"Status da cobrança. A criação é assíncrona: o desfecho chega por webhook."},"billing":{"type":"object","required":["address"],"properties":{"address":{"type":"object","required":["id","ownerId","ownerType","street","number","complement","district","city","state","postcode","country","latitude","longitude","line","line1","line2","line3","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do endereço; `null` quando o endereço não foi salvo."},"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"ownerId":{"type":"string","nullable":true,"description":"Id público do dono do endereço."},"district":{"type":"string","nullable":true,"description":"Bairro."},"latitude":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Latitude; `null` quando desconhecida."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"longitude":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Longitude; `null` quando desconhecida."},"ownerType":{"type":"string","nullable":true,"description":"Quem é dono do endereço (`customer`, `company`…)."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."}},"description":"O endereço do pagador.","additionalProperties":false}},"description":"Bloco de cobrança.","additionalProperties":false},"payment":{"type":"object","required":["provider","version","refused","reusable","billetUrl","billetBarcode","billetSequence","billetDocumentNumber","billetReferenceNumber","pixQrCodeEmv","pixQrCodeUrl","pixQrCodeImage","acquirerTransactionNumber","cardFirstDigits","cardLastDigits","cardBrand","cardRegistered","cardId","installments","expirationDate","paidAt","allowRenewPayment","invoiceLink","invoicePathLink"],"properties":{"cardId":{"type":"string","nullable":true,"description":"Id público (`card_…`) do cartão que esta cobrança usou, quando ficou salvo no cliente — o mesmo que `GET /v1/cards` lista. Use-o para cobrar renovações com `payment.card.id`. `null` sem cartão."},"paidAt":{"type":"string","nullable":true,"description":"Quando a cobrança foi paga; `null` até lá."},"refused":{"type":"object","nullable":true,"required":["code","type","category","message","displayMessage","reversible"],"properties":{"code":{"enum":["insufficientFundsError","expiredCardError","invalidCardNumber","invalidExpiryMonth","invalidExpiryYear","invalidSecurityCode","invalidPinCode","invalidPaymentInformation","cardDeclined","authorizationRefused","cardCustomerNotAssociated","invalidParameters","sellerAuthorizationRefused","paymentMethodUnavailable","pixAutomaticNotDebited","cardValidationUnavailable","paymentProcessingError"],"type":"string","description":"Código estável da recusa — o valor para tratar no seu sistema."},"type":{"enum":["cardError","invalidRequestError","processingError"],"type":"string","description":"Família do erro: `cardError`, `invalidRequestError` ou `processingError`."},"message":{"type":"string","description":"Mensagem técnica (em inglês)."},"category":{"enum":["payment","validation","businessRule","processing"],"type":"string","description":"`payment`, `validation`, `businessRule` ou `processing`."},"reversible":{"type":"boolean","description":"Se o comprador pode tentar de novo (ex.: com outro cartão)."},"displayMessage":{"type":"string","description":"Mensagem segura para mostrar ao comprador (pt-BR)."}},"description":"Por que a cobrança foi recusada; `null` quando não foi.","additionalProperties":false},"version":{"enum":["1.1"],"type":"string","description":"Versão do objeto de pagamento."},"provider":{"enum":["selectwin"],"type":"string","description":"Sempre `selectwin`."},"reusable":{"type":"boolean","description":"Se o pagamento pode ser reutilizado (hoje sempre `false`)."},"billetUrl":{"type":"string","nullable":true,"description":"URL do boleto (PDF); `null` nos outros meios e até ser emitido."},"cardBrand":{"type":"string","nullable":true,"description":"Bandeira do cartão."},"invoiceLink":{"type":"string","nullable":true,"description":"URL do comprovante hospedado desta cobrança (`pay.selectwin.io/r/…`). `null` na resposta da criação — preenchido na leitura e nos webhooks."},"installments":{"type":"integer","nullable":true,"description":"Número de parcelas."},"pixQrCodeEmv":{"type":"string","nullable":true,"description":"Código copia e cola do Pix (EMV); `null` até ser emitido."},"pixQrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code do Pix."},"billetBarcode":{"type":"string","nullable":true,"description":"Linha digitável do boleto."},"billetSequence":{"type":"string","nullable":true,"description":"Número sequencial do boleto."},"cardLastDigits":{"type":"string","nullable":true,"description":"Quatro últimos dígitos do cartão."},"cardRegistered":{"type":"boolean","description":"Se o cartão foi salvo no cliente."},"expirationDate":{"type":"string","nullable":true,"description":"Quando o Pix ou o boleto expira; `null` em cartão."},"pixQrCodeImage":{"type":"string","nullable":true,"description":"Imagem do QR code do Pix (base64); `null` quando não disponível."},"cardFirstDigits":{"type":"string","nullable":true,"description":"Seis primeiros dígitos do cartão; `null` nos outros meios."},"invoicePathLink":{"type":"string","nullable":true,"description":"O mesmo comprovante, como caminho (`/r/{env}/{token}`) para renderizar no seu próprio domínio. `null` exatamente quando `invoiceLink` é."},"nupayPaymentUrl":{"type":"string","nullable":true,"description":"NuPay: o link de aprovação no app do Nubank, para onde o comprador é enviado. `null` nos outros meios."},"allowRenewPayment":{"type":"boolean","description":"Se um novo Pix/boleto pode ser emitido para esta cobrança (`true` nesses meios)."},"billetDocumentNumber":{"type":"string","nullable":true,"description":"Número do documento do boleto."},"billetReferenceNumber":{"type":"string","nullable":true,"description":"Número de referência do boleto."},"acquirerTransactionNumber":{"type":"string","nullable":true,"description":"Número da cobrança no provedor de pagamento (NSU)."}},"description":"Como a cobrança é paga: o código Pix, o boleto, o cartão usado, a recusa.","additionalProperties":false},"refunds":{"type":"array","items":{"type":"object","required":["id","description","receiptId","amount","category","observations","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(void|trf|trr)_.+$","description":"Identificador público (void_/trf_/trr_…)"},"amount":{"type":"integer","description":"Valor estornado, em centavos."},"category":{"type":"string","nullable":true,"description":"Categoria do estorno (ver `GET /v1/utils/types-of-refund`)."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"receiptId":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Comprovante do estorno."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"Por que foi estornado."},"observations":{"type":"string","nullable":true,"description":"Observações."}},"additionalProperties":false},"nullable":true,"description":"Os estornos feitos nesta cobrança; `null` quando não há."},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","nullable":true,"description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","nullable":true,"description":"URL que recebe os webhooks desta cobrança."}},"description":"Webhook só desta cobrança; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"customId":{"type":"string","nullable":true,"description":"O seu id personalizado da cobrança: prefixo + base + sufixo, como configurado em `/v1/companies/configs`; `null` em cobranças antigas."},"customer":{"type":"object","nullable":true,"required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail; `null` quando não há."},"gender":{"type":"string","nullable":true,"description":"Gênero (`male`, `female`, `other`); `null` quando desconhecido."},"document":{"type":"object","required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento; `null` quando não há."},"number":{"type":"string","nullable":true,"description":"Número do documento (dígitos em CPF/CNPJ); `null` quando não há."}},"description":"Documento do comprador.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há."},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"nullable":true,"description":"Outros e-mails do comprador; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador deste cliente; `null` quando não há."}},"description":"O comprador; `null` quando não há.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"integer","description":"O desconto, em centavos."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado à cobrança; `null` quando não há.","additionalProperties":false},"disputes":{"type":"array","items":{"type":"object","required":["id","returnEmail","description","status","reason","reasonCode","reasonDescription","openedAt","closedAt","outcome","decidedAt","deadline","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id da disputa."},"reason":{"type":"string","nullable":true,"description":"Por que o comprador contestou."},"status":{"type":"string","nullable":true,"description":"Status da disputa."},"outcome":{"enum":["won","lost"],"type":"string","nullable":true,"description":"Como terminou: `won` (a cobrança volta a aprovada) ou `lost` (chargeback); `null` enquanto aberta."},"closedAt":{"type":"string","nullable":true,"description":"Quando foi encerrada; `null` enquanto aberta."},"deadline":{"type":"object","nullable":true,"required":["deadlineAt","hoursRemaining","expired","urgent"],"properties":{"urgent":{"type":"boolean","description":"Ainda defensável, mas perto do prazo."},"expired":{"type":"boolean","description":"A janela fechou: provas enviadas agora não são mais aceitas."},"deadlineAt":{"type":"string","nullable":true,"description":"Até quando as provas são aceitas."},"hoursRemaining":{"type":"number","nullable":true,"description":"Horas restantes para enviar as provas."}},"description":"O prazo das provas, derivado de `openedAt`; `null` quando a data de abertura é desconhecida.","additionalProperties":false},"openedAt":{"type":"string","nullable":true,"description":"Quando a disputa foi aberta."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"decidedAt":{"type":"string","nullable":true,"description":"Quando foi decidida; `null` enquanto aberta."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"reasonCode":{"type":"string","nullable":true,"description":"Código do motivo na bandeira."},"description":{"type":"string","nullable":true,"description":"O texto da sua defesa."},"returnEmail":{"type":"string","nullable":true,"description":"E-mail que recebe o desfecho."},"deliveryProof":{"nullable":true,"description":"Prova de entrega que você anexou; `null` quando não há."},"shipmentProof":{"nullable":true,"description":"Prova de envio que você anexou; `null` quando não há."},"fiscalDocuments":{"nullable":true,"description":"Documentos fiscais que você anexou; `null` quando não há."},"deliveryReceipts":{"nullable":true,"description":"Comprovantes de entrega que você anexou; `null` quando não há."},"reasonDescription":{"type":"string","nullable":true,"description":"Descrição do motivo."},"communicationProof":{"nullable":true,"description":"Prova de comunicação que você anexou; `null` quando não há."}},"additionalProperties":false},"nullable":true,"description":"As disputas desta cobrança; `null` quando não há."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há."},"shipping":{"nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há."},"spplited":{"type":"boolean","description":"Se a cobrança foi dividida com outras contas (ver `splits`). O nome mantém a grafia histórica."},"timeline":{"type":"array","items":{"type":"object","required":["id","message","details","type","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id da entrada."},"type":{"type":"string","nullable":true,"description":"Tipo da entrada."},"details":{"type":"string","nullable":true,"description":"Detalhes da entrada."},"message":{"type":"string","nullable":true,"description":"O que aconteceu."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"additionalProperties":false},"description":"Histórico da cobrança (mudanças de status e notas), do mais antigo ao mais novo."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a venda tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"receivables":{"type":"array","items":{"type":"object","required":["id","recipient","split","status","amount","grossAmount","anticipationFee","installmentNumber","description","currency","authorizationCode","paidAt","refundedAt","canceledAt","expectedOn","liable","chargeProcessingFee","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do recebível (`rec_…`)."},"split":{"type":"string","nullable":true,"description":"O split de que vem; `null` quando é seu."},"amount":{"type":"integer","description":"Valor líquido, em centavos."},"liable":{"type":"boolean","nullable":true,"description":"Se este recebedor arca com os chargebacks dele."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi liberado ao recebedor; `null` até lá."},"status":{"type":"string","nullable":true,"description":"Status do recebível."},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que o recebe."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando foi cancelado; `null` quando não foi."},"expectedOn":{"type":"string","nullable":true,"description":"Data prevista de liberação."},"refundedAt":{"type":"string","nullable":true,"description":"Quando foi estornado; `null` quando não foi."},"description":{"type":"string","nullable":true,"description":"Descrição."},"grossAmount":{"type":"integer","description":"Valor bruto, em centavos."},"anticipationFee":{"type":"integer","nullable":true,"description":"Taxa cobrada para antecipá-lo, em centavos; `null` quando não foi antecipado."},"authorizationCode":{"type":"string","nullable":true,"description":"Código de autorização da cobrança."},"installmentNumber":{"type":"integer","nullable":true,"description":"Número da parcela a que pertence."},"chargeProcessingFee":{"type":"boolean","nullable":true,"description":"Se este recebedor paga a taxa de processamento."}},"additionalProperties":false},"nullable":true,"description":"Os recebíveis desta cobrança, um por parcela e recebedor; `null` quando ainda não há."},"paymentGroup":{"type":"object","nullable":true,"required":["id","method","status","legIndex","legCount","isPrimary","totalAmount"],"properties":{"id":{"type":"string","description":"Id do pedido (o grupo de pagamento)."},"method":{"enum":["dualcredit","creditpix"],"type":"string","description":"`dualcredit` (dois cartões) ou `creditpix` (cartão + Pix)."},"status":{"enum":["authorizing","awaiting_retry","awaiting_pix","capturing","paid","compensating","failed","canceled","needs_review"],"type":"string","description":"Status do pedido inteiro — feche o pedido por ele, nunca por uma parte."},"legCount":{"type":"integer","description":"Número de partes do pedido."},"legIndex":{"type":"integer","description":"Posição desta parte no pedido (a partir de 0)."},"isPrimary":{"type":"boolean","description":"Se é a parte principal do pedido."},"totalAmount":{"type":"integer","description":"Total do pedido, em centavos."},"transactionIds":{"type":"array","items":{"type":"string"},"description":"A cobrança atual de cada parte do pedido, na ordem das partes (esta inclusa)."}},"description":"Pagamento combinado: esta cobrança é UMA PARTE de um pedido pago com dois cartões ou cartão + Pix. `null` = venda comum.","additionalProperties":false},"originalAmount":{"type":"integer","description":"Valor antes dos descontos, em centavos."},"processingTimeMs":{"type":"integer","nullable":true,"description":"Tempo da criação até o primeiro resultado do pagamento, em milissegundos; `null` até lá."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da cobrança; `null` quando não há."}},"additionalProperties":false},"example":{"id":"tra_0a1b2c3d4e5f60718293","net":0,"utm":{"term":"string","medium":"string","source":"string","content":"string","campaign":"string"},"fees":5000,"items":[{"id":"item_0a1b2c3d4e5f60718293","name":"Acme Ltda","images":["string"],"currency":"BRL","isUpsell":true,"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","variantId":"string","description":"string","isOrderbump":true,"externalReference":"string"}],"_links":{},"amount":5000,"method":"credit","splits":[{"id":"string","amount":5000,"createdAt":"string","recipient":"string","updatedAt":"string","percentage":"string","receivable":"string","description":"string","grossAmount":5000,"chargeProcessingFee":true}],"status":"pending","billing":{"address":{"id":"string","city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","number":"1000","street":"string","country":"string","ownerId":"string","district":"string","latitude":"string","postcode":"string","createdAt":"string","longitude":"string","ownerType":"string","updatedAt":"string","complement":"string"}},"payment":{"cardId":"string","paidAt":"string","refused":{"code":"insufficientFundsError","type":"cardError","message":"string","category":"payment","reversible":true,"displayMessage":"string"},"version":"1.1","provider":"selectwin","reusable":true,"billetUrl":"string","cardBrand":"string","invoiceLink":"string","installments":0,"pixQrCodeEmv":"string","pixQrCodeUrl":"string","billetBarcode":"string","billetSequence":"string","cardLastDigits":"string","cardRegistered":true,"expirationDate":"string","pixQrCodeImage":"string","cardFirstDigits":"string","invoicePathLink":"string","nupayPaymentUrl":"string","allowRenewPayment":true,"billetDocumentNumber":"string","billetReferenceNumber":"string","acquirerTransactionNumber":"string"},"refunds":[{"id":"void_0a1b2c3d4e5f60718293","amount":5000,"category":"string","createdAt":"string","receiptId":"string","updatedAt":"string","description":"string","observations":"string"}],"callback":{"active":true,"webhookUrl":"string"},"currency":"BRL","customId":"string","customer":{"id":"cus_0a1b2c3d4e5f60718293","email":"buyer@example.com","gender":"string","document":{"type":"string","number":"12345678909"},"lastName":"Silva","available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"externalReference":"string"},"discount":{"type":"string","value":5000,"percentageOfAmount":5000},"disputes":[{"id":"string","reason":"string","status":"string","outcome":"won","closedAt":"string","deadline":{"urgent":true,"expired":true,"deadlineAt":"string","hoursRemaining":0},"openedAt":"string","createdAt":"string","decidedAt":"string","updatedAt":"string","reasonCode":"string","description":"string","returnEmail":"string","reasonDescription":"string"}],"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"spplited":true,"timeline":[{"id":"string","type":"string","details":"string","message":"string","createdAt":"string","updatedAt":"string"}],"createdAt":"string","discounts":[],"shippable":true,"updatedAt":"string","receivables":[{"id":"string","split":"string","amount":5000,"liable":true,"paidAt":"string","status":"string","currency":"BRL","createdAt":"string","recipient":"string","updatedAt":"string","canceledAt":"string","expectedOn":"string","refundedAt":"string","description":"string","grossAmount":5000,"anticipationFee":5000,"authorizationCode":"string","installmentNumber":0,"chargeProcessingFee":true}],"paymentGroup":{"id":"string","method":"dualcredit","status":"authorizing","legCount":0,"legIndex":0,"isPrimary":true,"totalAmount":5000,"transactionIds":["string"]},"originalAmount":5000,"processingTimeMs":0,"externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string","pattern":"^(tra|trx)_.+$"},"required":true,"description":"Identificador público (tra_/trx_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getTransaction"}},"/v1/products/{productId}/variants":{"get":{"tags":["Products - Variants"],"summary":"Lista as variantes de um produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."}},"additionalProperties":false},"example":{"data":[{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"offset":0,"hasMore":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"id","schema":{"type":"string","pattern":"^(var|prv)_.+$"},"required":false,"description":"Só esta variante."},{"in":"query","name":"sku","schema":{"type":"string","maxLength":50,"minLength":1},"required":false,"description":"Só a variante com este SKU."},{"in":"query","name":"currency","schema":{"type":"string"},"required":false,"description":"Código de moeda ISO 4217"},{"in":"query","name":"enabled","schema":{"type":"boolean"},"required":false,"description":"Só variantes à venda (`true`) ou não (`false`)."},{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listProductVariants"},"post":{"tags":["Products - Variants"],"summary":"Cria uma variante de produto","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"example":{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createProductVariant","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","pricing"],"properties":{"sku":{"type":"string","maxLength":50,"description":"O seu SKU."},"name":{"type":"string","maxLength":255,"minLength":1,"description":"Nome da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","pattern":"^\\d{9}$","description":"Código NBS, 9 dígitos (serviço)."},"ncm":{"type":"string","pattern":"^\\d{8}$","description":"Código NCM, 8 dígitos (mercadoria)."},"cest":{"type":"string","pattern":"^\\d{7}$","description":"Código CEST, 7 dígitos (mercadoria com substituição tributária)."},"gtin":{"type":"string","pattern":"^(\\d{8}|\\d{12,14})$","description":"GTIN/EAN — 8, 12, 13 ou 14 dígitos."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` emite NFS-e, `goods` emite NF-e. Omitido: um produto `physical` é mercadoria, os outros são serviço."},"unit":{"type":"string","maxLength":6,"minLength":1,"description":"Unidade comercial (UN, KG, CX…)."},"origin":{"type":"integer","maximum":8,"minimum":0,"description":"Origem da mercadoria (tabela A do ICMS, 0 a 8; 0 = nacional)."},"cClassTrib":{"type":"string","pattern":"^\\d{6}$","description":"Classificação tributária do IBS/CBS (cClassTrib, 6 dígitos)."},"serviceCode":{"type":"string","pattern":"^\\d{1,2}\\.?\\d{2}$","description":"Item da lista de serviços da LC 116 (`01.07` ou `0107`)."},"cityServiceCode":{"type":"string","maxLength":20,"minLength":1,"description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` limpa.","additionalProperties":false},"images":{"type":"array","items":{"type":"string","format":"uri","description":"URL absoluta."},"maxItems":1,"description":"URLs de imagem. Para anexar um arquivo, envie-o antes (`POST /v1/assets/uploads` e depois a confirmação) e mande a URL do arquivo."},"enabled":{"type":"boolean","default":true,"description":"Se a variante está à venda."},"pricing":{"type":"object","properties":{"type":{"enum":["oneTime","recurring"],"type":"string","default":"oneTime","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"type":"array","items":{"type":"object","required":["unitPrice"],"properties":{"upTo":{"type":"integer","maximum":1000000000,"minimum":1,"nullable":true,"description":"Limite superior da faixa (unidades); `null` = sem limite (a última faixa)."},"flatPrice":{"type":"integer","maximum":200000000,"minimum":0,"nullable":true,"description":"Valor fixo somado quando a faixa é atingida, em centavos."},"unitPrice":{"type":"integer","maximum":200000000,"minimum":0,"description":"Preço unitário dentro da faixa, em centavos."}},"additionalProperties":false},"maxItems":50,"description":"As faixas de preço (`schema=tiered`), em ordem crescente de `upTo`."},"cycles":{"type":"integer","maximum":999,"minimum":1,"nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","default":"unit","description":"Como o preço é calculado: `unit` (preço × quantidade), `tiered` (por faixas de quantidade) ou `package` (por bloco de unidades)."},"currency":{"type":"string","default":"BRL","description":"Código de moeda ISO 4217"},"oldPrice":{"type":"integer","maximum":200000000,"minimum":1,"description":"O preço antes de um desconto, em centavos — mostrado riscado."},"daysTrial":{"type":"integer","maximum":365,"minimum":1,"description":"Duração do período de teste de um plano recorrente, em dias."},"tiersMode":{"enum":["graduated","volume"],"type":"string","description":"`graduated`: cada faixa precifica as próprias unidades; `volume`: a faixa atingida precifica todas as unidades."},"unitPrice":{"type":"integer","maximum":200000000,"minimum":1,"description":"Preço unitário, em centavos (mínimo 500 em `unit`; não usado em `tiered`)."},"usageType":{"enum":["licensed","metered"],"type":"string","default":"licensed","description":"`licensed` (quantidade fixa) ou `metered` (cobrado pelo uso que você reporta)."},"billingType":{"enum":["prepaid","postpaid","exactday"],"type":"string","description":"Quando um ciclo é cobrado: `prepaid` (no início), `postpaid` (no fim) ou `exactday` (em `billingExactDay`)."},"costPerItem":{"type":"integer","maximum":200000000,"minimum":0,"description":"O seu custo por unidade, em centavos (para os seus relatórios de margem)."},"trialInterval":{"enum":["day","week","month","year"],"type":"string","description":"Unidade da duração do teste."},"meterEventName":{"type":"string","maxLength":64,"minLength":1,"description":"Nome do medidor de uso que você reporta (só `metered`)."},"billingExactDay":{"type":"integer","maximum":31,"minimum":1,"description":"Dia do mês em que o ciclo é cobrado (`billingType=exactday`)."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: cobrar o frete cotado no checkout em CADA renovação (padrão `true`)."},"billingFrequency":{"enum":["daily","weekly","monthly","yearly"],"type":"string","description":"Unidade do intervalo de cobrança."},"usageAggregation":{"enum":["sum","max","lastDuringPeriod","lastEver"],"type":"string","description":"Como os registros de uso de um ciclo são agregados: `sum`, `max`, `lastDuringPeriod` ou `lastEver`."},"transformQuantity":{"type":"object","required":["divideBy"],"properties":{"round":{"enum":["up","down"],"type":"string","default":"up","description":"Como um bloco parcial é arredondado."},"divideBy":{"type":"integer","maximum":1000000000,"minimum":1,"description":"Unidades por bloco."}},"description":"Em `schema=package`: quantas unidades formam um bloco, e como um bloco parcial é arredondado.","additionalProperties":false},"trialIntervalCount":{"type":"integer","maximum":365,"minimum":1,"description":"Duração do teste, em unidades de `trialInterval`."},"billingFrequencyCount":{"type":"integer","maximum":999,"minimum":1,"description":"Quantas unidades de `billingFrequency` por ciclo."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: estender o desconto do meio de pagamento do checkout às renovações cobradas pelo mesmo meio (padrão `false`)."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"attributes":{"type":"object","description":"Atributos livres da variante (tamanho, cor…).","additionalProperties":{}},"description":{"type":"string","maxLength":255,"description":"Descrição."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador da variante."}},"additionalProperties":false},"example":{"sku":"string","name":"Acme Ltda","fiscal":{"nbs":"id_0a1b2c3d4e5f60718293","ncm":"id_0a1b2c3d4e5f60718293","cest":"id_0a1b2c3d4e5f60718293","gtin":"id_0a1b2c3d4e5f60718293","kind":"service","unit":"string","origin":0,"cClassTrib":"id_0a1b2c3d4e5f60718293","serviceCode":"id_0a1b2c3d4e5f60718293","cityServiceCode":"string"},"images":["https://example.com"],"enabled":true,"pricing":{"type":"oneTime","tiers":[{"upTo":1,"flatPrice":5000,"unitPrice":5000}],"cycles":1,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":1,"tiersMode":"graduated","unitPrice":5000,"usageType":"licensed","billingType":"prepaid","costPerItem":0,"trialInterval":"day","meterEventName":"string","billingExactDay":1,"renewalShipping":true,"billingFrequency":"daily","usageAggregation":"sum","transformQuantity":{"round":"up","divideBy":1},"trialIntervalCount":1,"billingFrequencyCount":1,"renewalMethodDiscount":true},"metadata":{},"attributes":{},"description":"string","externalReference":"string"}}},"required":true}}},"/v1/checkouts/sessions/{sessionId}":{"get":{"tags":["Checkout"],"summary":"Consulta uma sessão de checkout","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["object","id","url","status","ambient","source","currency","lineItems","totals","coupons","customer","address","paymentMethods","paymentSelection","redirectUrls","utm","cookies","metadata","customInputs","integrationType","integrationId","externalTransactionId","firstInitialization","online","expiresAt","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(sess|ckts|ses)_.+$","description":"Identificador público (sess_/ckts_/ses_…)"},"url":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta sessão; `null` quando não há."},"utm":{"type":"object","nullable":true,"description":"Atribuição de marketing; `null` quando não há.","additionalProperties":{}},"object":{"enum":["checkout.session"],"type":"string","description":"Sempre `checkout.session`."},"online":{"type":"boolean","description":"Se o comprador está no checkout agora (um sinal recente da página)."},"source":{"type":"string","nullable":true,"description":"De onde a sessão veio; `null` quando desconhecido."},"status":{"enum":["active","completed","cancelled","abandoned","expired"],"type":"string","description":"`active` (o comprador está no checkout), `completed` (pago), `cancelled`, `abandoned` ou `expired`."},"totals":{"type":"object","required":["amount","discount","shipping","tax"],"properties":{"tax":{"type":"integer","nullable":true,"description":"Total de impostos, em centavos."},"amount":{"type":"integer","nullable":true,"description":"Total do carrinho, em centavos; `null` quando o carrinho nunca foi precificado."},"discount":{"type":"integer","nullable":true,"description":"Total de desconto, em centavos."},"shipping":{"type":"integer","nullable":true,"description":"Total do frete, em centavos."}},"description":"Os totais do carrinho; todos `null` quando nunca foi precificado.","additionalProperties":false},"address":{"type":"object","nullable":true,"description":"O endereço, como preenchido; `null` quando ainda não há nada.","additionalProperties":{}},"ambient":{"type":"string","description":"Ambiente: `live` ou `sandbox`."},"cookies":{"type":"object","nullable":true,"description":"Cookies de rastreio do comprador, pelo nome do cookie; `null` quando não há.","additionalProperties":{}},"coupons":{"type":"array","items":{"type":"object","required":["code","type","value"],"properties":{"code":{"type":"string","nullable":true,"description":"Código do cupom."},"type":{"type":"string","nullable":true,"description":"`flat` ou `percentage`."},"value":{"type":"number","nullable":true,"description":"O valor do desconto."}},"additionalProperties":false},"description":"Cupons aplicados."},"currency":{"enum":["BRL"],"type":"string","description":"Sempre `BRL`."},"customer":{"type":"object","nullable":true,"description":"O comprador, como preenchido; `null` quando ainda não há nada.","additionalProperties":{}},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"expiresAt":{"type":"string","nullable":true,"description":"Quando a sessão expira."},"lineItems":{"type":"array","items":{"type":"object","required":["id","name","quantity","unitPrice","currency","isOrderbump","isUpsell","metadata","externalReference"],"properties":{"id":{"type":"string","nullable":true,"description":"A variante do catálogo; `null` num item avulso."},"name":{"type":"string","nullable":true,"description":"Nome do item."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"isUpsell":{"type":"boolean","description":"Se o item foi adicionado por uma oferta de upsell."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"unitPrice":{"type":"number","nullable":true,"description":"Preço unitário, em centavos; `null` quando ainda não precificado."},"isOrderbump":{"type":"boolean","description":"Se o item foi adicionado por um order bump."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"description":"Uma linha do carrinho.","additionalProperties":false},"description":"O carrinho."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"customInputs":{"enum":["null"],"nullable":true,"description":"Sempre `null`."},"redirectUrls":{"type":"object","required":["paid","refused","pending"],"properties":{"paid":{"type":"string","nullable":true,"description":"Para onde o comprador vai depois de um pedido pago."},"pending":{"type":"string","nullable":true,"description":"Para onde o comprador vai enquanto o pagamento está pendente."},"refused":{"type":"string","nullable":true,"description":"Para onde o comprador vai depois de uma recusa."}},"description":"Para onde o comprador é enviado depois do pagamento, por desfecho.","additionalProperties":false},"integrationId":{"type":"string","nullable":true,"description":"Id público dessa integração; `null` quando não há."},"paymentMethods":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"description":"Meios de pagamento oferecidos."},"integrationType":{"type":"string","nullable":true,"description":"Tipo da integração a que a sessão pertence; `null` quando não há."},"paymentSelection":{"type":"object","nullable":true,"required":["method"],"properties":{"method":{"type":"string","description":"O meio escolhido."}},"description":"O meio de pagamento que o comprador escolheu; `null` até lá.","additionalProperties":false},"firstInitialization":{"type":"boolean","description":"Se é a primeira vez que a sessão foi inicializada."},"externalTransactionId":{"type":"string","nullable":true,"description":"O id do seu pedido; `null` quando não há."}},"additionalProperties":false},"example":{"id":"sess_0a1b2c3d4e5f60718293","url":"string","utm":{},"object":"checkout.session","online":true,"source":"string","status":"active","totals":{"tax":0,"amount":5000,"discount":0,"shipping":0},"address":{},"ambient":"string","cookies":{},"coupons":[{"code":"string","type":"string","value":5000}],"currency":"BRL","customer":{},"metadata":{},"createdAt":"string","expiresAt":"string","lineItems":[{"id":"string","name":"Acme Ltda","currency":"BRL","isUpsell":true,"metadata":{},"quantity":0,"unitPrice":5000,"isOrderbump":true,"externalReference":"string"}],"updatedAt":"string","customInputs":"null","redirectUrls":{"paid":"string","pending":"string","refused":"string"},"integrationId":"string","paymentMethods":["string"],"integrationType":"string","paymentSelection":{"method":"string"},"firstInitialization":true,"externalTransactionId":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","pattern":"^(sess|ckts|ses)_.+$"},"required":true,"description":"Identificador público (sess_/ckts_/ses_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getCheckoutSession"},"put":{"tags":["Checkout"],"summary":"Atualiza uma sessão de checkout","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["object","id","url","status","ambient","source","currency","lineItems","totals","coupons","customer","address","paymentMethods","paymentSelection","redirectUrls","utm","cookies","metadata","customInputs","integrationType","integrationId","externalTransactionId","firstInitialization","online","expiresAt","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(sess|ckts|ses)_.+$","description":"Identificador público (sess_/ckts_/ses_…)"},"url":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta sessão; `null` quando não há."},"utm":{"type":"object","nullable":true,"description":"Atribuição de marketing; `null` quando não há.","additionalProperties":{}},"object":{"enum":["checkout.session"],"type":"string","description":"Sempre `checkout.session`."},"online":{"type":"boolean","description":"Se o comprador está no checkout agora (um sinal recente da página)."},"source":{"type":"string","nullable":true,"description":"De onde a sessão veio; `null` quando desconhecido."},"status":{"enum":["active","completed","cancelled","abandoned","expired"],"type":"string","description":"`active` (o comprador está no checkout), `completed` (pago), `cancelled`, `abandoned` ou `expired`."},"totals":{"type":"object","required":["amount","discount","shipping","tax"],"properties":{"tax":{"type":"integer","nullable":true,"description":"Total de impostos, em centavos."},"amount":{"type":"integer","nullable":true,"description":"Total do carrinho, em centavos; `null` quando o carrinho nunca foi precificado."},"discount":{"type":"integer","nullable":true,"description":"Total de desconto, em centavos."},"shipping":{"type":"integer","nullable":true,"description":"Total do frete, em centavos."}},"description":"Os totais do carrinho; todos `null` quando nunca foi precificado.","additionalProperties":false},"address":{"type":"object","nullable":true,"description":"O endereço, como preenchido; `null` quando ainda não há nada.","additionalProperties":{}},"ambient":{"type":"string","description":"Ambiente: `live` ou `sandbox`."},"cookies":{"type":"object","nullable":true,"description":"Cookies de rastreio do comprador, pelo nome do cookie; `null` quando não há.","additionalProperties":{}},"coupons":{"type":"array","items":{"type":"object","required":["code","type","value"],"properties":{"code":{"type":"string","nullable":true,"description":"Código do cupom."},"type":{"type":"string","nullable":true,"description":"`flat` ou `percentage`."},"value":{"type":"number","nullable":true,"description":"O valor do desconto."}},"additionalProperties":false},"description":"Cupons aplicados."},"currency":{"enum":["BRL"],"type":"string","description":"Sempre `BRL`."},"customer":{"type":"object","nullable":true,"description":"O comprador, como preenchido; `null` quando ainda não há nada.","additionalProperties":{}},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"expiresAt":{"type":"string","nullable":true,"description":"Quando a sessão expira."},"lineItems":{"type":"array","items":{"type":"object","required":["id","name","quantity","unitPrice","currency","isOrderbump","isUpsell","metadata","externalReference"],"properties":{"id":{"type":"string","nullable":true,"description":"A variante do catálogo; `null` num item avulso."},"name":{"type":"string","nullable":true,"description":"Nome do item."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"isUpsell":{"type":"boolean","description":"Se o item foi adicionado por uma oferta de upsell."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"unitPrice":{"type":"number","nullable":true,"description":"Preço unitário, em centavos; `null` quando ainda não precificado."},"isOrderbump":{"type":"boolean","description":"Se o item foi adicionado por um order bump."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"description":"Uma linha do carrinho.","additionalProperties":false},"description":"O carrinho."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"customInputs":{"enum":["null"],"nullable":true,"description":"Sempre `null`."},"redirectUrls":{"type":"object","required":["paid","refused","pending"],"properties":{"paid":{"type":"string","nullable":true,"description":"Para onde o comprador vai depois de um pedido pago."},"pending":{"type":"string","nullable":true,"description":"Para onde o comprador vai enquanto o pagamento está pendente."},"refused":{"type":"string","nullable":true,"description":"Para onde o comprador vai depois de uma recusa."}},"description":"Para onde o comprador é enviado depois do pagamento, por desfecho.","additionalProperties":false},"integrationId":{"type":"string","nullable":true,"description":"Id público dessa integração; `null` quando não há."},"paymentMethods":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"description":"Meios de pagamento oferecidos."},"integrationType":{"type":"string","nullable":true,"description":"Tipo da integração a que a sessão pertence; `null` quando não há."},"paymentSelection":{"type":"object","nullable":true,"required":["method"],"properties":{"method":{"type":"string","description":"O meio escolhido."}},"description":"O meio de pagamento que o comprador escolheu; `null` até lá.","additionalProperties":false},"firstInitialization":{"type":"boolean","description":"Se é a primeira vez que a sessão foi inicializada."},"externalTransactionId":{"type":"string","nullable":true,"description":"O id do seu pedido; `null` quando não há."}},"additionalProperties":false},"example":{"id":"sess_0a1b2c3d4e5f60718293","url":"string","utm":{},"object":"checkout.session","online":true,"source":"string","status":"active","totals":{"tax":0,"amount":5000,"discount":0,"shipping":0},"address":{},"ambient":"string","cookies":{},"coupons":[{"code":"string","type":"string","value":5000}],"currency":"BRL","customer":{},"metadata":{},"createdAt":"string","expiresAt":"string","lineItems":[{"id":"string","name":"Acme Ltda","currency":"BRL","isUpsell":true,"metadata":{},"quantity":0,"unitPrice":5000,"isOrderbump":true,"externalReference":"string"}],"updatedAt":"string","customInputs":"null","redirectUrls":{"paid":"string","pending":"string","refused":"string"},"integrationId":"string","paymentMethods":["string"],"integrationType":"string","paymentSelection":{"method":"string"},"firstInitialization":true,"externalTransactionId":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","pattern":"^(sess|ckts|ses)_.+$"},"required":true,"description":"Identificador público (sess_/ckts_/ses_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateCheckoutSession","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"utm":{"type":"object","description":"Atribuição de marketing (`source`, `medium`, `campaign`, `content`, `term`). Capturada uma vez; imutável na atualização.","additionalProperties":{}},"items":{"type":"array","items":{"type":"object","additionalProperties":{}},"default":[],"description":"O carrinho: um objeto por linha (`id` da variante, `quantity`…). Validado contra o seu catálogo quando a sessão é enviada para pagamento."},"client":{"type":"object","description":"Dados do cliente, incluindo a UTM da primeira visita (JSON livre; imutável depois da primeira inicialização).","additionalProperties":{}},"source":{"type":"string","maxLength":20,"description":"De onde a sessão veio (texto livre, até 20 caracteres)."},"status":{"enum":["active","abandoned"],"type":"string","description":"Marcar a sessão como `abandoned`, ou de volta a `active`."},"address":{"type":"object","description":"O endereço, como preenchido até agora (JSON livre).","additionalProperties":{}},"ambient":{"enum":["live","sandbox"],"type":"string","description":"Aceito por compatibilidade; o ambiente vem sempre da sua credencial."},"cookies":{"type":"object","description":"Cookies de rastreio do comprador, pelo nome do cookie (`_fbp`, `_fbc`, `_ga`, `gclid`…), para a atribuição dos pixels.","additionalProperties":{}},"coupons":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"description":"Cupons aplicados: códigos, ou objetos com `code`."},"customer":{"type":"object","description":"O comprador, como preenchido até agora (JSON livre).","additionalProperties":{}},"language":{"type":"string","maxLength":20,"description":"Idioma do comprador (ex.: `pt-BR`)."},"metadata":{"type":"object","description":"Os seus metadados chave-valor.","additionalProperties":{}},"timezone":{"type":"string","maxLength":50,"description":"Fuso horário do comprador (ex.: `America/Sao_Paulo`)."},"totalTax":{"type":"integer","minimum":0,"description":"Total de impostos, em centavos."},"expiresAt":{"type":"string","format":"date-time","description":"Quando a sessão expira; derivado das suas configurações quando omitido."},"lineItems":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Apelido de `items`."},"onBehalfOf":{"type":"string","pattern":"^.+_.+$","description":"Marketplace: a cobrança que esta sessão liquida é feita NA sub-conta sua indicada (ela passa a ser a vendedora de registro); a sua taxa de plataforma é recolhida como split."},"totalAmount":{"type":"integer","minimum":0,"description":"Total do carrinho, em centavos."},"redirectUrls":{"type":"object","description":"Para onde o comprador é enviado depois do pagamento, por desfecho (`paid`, `refused`, `pending`): URLs `https://`; vazio ou `null` = não definido.","additionalProperties":{"anyOf":[{"type":"string","format":"uri","description":"URL `https://` absoluta para onde o comprador pode ser enviado (`http://` só em localhost), sem credenciais."},{"enum":[""],"type":"string"},{"enum":["null"],"nullable":true}]}},"integrationId":{"type":"string","maxLength":255,"description":"Id público dessa integração."},"totalDiscount":{"type":"integer","minimum":0,"description":"Total de desconto, em centavos."},"totalShipping":{"type":"integer","minimum":0,"description":"Total do frete, em centavos."},"paymentMethods":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"description":"Meios de pagamento oferecidos nesta sessão."},"integrationType":{"type":"string","maxLength":50,"description":"Tipo da integração a que a sessão pertence (ex.: `woocommerce`)."},"shippingDelivery":{"type":"object","description":"A opção de frete escolhida (JSON livre).","additionalProperties":{}},"externalTransactionId":{"type":"string","maxLength":255,"description":"O id do seu pedido para esta sessão."}},"additionalProperties":false},"example":{"utm":{},"items":[],"client":{},"source":"string","status":"active","address":{},"ambient":"live","cookies":{},"coupons":["string"],"customer":{},"language":"string","metadata":{},"timezone":"string","totalTax":5000,"expiresAt":"2026-01-15T12:00:00.000Z","lineItems":[{}],"onBehalfOf":"id_0a1b2c3d4e5f60718293","totalAmount":5000,"redirectUrls":{},"integrationId":"string","totalDiscount":5000,"totalShipping":5000,"paymentMethods":["string"],"integrationType":"string","shippingDelivery":{},"externalTransactionId":"string"}}},"required":true}},"delete":{"tags":["Checkout"],"summary":"Cancela uma sessão de checkout","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","pattern":"^(sess|ckts|ses)_.+$","description":"Id público do recurso excluído."},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"resource":{"enum":["checkoutSession"],"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"sess_0a1b2c3d4e5f60718293","deleted":true,"resource":"checkoutSession"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","pattern":"^(sess|ckts|ses)_.+$"},"required":true,"description":"Identificador público (sess_/ckts_/ses_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteCheckoutSession"}},"/v1/subscriptions/{subscriptionId}":{"get":{"tags":["Subscriptions"],"summary":"Consulta uma assinatura","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","currency","method","type","currentCycle","customer","billing","canceledAt","cancellation","discount","discounts","renewalTerms","shippable","shipping","spplited","splits","items","callback","geolocation","externalReference","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(subs|sub)_.+$","description":"Identificador público (subs_/sub_…)"},"type":{"type":"string","nullable":true,"description":"Tipo da assinatura (`recurring`)."},"items":{"type":"array","items":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"description":"Os itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"method":{"type":"string","nullable":true,"description":"Como os ciclos são cobrados: `credit`, `pix` ou `billet`."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"Splits de cada cobrança de ciclo; `null` quando não há."},"status":{"enum":["active","trialing","pending","paused","pastdue","unpaid","canceled"],"type":"string","description":"Status: `active`, `trialing`, `pending`, `paused`, `pastdue`, `unpaid` ou `canceled`."},"billing":{"type":"object","required":["frequency","frequencyCount","endDate","exactDay","freeTrialDays","autoRenew","address"],"properties":{"address":{"type":"object","required":["street","number","complement","district","city","state","country","postcode","line","fingerprint","line1","line2","line3"],"properties":{"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","nullable":true,"description":"Bairro."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."},"fingerprint":{"type":"string","nullable":true,"description":"Impressão digital do endereço (deduplicação)."}},"description":"O endereço do pagador (usado no boleto de cada ciclo). Todos os campos `null` quando não há.","additionalProperties":false},"endDate":{"type":"string","nullable":true,"description":"Quando a assinatura termina; `null` = nunca."},"exactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que é cobrada; `null` quando não é fixo."},"autoRenew":{"type":"boolean","description":"Se a assinatura se renova sozinha no fim de cada período (`false` depois de um cancelamento no fim do período)."},"frequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança: `daily`, `weekly`, `monthly` ou `yearly`."},"freeTrialDays":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"frequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo."}},"description":"Periodicidade da cobrança e endereço do pagador.","additionalProperties":false},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","description":"URL que recebe os webhooks desta assinatura."}},"description":"Webhook próprio; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"customer":{"type":"object","required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","additionalEmails","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do cliente (`cus_…`)."},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail."},"gender":{"type":"string","nullable":true,"description":"Gênero; `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento."},"number":{"type":"string","nullable":true,"description":"Número do documento."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do cliente."}},"description":"O comprador.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"number","description":"O desconto."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado; `null` quando não há.","additionalProperties":false},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shipping":{"type":"object","nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há.","additionalProperties":{}},"spplited":{"type":"boolean","description":"Se as cobranças dos ciclos são divididas com outras contas (ver `splits`). O nome mantém a grafia histórica."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a assinatura tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando a assinatura foi encerrada; `null` enquanto está viva."},"geolocation":{"type":"object","nullable":true,"description":"Sinais de dispositivo e localização do comprador, como enviados; `null` quando não há.","additionalProperties":{}},"cancellation":{"type":"object","nullable":true,"required":["reasonCode","reason","canceledBy"],"properties":{"reason":{"type":"string","nullable":true,"description":"O texto livre escrito por quem cancelou."},"canceledBy":{"enum":["seller","customer","platform"],"type":"string","nullable":true,"description":"`seller` (API ou painel), `customer` (portal) ou `platform` (régua de cobrança, chargeback, estorno)."},"reasonCode":{"enum":["price","not_using","technical_issue","switched_provider","other"],"type":"string","nullable":true,"description":"O motivo da lista; `null` nos cancelamentos antigos e nos da própria plataforma."}},"description":"Por que foi cancelada; `null` enquanto ninguém pediu o cancelamento.","additionalProperties":false},"currentCycle":{"type":"object","nullable":true,"required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"description":"O ciclo de cobrança atual; `null` quando não há.","additionalProperties":false},"pixAutomatic":{"type":"object","nullable":true,"required":["status","journey","qrCodeEmv","qrCodeUrl","valueCents","firstChargeDate","approvedAt","endReason"],"properties":{"status":{"enum":["pending","awaitingAuthorization","active","rejected","ended"],"type":"string","description":"`pending` (sendo criado) · `awaitingAuthorization` (QR code exibido) · `active` (debitado a cada ciclo) · `rejected` (o pagador recusou ou revogou) · `ended`. Depois de `rejected`/`ended` os ciclos são cobrados por um QR code cada."},"journey":{"enum":["paymentOnApproval","onlyRecurrency"],"type":"string","description":"`paymentOnApproval`: o primeiro ciclo é pago junto com a autorização; `onlyRecurrency`: só a recorrência é autorizada."},"endReason":{"type":"string","nullable":true,"description":"Por que terminou; `null` enquanto ativo."},"qrCodeEmv":{"type":"string","nullable":true,"description":"O QR code de autorização (copia e cola) — só enquanto `awaitingAuthorization`."},"qrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code de autorização — só enquanto `awaitingAuthorization`."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o pagador autorizou; `null` até lá."},"valueCents":{"type":"integer","description":"O valor fixo debitado a cada ciclo, em centavos."},"firstChargeDate":{"type":"string","description":"Data do primeiro débito."}},"description":"Só na leitura individual; `null` quando a assinatura não é paga por Pix Automático.","additionalProperties":false},"renewalTerms":{"type":"object","nullable":true,"required":["shipping","shippingAmount","methodDiscount","discountMethod","discountPercentage"],"properties":{"shipping":{"type":"boolean","description":"Se o frete é cobrado em cada renovação."},"discountMethod":{"enum":["credit","pix","billet"],"type":"string","nullable":true,"description":"O meio que concedeu o desconto no checkout; `null` quando nenhum."},"methodDiscount":{"type":"boolean","description":"Se o desconto do meio de pagamento vale nas renovações cobradas por `discountMethod`."},"shippingAmount":{"type":"integer","description":"O frete cotado no checkout, em centavos (0 = sem frete)."},"discountPercentage":{"type":"number","description":"O desconto desse meio, como percentual (ex.: 5 = 5%)."}},"description":"O que cada renovação cobra além dos itens, congelado na criação; `null` = nada congelado (as renovações cobram itens menos cupons).","additionalProperties":false},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da assinatura; `null` quando não há."}},"additionalProperties":false},"example":{"id":"subs_0a1b2c3d4e5f60718293","type":"string","items":[{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","images":["string"],"enabled":true,"currency":"BRL","metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}],"_links":{},"method":"string","splits":[{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"liable":true,"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}],"status":"active","billing":{"address":{"city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","number":"1000","street":"string","country":"string","district":"string","postcode":"string","complement":"string","fingerprint":"string"},"endDate":"string","exactDay":0,"autoRenew":true,"frequency":"string","freeTrialDays":0,"frequencyCount":0},"callback":{"active":true,"webhookUrl":"string"},"currency":"BRL","customer":{"id":"string","email":"buyer@example.com","gender":"string","document":{"type":"string","number":"12345678909"},"lastName":"Silva","metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"},"discount":{"type":"string","value":5000,"percentageOfAmount":5000},"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shipping":{},"spplited":true,"createdAt":"string","discounts":[],"shippable":true,"updatedAt":"string","canceledAt":"string","geolocation":{},"cancellation":{"reason":"string","canceledBy":"seller","reasonCode":"price"},"currentCycle":{"id":"scy_0a1b2c3d4e5f60718293","cycle":0,"status":"string","dueDate":"string","endDate":"string","billedAt":"string","createdAt":"string","startDate":"string","updatedAt":"string"},"pixAutomatic":{"status":"pending","journey":"paymentOnApproval","endReason":"string","qrCodeEmv":"string","qrCodeUrl":"string","approvedAt":"string","valueCents":5000,"firstChargeDate":"string"},"renewalTerms":{"shipping":true,"discountMethod":"credit","methodDiscount":true,"shippingAmount":5000,"discountPercentage":0},"externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getSubscription"}},"/v1/utils/corporate-document-check":{"get":{"tags":["Utils"],"summary":"Valida um CPF/CNPJ (dígitos verificadores) e, para um CNPJ, enriquece com o cadastro da empresa","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["valid","document","type","name","fantasyName","email","telephone","cnae","cnaeDescription","legalNature","openingDate","registrationStatus","registrationStatusDate","active","shareCapital","size","simplesOptant","meiOptant","address","secondaryCnaes","partners"],"properties":{"cnae":{"type":"string","nullable":true,"description":"Código da atividade principal (CNAE)."},"name":{"type":"string","nullable":true,"description":"Razão social da empresa (só CNPJ)."},"size":{"type":"string","nullable":true,"description":"Porte da empresa (ex.: `ME`, `EPP`)."},"type":{"enum":["cpf","cnpj"],"type":"string","nullable":true,"description":"`cpf` ou `cnpj`; `null` quando inválido."},"email":{"type":"string","nullable":true,"description":"E-mail cadastrado (só CNPJ)."},"valid":{"type":"boolean","description":"Se o documento passa na validação dos dígitos verificadores."},"active":{"type":"boolean","nullable":true,"description":"Se a empresa está ativa na Receita."},"address":{"type":"object","nullable":true,"required":["postcode","street","number","complement","district","city","state","country"],"properties":{"city":{"type":"string","nullable":true,"description":"Cidade."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","description":"Código do país."},"district":{"type":"string","nullable":true,"description":"Bairro."},"postcode":{"type":"string","nullable":true,"description":"CEP."},"complement":{"type":"string","nullable":true,"description":"Complemento."}},"description":"Endereço cadastrado; `null` quando não disponível.","additionalProperties":false},"document":{"type":"string","description":"O documento, só dígitos."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"partners":{"type":"array","items":{"type":"object","required":["name","qualification","since"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome do sócio."},"since":{"type":"string","nullable":true,"description":"Desde quando."},"qualification":{"type":"string","nullable":true,"description":"Qualificação do sócio."}},"additionalProperties":false},"description":"Sócios da empresa."},"meiOptant":{"type":"boolean","nullable":true,"description":"Se é MEI."},"telephone":{"type":"string","nullable":true,"description":"Telefone cadastrado (só CNPJ)."},"fantasyName":{"type":"string","nullable":true,"description":"Nome fantasia (só CNPJ)."},"legalNature":{"type":"string","nullable":true,"description":"Natureza jurídica da empresa."},"openingDate":{"type":"string","nullable":true,"description":"Quando a empresa foi aberta."},"shareCapital":{"type":"number","nullable":true,"description":"Capital social, em reais."},"simplesOptant":{"type":"boolean","nullable":true,"description":"Se é optante do Simples Nacional."},"secondaryCnaes":{"type":"array","items":{"type":"object","required":["code","description"],"properties":{"code":{"type":"string","nullable":true,"description":"Código da atividade."},"description":{"type":"string","nullable":true,"description":"Descrição."}},"additionalProperties":false},"description":"Atividades secundárias."},"cnaeDescription":{"type":"string","nullable":true,"description":"Descrição da atividade principal."},"registrationStatus":{"type":"string","nullable":true,"description":"Situação cadastral (ex.: `ATIVA`)."},"registrationStatusDate":{"type":"string","nullable":true,"description":"Quando essa situação foi definida."}},"additionalProperties":false},"example":{"cnae":"string","name":"Acme Ltda","size":"string","type":"cpf","email":"buyer@example.com","valid":true,"active":true,"address":{"city":"string","state":"string","number":"1000","street":"string","country":"string","district":"string","postcode":"string","complement":"string"},"document":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"partners":[{"name":"Acme Ltda","since":"string","qualification":"string"}],"meiOptant":true,"telephone":"string","fantasyName":"string","legalNature":"string","openingDate":"string","shareCapital":0,"simplesOptant":true,"secondaryCnaes":[{"code":"string","description":"string"}],"cnaeDescription":"string","registrationStatus":"string","registrationStatusDate":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"document","schema":{"type":"string","maxLength":20,"minLength":9},"required":true,"description":"O CPF ou CNPJ a conferir; a máscara é aceita."}],"operationId":"utilsCorporateDocumentCheck"}},"/v1/webhooks/events/{eventId}/resend":{"post":{"tags":["Webhooks"],"summary":"Reenvia um evento de webhook","responses":{"202":{"content":{"application/json":{"schema":{"type":"object","required":["accepted","id"],"properties":{"id":{"type":"string","description":"Id público do evento ou da entrega que será enviada."},"accepted":{"enum":[true],"type":"boolean","description":"Sempre `true`: o pedido foi aceito; a entrega acontece em segundo plano."}},"additionalProperties":false},"example":{"id":"string","accepted":true}}},"description":"Aceito"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"eventId","schema":{"type":"string","pattern":"^(wbh)_.+$"},"required":true,"description":"Identificador público (wbh_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"resendWebhookEvent"}},"/v1/checkouts/sessions/{sessionId}/pay":{"post":{"tags":["Checkout"],"summary":"Envia uma sessão de checkout para pagamento (assíncrono)","responses":{"202":{"content":{"application/json":{"schema":{"type":"object","required":["jobId","status","sessionId"],"properties":{"jobId":{"type":"string","pattern":"^(payjob)_.+$","description":"Identificador público (payjob_…)"},"status":{"enum":["pending","processing","requiresAction","completed","failed"],"type":"string","description":"Estado do processamento do pagamento: `pending`, `processing`, `requiresAction`, `completed` ou `failed`."},"sessionId":{"type":"string","pattern":"^(sess|ckts|ses)_.+$","description":"Identificador público (sess_/ckts_/ses_…)"}},"additionalProperties":false},"example":{"jobId":"payjob_0a1b2c3d4e5f60718293","status":"pending","sessionId":"sess_0a1b2c3d4e5f60718293"}}},"description":"Aceito"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","pattern":"^(sess|ckts|ses)_.+$"},"required":true,"description":"Identificador público (sess_/ckts_/ses_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"submitCheckoutPayment","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment"],"properties":{"payment":{"type":"object","required":["method"],"properties":{"cardId":{"type":"string","pattern":"^(card)_.+$","description":"O cartão salvo a cobrar; obrigatório para `credit`."},"method":{"enum":["credit","pix","billet"],"type":"string","description":"Método de pagamento: `credit`, `pix` ou `billet`."},"capture":{"type":"boolean","default":true,"description":"Se a cobrança no cartão é capturada na hora (`true`) ou só autorizada (`false`)."},"installments":{"type":"integer","default":1,"maximum":21,"minimum":1,"description":"Número de parcelas (1–21); o máximo oferecido é o configurado para a conta."}},"description":"A escolha do pagamento; o carrinho e o comprador vêm da sessão.","additionalProperties":false}},"additionalProperties":false},"example":{"payment":{"cardId":"card_0a1b2c3d4e5f60718293","method":"credit","capture":true,"installments":1}}}},"required":true}}},"/v1/marketplace/kyc/{token}/onboarding":{"get":{"tags":["Marketplace"],"summary":"Consulta o estado do cadastro da sub-conta pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","logo","legalBusinessName","email","cellphone","document","documentType","country","website","description","referrer","revenue","monthlyBillingEstimate","softdescriptor","platformBrand","mcc","status","createdAt","updatedAt","onboarding","_links"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"mcc":{"type":"string","nullable":true,"description":"Código de categoria do estabelecimento (MCC); `null` até ser definido."},"logo":{"type":"string","nullable":true,"description":"URL do logotipo; `null` quando nenhum foi enviado."},"name":{"type":"string","description":"Nome fantasia da empresa (o que os compradores veem)."},"email":{"type":"string","nullable":true,"description":"E-mail de contato da empresa; `null` até o passo 4."},"_links":{"type":"object","required":["self","onboarding"],"properties":{"self":{"type":"string","description":"URL desta empresa."},"onboarding":{"type":"string","description":"URL da visão do onboarding."}},"description":"Links para esta empresa e para o onboarding dela.","additionalProperties":false},"status":{"type":"string","nullable":true,"description":"Status da conta (`pending`, `analyzing`, `active`, `suspended`…); `null` quando não definido."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1); `null` até o passo 1."},"revenue":{"type":"number","nullable":true,"description":"Faturamento mensal declarado, em centavos; `null` até o passo 1."},"website":{"type":"string","nullable":true,"description":"URL do site; `null` quando não há."},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ, só dígitos; `null` até o passo 2."},"referrer":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."},"cellphone":{"type":"string","nullable":true,"description":"Telefone de contato, só dígitos; `null` até o passo 4."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"onboarding":{"type":"object","required":["onboardingId","currentStep","isCompleted","completedAt","inviteCode","referralSource","overview","checklist"],"properties":{"overview":{"type":"object","description":"O que cada passo registrou (campos sensíveis mascarados).","additionalProperties":{}},"checklist":{"type":"object","description":"Quais passos foram concluídos (`checkListStep1Complete`…`checkListStep6Complete`).","additionalProperties":{}},"inviteCode":{"type":"string","nullable":true,"description":"O código de convite resgatado no passo 1; `null` quando não há."},"completedAt":{"type":"string","nullable":true,"description":"Quando o onboarding foi concluído (ISO 8601); `null` até lá."},"currentStep":{"type":"string","description":"O passo em que o onboarding está (`1` a `6`)."},"isCompleted":{"type":"boolean","description":"Se todos os passos foram concluídos."},"onboardingId":{"type":"string","pattern":"^(cob|onb)_.+$","nullable":true,"description":"Identificador público (cob_/onb_…)"},"referralSource":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."}},"description":"Andamento do onboarding.","additionalProperties":false},"description":{"type":"string","nullable":true,"description":"O que a empresa vende, nas palavras dela; `null` até o passo 6."},"reviewDueAt":{"type":"string","nullable":true,"description":"Até quando a análise de KYC responde (ISO 8601); `null` quando a conta não está em análise ou não tem prazo. Só nas leituras."},"documentType":{"type":"string","nullable":true,"description":"`cpf` ou `cnpj`; `null` até o passo 1."},"corporateCnae":{"type":"string","nullable":true,"description":"CNAE principal da empresa; `null` quando desconhecido; omitido nas leituras do lojista."},"platformBrand":{"type":"boolean","description":"Se os links dos e-mails enviados aos compradores levam a marca da plataforma (`true`) ou o domínio próprio da empresa (`false`, marca branca)."},"softdescriptor":{"type":"string","nullable":true,"description":"O que aparece na fatura do cartão do comprador; `null` até o passo 4."},"corporateOpenDate":{"type":"string","nullable":true,"description":"Data de abertura da empresa (`YYYY-MM-DD`); `null` quando desconhecida; omitida nas leituras do lojista."},"legalBusinessName":{"type":"string","nullable":true,"description":"Razão social; `null` para pessoa física (CPF)."},"legalRepresentative":{"type":"object","nullable":true,"required":["firstName","lastName","document","birthYear","birthDate","redacted"],"properties":{"document":{"type":"string","nullable":true,"description":"CPF, mascarado a menos que revelado."},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"redacted":{"type":"boolean","description":"Se os campos estão mascarados."},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando mascarada."},"birthYear":{"type":"integer","nullable":true,"description":"Ano de nascimento."},"firstName":{"type":"string","nullable":true,"description":"Nome."}},"description":"O representante legal vigente; `null` quando a empresa não tem; omitido nas leituras do lojista.","additionalProperties":false},"paymentGroupsBlocked":{"type":"boolean","description":"Se os pagamentos combinados (dois cartões, cartão + Pix) estão bloqueados para esta empresa; omitido nas leituras do lojista."},"monthlyBillingEstimate":{"type":"string","nullable":true,"description":"Volume mensal de vendas esperado, em centavos (como texto); `null` até o passo 6."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","mcc":"string","logo":"string","name":"Acme Ltda","email":"buyer@example.com","_links":{"self":"string","onboarding":"string"},"status":"string","country":"string","revenue":0,"website":"string","document":"string","referrer":"string","cellphone":"string","createdAt":"string","updatedAt":"string","onboarding":{"overview":{},"checklist":{},"inviteCode":"string","completedAt":"string","currentStep":"string","isCompleted":true,"onboardingId":"cob_0a1b2c3d4e5f60718293","referralSource":"string"},"description":"string","reviewDueAt":"string","documentType":"string","corporateCnae":"string","platformBrand":true,"softdescriptor":"string","corporateOpenDate":"string","legalBusinessName":"string","legalRepresentative":{"document":"string","lastName":"Silva","redacted":true,"birthDate":"1990-05-20","birthYear":0,"firstName":"João"},"paymentGroupsBlocked":true,"monthlyBillingEstimate":"string"}}},"description":"Sucesso"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"viewKycOnboarding"}},"/v1/transactions/{transactionId}/refund":{"post":{"tags":["Transactions"],"summary":"Estorna uma transação","responses":{"202":{"content":{"application/json":{"schema":{"type":"object","required":["transactionId","status","accepted"],"properties":{"status":{"enum":["pending","pre-authorized","approved","failed","refused","canceled","refunded","chargeback","dispute","fraud-review","analyzing","awaiting"],"type":"string","description":"Status da cobrança depois de a ação ser aceita — o desfecho chega por webhook."},"accepted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a ação foi aceita."},"transactionId":{"type":"string","pattern":"^(tra|trx)_.+$","description":"Identificador público (tra_/trx_…)"}},"additionalProperties":false},"example":{"status":"pending","accepted":true,"transactionId":"tra_0a1b2c3d4e5f60718293"}}},"description":"Aceito"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string","pattern":"^(tra|trx)_.+$"},"required":true,"description":"Identificador público (tra_/trx_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"refundTransaction","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"description":"Valor a estornar, em centavos. Omitido = a cobrança inteira."},"reason":{"type":"string","maxLength":255,"description":"Por quê (texto livre, guardado no estorno)."}},"additionalProperties":false},"example":{"amount":5000,"reason":"string"}}},"required":true}}},"/v1/webhooks/dispatches/{id}/redispatch":{"post":{"tags":["Webhooks"],"summary":"Reenvia uma entrega agora","responses":{"202":{"content":{"application/json":{"schema":{"type":"object","required":["accepted","id"],"properties":{"id":{"type":"string","description":"Id público do evento ou da entrega que será enviada."},"accepted":{"enum":[true],"type":"boolean","description":"Sempre `true`: o pedido foi aceito; a entrega acontece em segundo plano."}},"additionalProperties":false},"example":{"id":"string","accepted":true}}},"description":"Aceito"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string","pattern":"^(wdi)_.+$"},"required":true,"description":"Identificador público (wdi_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"redispatchWebhook"}},"/v1/marketplace/sub-accounts/{companyId}":{"get":{"tags":["Marketplace"],"summary":"Consulta uma sub-conta","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","status","platformFee","planId","createdAt","kycSubmittedAt","approvedAt","volume30dCents"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"name":{"type":"string","description":"Nome do vendedor."},"planId":{"type":"string","pattern":"^(rate)_.+$","nullable":true,"description":"O plano de taxas atribuído; `null` quando a sub-conta usa `platformFee` ou nenhum."},"status":{"type":"string","nullable":true,"description":"Status do cadastro: `pending`, `analyzing`, `awaiting-documents`, `active`, `disabled`…"},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o cadastro foi aprovado; `null` quando nunca."},"platformFee":{"type":"object","nullable":true,"required":["type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor em centavos, conforme `type`."}},"description":"A taxa da plataforma sobre as vendas da sub-conta; `null` quando não há (ou quando vale um plano de taxas).","additionalProperties":false},"kycSubmittedAt":{"type":"string","nullable":true,"description":"Quando a sub-conta concluiu o cadastro e a análise começou; `null` enquanto ela ainda não enviou."},"volume30dCents":{"type":"integer","nullable":true,"description":"Vendas aprovadas da sub-conta nos últimos 30 dias, em centavos (só produção); `null` quando não foi possível ler."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","name":"Acme Ltda","planId":"rate_0a1b2c3d4e5f60718293","status":"string","createdAt":"string","approvedAt":"string","platformFee":{"type":"percentage","value":5000},"kycSubmittedAt":"string","volume30dCents":5000}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"getSubAccount"},"patch":{"tags":["Marketplace"],"summary":"Atualiza uma sub-conta (taxa da plataforma)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","status","platformFee","planId","createdAt","kycSubmittedAt","approvedAt","volume30dCents"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"name":{"type":"string","description":"Nome do vendedor."},"planId":{"type":"string","pattern":"^(rate)_.+$","nullable":true,"description":"O plano de taxas atribuído; `null` quando a sub-conta usa `platformFee` ou nenhum."},"status":{"type":"string","nullable":true,"description":"Status do cadastro: `pending`, `analyzing`, `awaiting-documents`, `active`, `disabled`…"},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o cadastro foi aprovado; `null` quando nunca."},"platformFee":{"type":"object","nullable":true,"required":["type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor em centavos, conforme `type`."}},"description":"A taxa da plataforma sobre as vendas da sub-conta; `null` quando não há (ou quando vale um plano de taxas).","additionalProperties":false},"kycSubmittedAt":{"type":"string","nullable":true,"description":"Quando a sub-conta concluiu o cadastro e a análise começou; `null` enquanto ela ainda não enviou."},"volume30dCents":{"type":"integer","nullable":true,"description":"Vendas aprovadas da sub-conta nos últimos 30 dias, em centavos (só produção); `null` quando não foi possível ler."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","name":"Acme Ltda","planId":"rate_0a1b2c3d4e5f60718293","status":"string","createdAt":"string","approvedAt":"string","platformFee":{"type":"percentage","value":5000},"kycSubmittedAt":"string","volume30dCents":5000}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"updateSubAccount","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"minLength":1,"description":"Nome do vendedor — só enquanto o cadastro dele não foi enviado."},"platformFee":{"type":"object","nullable":true,"required":["type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` (de cada venda) ou `flat` (centavos por venda)."},"value":{"type":"number","minimum":0,"description":"O percentual (0–100) ou o valor em centavos, conforme `type`.","exclusiveMinimum":true}},"description":"A taxa da plataforma; `null` limpa.","additionalProperties":false}},"additionalProperties":false},"example":{"name":"Acme Ltda","platformFee":{"type":"percentage","value":5000}}}},"required":true},"x-account-level":"always"}},"/v1/subscriptions/{subscriptionId}/items":{"get":{"tags":["Subscriptions"],"summary":"Lista os itens de uma assinatura","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"images":["string"],"enabled":true,"currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listSubscriptionItems"},"post":{"tags":["Subscriptions"],"summary":"Adiciona um item (de uma variante recorrente)","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"example":{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"images":["string"],"enabled":true,"currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"addSubscriptionItem","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["variantId"],"properties":{"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"quantity":{"type":"integer","default":1,"maximum":999999,"minimum":1,"description":"Quantidade."},"variantId":{"type":"string","pattern":"^(var|prv)_.+$","description":"Uma variante recorrente do seu catálogo — o preço vem dela."},"description":{"type":"string","maxLength":2048,"description":"A sua nota sobre o item."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador do item."}},"additionalProperties":false},"example":{"metadata":{},"quantity":1,"variantId":"var_0a1b2c3d4e5f60718293","description":"string","externalReference":"string"}}},"required":true}}},"/v1/subscriptions/{subscriptionId}/pause":{"post":{"tags":["Subscriptions"],"summary":"Pausa uma assinatura","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","currency","method","type","currentCycle","customer","billing","canceledAt","cancellation","discount","discounts","renewalTerms","shippable","shipping","spplited","splits","items","callback","geolocation","externalReference","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(subs|sub)_.+$","description":"Identificador público (subs_/sub_…)"},"type":{"type":"string","nullable":true,"description":"Tipo da assinatura (`recurring`)."},"items":{"type":"array","items":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"description":"Os itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"method":{"type":"string","nullable":true,"description":"Como os ciclos são cobrados: `credit`, `pix` ou `billet`."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"Splits de cada cobrança de ciclo; `null` quando não há."},"status":{"enum":["active","trialing","pending","paused","pastdue","unpaid","canceled"],"type":"string","description":"Status: `active`, `trialing`, `pending`, `paused`, `pastdue`, `unpaid` ou `canceled`."},"billing":{"type":"object","required":["frequency","frequencyCount","endDate","exactDay","freeTrialDays","autoRenew","address"],"properties":{"address":{"type":"object","required":["street","number","complement","district","city","state","country","postcode","line","fingerprint","line1","line2","line3"],"properties":{"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","nullable":true,"description":"Bairro."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."},"fingerprint":{"type":"string","nullable":true,"description":"Impressão digital do endereço (deduplicação)."}},"description":"O endereço do pagador (usado no boleto de cada ciclo). Todos os campos `null` quando não há.","additionalProperties":false},"endDate":{"type":"string","nullable":true,"description":"Quando a assinatura termina; `null` = nunca."},"exactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que é cobrada; `null` quando não é fixo."},"autoRenew":{"type":"boolean","description":"Se a assinatura se renova sozinha no fim de cada período (`false` depois de um cancelamento no fim do período)."},"frequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança: `daily`, `weekly`, `monthly` ou `yearly`."},"freeTrialDays":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"frequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo."}},"description":"Periodicidade da cobrança e endereço do pagador.","additionalProperties":false},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","description":"URL que recebe os webhooks desta assinatura."}},"description":"Webhook próprio; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"customer":{"type":"object","required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","additionalEmails","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do cliente (`cus_…`)."},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail."},"gender":{"type":"string","nullable":true,"description":"Gênero; `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento."},"number":{"type":"string","nullable":true,"description":"Número do documento."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do cliente."}},"description":"O comprador.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"number","description":"O desconto."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado; `null` quando não há.","additionalProperties":false},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shipping":{"type":"object","nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há.","additionalProperties":{}},"spplited":{"type":"boolean","description":"Se as cobranças dos ciclos são divididas com outras contas (ver `splits`). O nome mantém a grafia histórica."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a assinatura tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando a assinatura foi encerrada; `null` enquanto está viva."},"geolocation":{"type":"object","nullable":true,"description":"Sinais de dispositivo e localização do comprador, como enviados; `null` quando não há.","additionalProperties":{}},"cancellation":{"type":"object","nullable":true,"required":["reasonCode","reason","canceledBy"],"properties":{"reason":{"type":"string","nullable":true,"description":"O texto livre escrito por quem cancelou."},"canceledBy":{"enum":["seller","customer","platform"],"type":"string","nullable":true,"description":"`seller` (API ou painel), `customer` (portal) ou `platform` (régua de cobrança, chargeback, estorno)."},"reasonCode":{"enum":["price","not_using","technical_issue","switched_provider","other"],"type":"string","nullable":true,"description":"O motivo da lista; `null` nos cancelamentos antigos e nos da própria plataforma."}},"description":"Por que foi cancelada; `null` enquanto ninguém pediu o cancelamento.","additionalProperties":false},"currentCycle":{"type":"object","nullable":true,"required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"description":"O ciclo de cobrança atual; `null` quando não há.","additionalProperties":false},"pixAutomatic":{"type":"object","nullable":true,"required":["status","journey","qrCodeEmv","qrCodeUrl","valueCents","firstChargeDate","approvedAt","endReason"],"properties":{"status":{"enum":["pending","awaitingAuthorization","active","rejected","ended"],"type":"string","description":"`pending` (sendo criado) · `awaitingAuthorization` (QR code exibido) · `active` (debitado a cada ciclo) · `rejected` (o pagador recusou ou revogou) · `ended`. Depois de `rejected`/`ended` os ciclos são cobrados por um QR code cada."},"journey":{"enum":["paymentOnApproval","onlyRecurrency"],"type":"string","description":"`paymentOnApproval`: o primeiro ciclo é pago junto com a autorização; `onlyRecurrency`: só a recorrência é autorizada."},"endReason":{"type":"string","nullable":true,"description":"Por que terminou; `null` enquanto ativo."},"qrCodeEmv":{"type":"string","nullable":true,"description":"O QR code de autorização (copia e cola) — só enquanto `awaitingAuthorization`."},"qrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code de autorização — só enquanto `awaitingAuthorization`."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o pagador autorizou; `null` até lá."},"valueCents":{"type":"integer","description":"O valor fixo debitado a cada ciclo, em centavos."},"firstChargeDate":{"type":"string","description":"Data do primeiro débito."}},"description":"Só na leitura individual; `null` quando a assinatura não é paga por Pix Automático.","additionalProperties":false},"renewalTerms":{"type":"object","nullable":true,"required":["shipping","shippingAmount","methodDiscount","discountMethod","discountPercentage"],"properties":{"shipping":{"type":"boolean","description":"Se o frete é cobrado em cada renovação."},"discountMethod":{"enum":["credit","pix","billet"],"type":"string","nullable":true,"description":"O meio que concedeu o desconto no checkout; `null` quando nenhum."},"methodDiscount":{"type":"boolean","description":"Se o desconto do meio de pagamento vale nas renovações cobradas por `discountMethod`."},"shippingAmount":{"type":"integer","description":"O frete cotado no checkout, em centavos (0 = sem frete)."},"discountPercentage":{"type":"number","description":"O desconto desse meio, como percentual (ex.: 5 = 5%)."}},"description":"O que cada renovação cobra além dos itens, congelado na criação; `null` = nada congelado (as renovações cobram itens menos cupons).","additionalProperties":false},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da assinatura; `null` quando não há."}},"additionalProperties":false},"example":{"id":"subs_0a1b2c3d4e5f60718293","type":"string","items":[{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","images":["string"],"enabled":true,"currency":"BRL","metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}],"_links":{},"method":"string","splits":[{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"liable":true,"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}],"status":"active","billing":{"address":{"city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","number":"1000","street":"string","country":"string","district":"string","postcode":"string","complement":"string","fingerprint":"string"},"endDate":"string","exactDay":0,"autoRenew":true,"frequency":"string","freeTrialDays":0,"frequencyCount":0},"callback":{"active":true,"webhookUrl":"string"},"currency":"BRL","customer":{"id":"string","email":"buyer@example.com","gender":"string","document":{"type":"string","number":"12345678909"},"lastName":"Silva","metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"},"discount":{"type":"string","value":5000,"percentageOfAmount":5000},"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shipping":{},"spplited":true,"createdAt":"string","discounts":[],"shippable":true,"updatedAt":"string","canceledAt":"string","geolocation":{},"cancellation":{"reason":"string","canceledBy":"seller","reasonCode":"price"},"currentCycle":{"id":"scy_0a1b2c3d4e5f60718293","cycle":0,"status":"string","dueDate":"string","endDate":"string","billedAt":"string","createdAt":"string","startDate":"string","updatedAt":"string"},"pixAutomatic":{"status":"pending","journey":"paymentOnApproval","endReason":"string","qrCodeEmv":"string","qrCodeUrl":"string","approvedAt":"string","valueCents":5000,"firstChargeDate":"string"},"renewalTerms":{"shipping":true,"discountMethod":"credit","methodDiscount":true,"shippingAmount":5000,"discountPercentage":0},"externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"pauseSubscription"}},"/v1/subscriptions/{subscriptionId}/usage":{"get":{"tags":["Subscriptions"],"summary":"Lista os registros de uso medido","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","itemId","meterEventName","quantity","action","occurredAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(usg)_.+$","description":"Identificador público (usg_…)"},"action":{"type":"string","description":"`increment` ou `set`."},"itemId":{"type":"string","pattern":"^(sit|item)_.+$","nullable":true,"description":"O item em que o uso foi registrado."},"quantity":{"type":"integer","description":"O uso registrado."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"occurredAt":{"type":"string","description":"Quando o uso aconteceu."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor do item."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"usg_0a1b2c3d4e5f60718293","action":"string","itemId":"sit_0a1b2c3d4e5f60718293","quantity":0,"createdAt":"string","occurredAt":"string","meterEventName":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"required":false,"description":"Uso registrado neste dia."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Uso registrado depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Uso registrado a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Uso registrado antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Uso registrado até este instante (inclusivo)."},{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listSubscriptionUsage"}},"/v1/transactions/{transactionId}/capture":{"post":{"tags":["Transactions"],"summary":"Captura uma transação pré-autorizada","responses":{"202":{"content":{"application/json":{"schema":{"type":"object","required":["transactionId","status","accepted"],"properties":{"status":{"enum":["pending","pre-authorized","approved","failed","refused","canceled","refunded","chargeback","dispute","fraud-review","analyzing","awaiting"],"type":"string","description":"Status da cobrança depois de a ação ser aceita — o desfecho chega por webhook."},"accepted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a ação foi aceita."},"transactionId":{"type":"string","pattern":"^(tra|trx)_.+$","description":"Identificador público (tra_/trx_…)"}},"additionalProperties":false},"example":{"status":"pending","accepted":true,"transactionId":"tra_0a1b2c3d4e5f60718293"}}},"description":"Aceito"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string","pattern":"^(tra|trx)_.+$"},"required":true,"description":"Identificador público (tra_/trx_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"captureTransaction","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","minimum":1,"description":"Valor a capturar, em centavos. Omitido = o valor pré-autorizado."}},"additionalProperties":false},"example":{"amount":5000}}},"required":true}}},"/v1/transactions/{transactionId}/dispute":{"post":{"tags":["Transactions"],"summary":"Envia as provas de defesa de uma disputa","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","customId","amount","originalAmount","fees","net","status","method","currency","payment","discount","discounts","customer","billing","externalReference","shippable","spplited","items","receivables","splits","refunds","disputes","timeline","callback","utm","processingTimeMs","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(tra|trx)_.+$","description":"Identificador público (tra_/trx_…)"},"net":{"type":"integer","description":"O que você recebe: `amount − fees`, em centavos."},"utm":{"type":"object","nullable":true,"properties":{"term":{"type":"string","description":"`utm_term`."},"medium":{"type":"string","description":"`utm_medium`."},"source":{"type":"string","description":"`utm_source`."},"content":{"type":"string","description":"`utm_content`."},"campaign":{"type":"string","description":"`utm_campaign`."}},"description":"Atribuição de marketing da venda; `null` quando não há.","additionalProperties":false},"fees":{"type":"integer","description":"Total de taxas retidas, em centavos."},"items":{"type":"array","items":{"type":"object","required":["id","name","unitPrice","quantity","currency","description","images","isUpsell","isOrderbump","variantId","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(item|tri)_.+$","description":"Identificador público (item_/tri_…)"},"name":{"type":"string","description":"Nome do item."},"images":{"type":"array","items":{"type":"string"},"nullable":true,"description":"URLs das imagens do item; `null` quando não há."},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"isUpsell":{"type":"boolean","nullable":true,"description":"Se o item foi adicionado por uma oferta de upsell."},"metadata":{"nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há."},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário, em centavos."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"variantId":{"type":"string","nullable":true,"description":"A variante do catálogo; `null` num item avulso."},"description":{"type":"string","nullable":true,"description":"Descrição do item."},"isOrderbump":{"type":"boolean","nullable":true,"description":"Se o item foi adicionado por um order bump."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"nullable":true,"description":"Itens do carrinho; `null` quando a cobrança não teve itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","description":"Valor cobrado, em centavos (depois dos descontos)."},"method":{"enum":["credit","pix","billet","nupay"],"type":"string","description":"Meio de pagamento."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","receivable","amount","grossAmount","percentage","description","chargeProcessingFee","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do split."},"amount":{"type":"integer","description":"Fatia líquida, em centavos."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"percentage":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"A fatia como percentual, quando foi definida assim."},"receivable":{"type":"string","nullable":true,"description":"O recebível criado para a fatia."},"description":{"type":"string","nullable":true,"description":"Descrição."},"grossAmount":{"type":"integer","description":"Fatia bruta, em centavos."},"chargeProcessingFee":{"type":"boolean","nullable":true,"description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"As fatias desta cobrança destinadas a outras contas; `null` quando não há split."},"status":{"enum":["pending","pre-authorized","approved","failed","refused","canceled","refunded","chargeback","dispute","fraud-review","analyzing","awaiting"],"type":"string","description":"Status da cobrança. A criação é assíncrona: o desfecho chega por webhook."},"billing":{"type":"object","required":["address"],"properties":{"address":{"type":"object","required":["id","ownerId","ownerType","street","number","complement","district","city","state","postcode","country","latitude","longitude","line","line1","line2","line3","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do endereço; `null` quando o endereço não foi salvo."},"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"ownerId":{"type":"string","nullable":true,"description":"Id público do dono do endereço."},"district":{"type":"string","nullable":true,"description":"Bairro."},"latitude":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Latitude; `null` quando desconhecida."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"longitude":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Longitude; `null` quando desconhecida."},"ownerType":{"type":"string","nullable":true,"description":"Quem é dono do endereço (`customer`, `company`…)."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."}},"description":"O endereço do pagador.","additionalProperties":false}},"description":"Bloco de cobrança.","additionalProperties":false},"payment":{"type":"object","required":["provider","version","refused","reusable","billetUrl","billetBarcode","billetSequence","billetDocumentNumber","billetReferenceNumber","pixQrCodeEmv","pixQrCodeUrl","pixQrCodeImage","acquirerTransactionNumber","cardFirstDigits","cardLastDigits","cardBrand","cardRegistered","cardId","installments","expirationDate","paidAt","allowRenewPayment","invoiceLink","invoicePathLink"],"properties":{"cardId":{"type":"string","nullable":true,"description":"Id público (`card_…`) do cartão que esta cobrança usou, quando ficou salvo no cliente — o mesmo que `GET /v1/cards` lista. Use-o para cobrar renovações com `payment.card.id`. `null` sem cartão."},"paidAt":{"type":"string","nullable":true,"description":"Quando a cobrança foi paga; `null` até lá."},"refused":{"type":"object","nullable":true,"required":["code","type","category","message","displayMessage","reversible"],"properties":{"code":{"enum":["insufficientFundsError","expiredCardError","invalidCardNumber","invalidExpiryMonth","invalidExpiryYear","invalidSecurityCode","invalidPinCode","invalidPaymentInformation","cardDeclined","authorizationRefused","cardCustomerNotAssociated","invalidParameters","sellerAuthorizationRefused","paymentMethodUnavailable","pixAutomaticNotDebited","cardValidationUnavailable","paymentProcessingError"],"type":"string","description":"Código estável da recusa — o valor para tratar no seu sistema."},"type":{"enum":["cardError","invalidRequestError","processingError"],"type":"string","description":"Família do erro: `cardError`, `invalidRequestError` ou `processingError`."},"message":{"type":"string","description":"Mensagem técnica (em inglês)."},"category":{"enum":["payment","validation","businessRule","processing"],"type":"string","description":"`payment`, `validation`, `businessRule` ou `processing`."},"reversible":{"type":"boolean","description":"Se o comprador pode tentar de novo (ex.: com outro cartão)."},"displayMessage":{"type":"string","description":"Mensagem segura para mostrar ao comprador (pt-BR)."}},"description":"Por que a cobrança foi recusada; `null` quando não foi.","additionalProperties":false},"version":{"enum":["1.1"],"type":"string","description":"Versão do objeto de pagamento."},"provider":{"enum":["selectwin"],"type":"string","description":"Sempre `selectwin`."},"reusable":{"type":"boolean","description":"Se o pagamento pode ser reutilizado (hoje sempre `false`)."},"billetUrl":{"type":"string","nullable":true,"description":"URL do boleto (PDF); `null` nos outros meios e até ser emitido."},"cardBrand":{"type":"string","nullable":true,"description":"Bandeira do cartão."},"invoiceLink":{"type":"string","nullable":true,"description":"URL do comprovante hospedado desta cobrança (`pay.selectwin.io/r/…`). `null` na resposta da criação — preenchido na leitura e nos webhooks."},"installments":{"type":"integer","nullable":true,"description":"Número de parcelas."},"pixQrCodeEmv":{"type":"string","nullable":true,"description":"Código copia e cola do Pix (EMV); `null` até ser emitido."},"pixQrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code do Pix."},"billetBarcode":{"type":"string","nullable":true,"description":"Linha digitável do boleto."},"billetSequence":{"type":"string","nullable":true,"description":"Número sequencial do boleto."},"cardLastDigits":{"type":"string","nullable":true,"description":"Quatro últimos dígitos do cartão."},"cardRegistered":{"type":"boolean","description":"Se o cartão foi salvo no cliente."},"expirationDate":{"type":"string","nullable":true,"description":"Quando o Pix ou o boleto expira; `null` em cartão."},"pixQrCodeImage":{"type":"string","nullable":true,"description":"Imagem do QR code do Pix (base64); `null` quando não disponível."},"cardFirstDigits":{"type":"string","nullable":true,"description":"Seis primeiros dígitos do cartão; `null` nos outros meios."},"invoicePathLink":{"type":"string","nullable":true,"description":"O mesmo comprovante, como caminho (`/r/{env}/{token}`) para renderizar no seu próprio domínio. `null` exatamente quando `invoiceLink` é."},"nupayPaymentUrl":{"type":"string","nullable":true,"description":"NuPay: o link de aprovação no app do Nubank, para onde o comprador é enviado. `null` nos outros meios."},"allowRenewPayment":{"type":"boolean","description":"Se um novo Pix/boleto pode ser emitido para esta cobrança (`true` nesses meios)."},"billetDocumentNumber":{"type":"string","nullable":true,"description":"Número do documento do boleto."},"billetReferenceNumber":{"type":"string","nullable":true,"description":"Número de referência do boleto."},"acquirerTransactionNumber":{"type":"string","nullable":true,"description":"Número da cobrança no provedor de pagamento (NSU)."}},"description":"Como a cobrança é paga: o código Pix, o boleto, o cartão usado, a recusa.","additionalProperties":false},"refunds":{"type":"array","items":{"type":"object","required":["id","description","receiptId","amount","category","observations","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(void|trf|trr)_.+$","description":"Identificador público (void_/trf_/trr_…)"},"amount":{"type":"integer","description":"Valor estornado, em centavos."},"category":{"type":"string","nullable":true,"description":"Categoria do estorno (ver `GET /v1/utils/types-of-refund`)."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"receiptId":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Comprovante do estorno."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"Por que foi estornado."},"observations":{"type":"string","nullable":true,"description":"Observações."}},"additionalProperties":false},"nullable":true,"description":"Os estornos feitos nesta cobrança; `null` quando não há."},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","nullable":true,"description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","nullable":true,"description":"URL que recebe os webhooks desta cobrança."}},"description":"Webhook só desta cobrança; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"customId":{"type":"string","nullable":true,"description":"O seu id personalizado da cobrança: prefixo + base + sufixo, como configurado em `/v1/companies/configs`; `null` em cobranças antigas."},"customer":{"type":"object","nullable":true,"required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(cus)_.+$","description":"Identificador público (cus_…)"},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail; `null` quando não há."},"gender":{"type":"string","nullable":true,"description":"Gênero (`male`, `female`, `other`); `null` quando desconhecido."},"document":{"type":"object","required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento; `null` quando não há."},"number":{"type":"string","nullable":true,"description":"Número do documento (dígitos em CPF/CNPJ); `null` quando não há."}},"description":"Documento do comprador.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há."},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"nullable":true,"description":"Outros e-mails do comprador; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador deste cliente; `null` quando não há."}},"description":"O comprador; `null` quando não há.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"integer","description":"O desconto, em centavos."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado à cobrança; `null` quando não há.","additionalProperties":false},"disputes":{"type":"array","items":{"type":"object","required":["id","returnEmail","description","status","reason","reasonCode","reasonDescription","openedAt","closedAt","outcome","decidedAt","deadline","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id da disputa."},"reason":{"type":"string","nullable":true,"description":"Por que o comprador contestou."},"status":{"type":"string","nullable":true,"description":"Status da disputa."},"outcome":{"enum":["won","lost"],"type":"string","nullable":true,"description":"Como terminou: `won` (a cobrança volta a aprovada) ou `lost` (chargeback); `null` enquanto aberta."},"closedAt":{"type":"string","nullable":true,"description":"Quando foi encerrada; `null` enquanto aberta."},"deadline":{"type":"object","nullable":true,"required":["deadlineAt","hoursRemaining","expired","urgent"],"properties":{"urgent":{"type":"boolean","description":"Ainda defensável, mas perto do prazo."},"expired":{"type":"boolean","description":"A janela fechou: provas enviadas agora não são mais aceitas."},"deadlineAt":{"type":"string","nullable":true,"description":"Até quando as provas são aceitas."},"hoursRemaining":{"type":"number","nullable":true,"description":"Horas restantes para enviar as provas."}},"description":"O prazo das provas, derivado de `openedAt`; `null` quando a data de abertura é desconhecida.","additionalProperties":false},"openedAt":{"type":"string","nullable":true,"description":"Quando a disputa foi aberta."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"decidedAt":{"type":"string","nullable":true,"description":"Quando foi decidida; `null` enquanto aberta."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"reasonCode":{"type":"string","nullable":true,"description":"Código do motivo na bandeira."},"description":{"type":"string","nullable":true,"description":"O texto da sua defesa."},"returnEmail":{"type":"string","nullable":true,"description":"E-mail que recebe o desfecho."},"deliveryProof":{"nullable":true,"description":"Prova de entrega que você anexou; `null` quando não há."},"shipmentProof":{"nullable":true,"description":"Prova de envio que você anexou; `null` quando não há."},"fiscalDocuments":{"nullable":true,"description":"Documentos fiscais que você anexou; `null` quando não há."},"deliveryReceipts":{"nullable":true,"description":"Comprovantes de entrega que você anexou; `null` quando não há."},"reasonDescription":{"type":"string","nullable":true,"description":"Descrição do motivo."},"communicationProof":{"nullable":true,"description":"Prova de comunicação que você anexou; `null` quando não há."}},"additionalProperties":false},"nullable":true,"description":"As disputas desta cobrança; `null` quando não há."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há."},"shipping":{"nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há."},"spplited":{"type":"boolean","description":"Se a cobrança foi dividida com outras contas (ver `splits`). O nome mantém a grafia histórica."},"timeline":{"type":"array","items":{"type":"object","required":["id","message","details","type","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id da entrada."},"type":{"type":"string","nullable":true,"description":"Tipo da entrada."},"details":{"type":"string","nullable":true,"description":"Detalhes da entrada."},"message":{"type":"string","nullable":true,"description":"O que aconteceu."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"additionalProperties":false},"description":"Histórico da cobrança (mudanças de status e notas), do mais antigo ao mais novo."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a venda tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"receivables":{"type":"array","items":{"type":"object","required":["id","recipient","split","status","amount","grossAmount","anticipationFee","installmentNumber","description","currency","authorizationCode","paidAt","refundedAt","canceledAt","expectedOn","liable","chargeProcessingFee","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do recebível (`rec_…`)."},"split":{"type":"string","nullable":true,"description":"O split de que vem; `null` quando é seu."},"amount":{"type":"integer","description":"Valor líquido, em centavos."},"liable":{"type":"boolean","nullable":true,"description":"Se este recebedor arca com os chargebacks dele."},"paidAt":{"type":"string","nullable":true,"description":"Quando foi liberado ao recebedor; `null` até lá."},"status":{"type":"string","nullable":true,"description":"Status do recebível."},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que o recebe."},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando foi cancelado; `null` quando não foi."},"expectedOn":{"type":"string","nullable":true,"description":"Data prevista de liberação."},"refundedAt":{"type":"string","nullable":true,"description":"Quando foi estornado; `null` quando não foi."},"description":{"type":"string","nullable":true,"description":"Descrição."},"grossAmount":{"type":"integer","description":"Valor bruto, em centavos."},"anticipationFee":{"type":"integer","nullable":true,"description":"Taxa cobrada para antecipá-lo, em centavos; `null` quando não foi antecipado."},"authorizationCode":{"type":"string","nullable":true,"description":"Código de autorização da cobrança."},"installmentNumber":{"type":"integer","nullable":true,"description":"Número da parcela a que pertence."},"chargeProcessingFee":{"type":"boolean","nullable":true,"description":"Se este recebedor paga a taxa de processamento."}},"additionalProperties":false},"nullable":true,"description":"Os recebíveis desta cobrança, um por parcela e recebedor; `null` quando ainda não há."},"paymentGroup":{"type":"object","nullable":true,"required":["id","method","status","legIndex","legCount","isPrimary","totalAmount"],"properties":{"id":{"type":"string","description":"Id do pedido (o grupo de pagamento)."},"method":{"enum":["dualcredit","creditpix"],"type":"string","description":"`dualcredit` (dois cartões) ou `creditpix` (cartão + Pix)."},"status":{"enum":["authorizing","awaiting_retry","awaiting_pix","capturing","paid","compensating","failed","canceled","needs_review"],"type":"string","description":"Status do pedido inteiro — feche o pedido por ele, nunca por uma parte."},"legCount":{"type":"integer","description":"Número de partes do pedido."},"legIndex":{"type":"integer","description":"Posição desta parte no pedido (a partir de 0)."},"isPrimary":{"type":"boolean","description":"Se é a parte principal do pedido."},"totalAmount":{"type":"integer","description":"Total do pedido, em centavos."},"transactionIds":{"type":"array","items":{"type":"string"},"description":"A cobrança atual de cada parte do pedido, na ordem das partes (esta inclusa)."}},"description":"Pagamento combinado: esta cobrança é UMA PARTE de um pedido pago com dois cartões ou cartão + Pix. `null` = venda comum.","additionalProperties":false},"originalAmount":{"type":"integer","description":"Valor antes dos descontos, em centavos."},"processingTimeMs":{"type":"integer","nullable":true,"description":"Tempo da criação até o primeiro resultado do pagamento, em milissegundos; `null` até lá."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da cobrança; `null` quando não há."}},"additionalProperties":false},"example":{"id":"tra_0a1b2c3d4e5f60718293","net":0,"utm":{"term":"string","medium":"string","source":"string","content":"string","campaign":"string"},"fees":5000,"items":[{"id":"item_0a1b2c3d4e5f60718293","name":"Acme Ltda","images":["string"],"currency":"BRL","isUpsell":true,"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","variantId":"string","description":"string","isOrderbump":true,"externalReference":"string"}],"_links":{},"amount":5000,"method":"credit","splits":[{"id":"string","amount":5000,"createdAt":"string","recipient":"string","updatedAt":"string","percentage":"string","receivable":"string","description":"string","grossAmount":5000,"chargeProcessingFee":true}],"status":"pending","billing":{"address":{"id":"string","city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","number":"1000","street":"string","country":"string","ownerId":"string","district":"string","latitude":"string","postcode":"string","createdAt":"string","longitude":"string","ownerType":"string","updatedAt":"string","complement":"string"}},"payment":{"cardId":"string","paidAt":"string","refused":{"code":"insufficientFundsError","type":"cardError","message":"string","category":"payment","reversible":true,"displayMessage":"string"},"version":"1.1","provider":"selectwin","reusable":true,"billetUrl":"string","cardBrand":"string","invoiceLink":"string","installments":0,"pixQrCodeEmv":"string","pixQrCodeUrl":"string","billetBarcode":"string","billetSequence":"string","cardLastDigits":"string","cardRegistered":true,"expirationDate":"string","pixQrCodeImage":"string","cardFirstDigits":"string","invoicePathLink":"string","nupayPaymentUrl":"string","allowRenewPayment":true,"billetDocumentNumber":"string","billetReferenceNumber":"string","acquirerTransactionNumber":"string"},"refunds":[{"id":"void_0a1b2c3d4e5f60718293","amount":5000,"category":"string","createdAt":"string","receiptId":"string","updatedAt":"string","description":"string","observations":"string"}],"callback":{"active":true,"webhookUrl":"string"},"currency":"BRL","customId":"string","customer":{"id":"cus_0a1b2c3d4e5f60718293","email":"buyer@example.com","gender":"string","document":{"type":"string","number":"12345678909"},"lastName":"Silva","available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"externalReference":"string"},"discount":{"type":"string","value":5000,"percentageOfAmount":5000},"disputes":[{"id":"string","reason":"string","status":"string","outcome":"won","closedAt":"string","deadline":{"urgent":true,"expired":true,"deadlineAt":"string","hoursRemaining":0},"openedAt":"string","createdAt":"string","decidedAt":"string","updatedAt":"string","reasonCode":"string","description":"string","returnEmail":"string","reasonDescription":"string"}],"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"spplited":true,"timeline":[{"id":"string","type":"string","details":"string","message":"string","createdAt":"string","updatedAt":"string"}],"createdAt":"string","discounts":[],"shippable":true,"updatedAt":"string","receivables":[{"id":"string","split":"string","amount":5000,"liable":true,"paidAt":"string","status":"string","currency":"BRL","createdAt":"string","recipient":"string","updatedAt":"string","canceledAt":"string","expectedOn":"string","refundedAt":"string","description":"string","grossAmount":5000,"anticipationFee":5000,"authorizationCode":"string","installmentNumber":0,"chargeProcessingFee":true}],"paymentGroup":{"id":"string","method":"dualcredit","status":"authorizing","legCount":0,"legIndex":0,"isPrimary":true,"totalAmount":5000,"transactionIds":["string"]},"originalAmount":5000,"processingTimeMs":0,"externalReference":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"transactionId","schema":{"type":"string","pattern":"^(tra|trx)_.+$"},"required":true,"description":"Identificador público (tra_/trx_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"submitTransactionDispute","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["documents"],"properties":{"documents":{"type":"array","items":{"type":"object","required":["type"],"properties":{"type":{"enum":["deliveryProof","shipmentProof","deliveryReceipt","fiscalDocument","communicationProof"],"type":"string","description":"O que a prova é: `deliveryProof`, `shipmentProof`, `deliveryReceipt`, `fiscalDocument` ou `communicationProof`."},"assetId":{"type":"string","pattern":"^(asset|ass)_.+$","description":"Um arquivo que você enviou (`POST /v1/assets/uploads` e depois a confirmação) — ou mande `assetUrl`."},"carrier":{"type":"string","maxLength":100,"description":"Transportadora (só na prova de envio)."},"assetUrl":{"type":"string","format":"uri","description":"URL pública do documento — ou mande `assetId`."},"description":{"type":"string","maxLength":1000,"description":"O que o documento mostra."},"shippingDate":{"type":"string","maxLength":50,"description":"Data do envio (só na prova de envio)."},"trackingCode":{"type":"string","maxLength":100,"description":"Código de rastreio (só na prova de envio)."},"authentication":{"type":"object","properties":{"token":{"type":"string","maxLength":2000,"description":"Token de acesso."},"password":{"type":"string","maxLength":255,"description":"Senha."},"username":{"type":"string","maxLength":255,"description":"Nome de usuário."}},"description":"Credenciais necessárias para abrir a URL do documento, quando ela é protegida.","additionalProperties":false}},"additionalProperties":false},"maxItems":50,"minItems":1,"description":"As provas (1 a 50 documentos). Cada envio SUBSTITUI o conjunto anterior."},"description":{"type":"string","maxLength":2000,"description":"A sua defesa, em texto."},"returnEmail":{"type":"string","maxLength":255,"description":"E-mail que recebe o desfecho da disputa."}},"additionalProperties":false},"example":{"documents":[{"type":"deliveryProof","assetId":"asset_0a1b2c3d4e5f60718293","carrier":"string","assetUrl":"https://example.com","description":"string","shippingDate":"string","trackingCode":"string","authentication":{"token":"string","password":"string","username":"string"}}],"description":"string","returnEmail":"string"}}},"required":true}}},"/v1/checkouts/sessions/{sessionId}/events":{"get":{"tags":["Checkout"],"summary":"Lê o rastro bruto de interação de uma sessão (evento a evento)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["object","id","total","hasMore","data"],"properties":{"id":{"type":"string","pattern":"^(sess|ckts|ses)_.+$","description":"Identificador público (sess_/ckts_/ses_…)"},"data":{"type":"array","items":{"type":"object","required":["seq","type","step","payload","occurredAt","receivedAt"],"properties":{"seq":{"type":"integer","description":"Número de sequência do evento na sessão (o cursor de paginação)."},"step":{"type":"integer","nullable":true,"description":"Passo do funil em que o evento aconteceu; `null` quando não está ligado a um passo."},"type":{"type":"string","description":"Tipo do evento (ex.: `step.enter`, `field.error`, `payment.submit`)."},"payload":{"type":"object","nullable":true,"description":"Detalhes do evento — só forma e tempo, nunca o que o comprador digitou.","additionalProperties":{}},"occurredAt":{"type":"string","description":"Quando aconteceu (relógio do comprador)."},"receivedAt":{"type":"string","description":"Quando foi recebido (relógio do servidor)."}},"additionalProperties":false},"description":"Os eventos, em ordem de sequência."},"total":{"type":"integer","description":"Número total de eventos da sessão."},"object":{"enum":["list"],"type":"string","description":"Sempre `list`."},"hasMore":{"type":"boolean","description":"`true` quando há eventos depois do último devolvido (pagine com `afterSeq`)."}},"additionalProperties":false},"example":{"id":"sess_0a1b2c3d4e5f60718293","data":[{"seq":0,"step":0,"type":"string","payload":{},"occurredAt":"string","receivedAt":"string"}],"total":5000,"object":"list","hasMore":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":200,"maximum":500,"minimum":1},"required":false,"description":"Número máximo de eventos devolvidos."},{"in":"query","name":"afterSeq","schema":{"type":"integer","minimum":0},"required":false},{"in":"path","name":"sessionId","schema":{"type":"string","pattern":"^(sess|ckts|ses)_.+$"},"required":true,"description":"Identificador público (sess_/ckts_/ses_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listCheckoutSessionEvents"}},"/v1/subscriptions/{subscriptionId}/cancel":{"post":{"tags":["Subscriptions"],"summary":"Cancela uma assinatura","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","currency","method","type","currentCycle","customer","billing","canceledAt","cancellation","discount","discounts","renewalTerms","shippable","shipping","spplited","splits","items","callback","geolocation","externalReference","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(subs|sub)_.+$","description":"Identificador público (subs_/sub_…)"},"type":{"type":"string","nullable":true,"description":"Tipo da assinatura (`recurring`)."},"items":{"type":"array","items":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"description":"Os itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"method":{"type":"string","nullable":true,"description":"Como os ciclos são cobrados: `credit`, `pix` ou `billet`."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"Splits de cada cobrança de ciclo; `null` quando não há."},"status":{"enum":["active","trialing","pending","paused","pastdue","unpaid","canceled"],"type":"string","description":"Status: `active`, `trialing`, `pending`, `paused`, `pastdue`, `unpaid` ou `canceled`."},"billing":{"type":"object","required":["frequency","frequencyCount","endDate","exactDay","freeTrialDays","autoRenew","address"],"properties":{"address":{"type":"object","required":["street","number","complement","district","city","state","country","postcode","line","fingerprint","line1","line2","line3"],"properties":{"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","nullable":true,"description":"Bairro."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."},"fingerprint":{"type":"string","nullable":true,"description":"Impressão digital do endereço (deduplicação)."}},"description":"O endereço do pagador (usado no boleto de cada ciclo). Todos os campos `null` quando não há.","additionalProperties":false},"endDate":{"type":"string","nullable":true,"description":"Quando a assinatura termina; `null` = nunca."},"exactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que é cobrada; `null` quando não é fixo."},"autoRenew":{"type":"boolean","description":"Se a assinatura se renova sozinha no fim de cada período (`false` depois de um cancelamento no fim do período)."},"frequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança: `daily`, `weekly`, `monthly` ou `yearly`."},"freeTrialDays":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"frequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo."}},"description":"Periodicidade da cobrança e endereço do pagador.","additionalProperties":false},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","description":"URL que recebe os webhooks desta assinatura."}},"description":"Webhook próprio; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"customer":{"type":"object","required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","additionalEmails","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do cliente (`cus_…`)."},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail."},"gender":{"type":"string","nullable":true,"description":"Gênero; `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento."},"number":{"type":"string","nullable":true,"description":"Número do documento."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do cliente."}},"description":"O comprador.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"number","description":"O desconto."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado; `null` quando não há.","additionalProperties":false},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shipping":{"type":"object","nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há.","additionalProperties":{}},"spplited":{"type":"boolean","description":"Se as cobranças dos ciclos são divididas com outras contas (ver `splits`). O nome mantém a grafia histórica."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a assinatura tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando a assinatura foi encerrada; `null` enquanto está viva."},"geolocation":{"type":"object","nullable":true,"description":"Sinais de dispositivo e localização do comprador, como enviados; `null` quando não há.","additionalProperties":{}},"cancellation":{"type":"object","nullable":true,"required":["reasonCode","reason","canceledBy"],"properties":{"reason":{"type":"string","nullable":true,"description":"O texto livre escrito por quem cancelou."},"canceledBy":{"enum":["seller","customer","platform"],"type":"string","nullable":true,"description":"`seller` (API ou painel), `customer` (portal) ou `platform` (régua de cobrança, chargeback, estorno)."},"reasonCode":{"enum":["price","not_using","technical_issue","switched_provider","other"],"type":"string","nullable":true,"description":"O motivo da lista; `null` nos cancelamentos antigos e nos da própria plataforma."}},"description":"Por que foi cancelada; `null` enquanto ninguém pediu o cancelamento.","additionalProperties":false},"currentCycle":{"type":"object","nullable":true,"required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"description":"O ciclo de cobrança atual; `null` quando não há.","additionalProperties":false},"pixAutomatic":{"type":"object","nullable":true,"required":["status","journey","qrCodeEmv","qrCodeUrl","valueCents","firstChargeDate","approvedAt","endReason"],"properties":{"status":{"enum":["pending","awaitingAuthorization","active","rejected","ended"],"type":"string","description":"`pending` (sendo criado) · `awaitingAuthorization` (QR code exibido) · `active` (debitado a cada ciclo) · `rejected` (o pagador recusou ou revogou) · `ended`. Depois de `rejected`/`ended` os ciclos são cobrados por um QR code cada."},"journey":{"enum":["paymentOnApproval","onlyRecurrency"],"type":"string","description":"`paymentOnApproval`: o primeiro ciclo é pago junto com a autorização; `onlyRecurrency`: só a recorrência é autorizada."},"endReason":{"type":"string","nullable":true,"description":"Por que terminou; `null` enquanto ativo."},"qrCodeEmv":{"type":"string","nullable":true,"description":"O QR code de autorização (copia e cola) — só enquanto `awaitingAuthorization`."},"qrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code de autorização — só enquanto `awaitingAuthorization`."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o pagador autorizou; `null` até lá."},"valueCents":{"type":"integer","description":"O valor fixo debitado a cada ciclo, em centavos."},"firstChargeDate":{"type":"string","description":"Data do primeiro débito."}},"description":"Só na leitura individual; `null` quando a assinatura não é paga por Pix Automático.","additionalProperties":false},"renewalTerms":{"type":"object","nullable":true,"required":["shipping","shippingAmount","methodDiscount","discountMethod","discountPercentage"],"properties":{"shipping":{"type":"boolean","description":"Se o frete é cobrado em cada renovação."},"discountMethod":{"enum":["credit","pix","billet"],"type":"string","nullable":true,"description":"O meio que concedeu o desconto no checkout; `null` quando nenhum."},"methodDiscount":{"type":"boolean","description":"Se o desconto do meio de pagamento vale nas renovações cobradas por `discountMethod`."},"shippingAmount":{"type":"integer","description":"O frete cotado no checkout, em centavos (0 = sem frete)."},"discountPercentage":{"type":"number","description":"O desconto desse meio, como percentual (ex.: 5 = 5%)."}},"description":"O que cada renovação cobra além dos itens, congelado na criação; `null` = nada congelado (as renovações cobram itens menos cupons).","additionalProperties":false},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da assinatura; `null` quando não há."}},"additionalProperties":false},"example":{"id":"subs_0a1b2c3d4e5f60718293","type":"string","items":[{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","images":["string"],"enabled":true,"currency":"BRL","metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}],"_links":{},"method":"string","splits":[{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"liable":true,"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}],"status":"active","billing":{"address":{"city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","number":"1000","street":"string","country":"string","district":"string","postcode":"string","complement":"string","fingerprint":"string"},"endDate":"string","exactDay":0,"autoRenew":true,"frequency":"string","freeTrialDays":0,"frequencyCount":0},"callback":{"active":true,"webhookUrl":"string"},"currency":"BRL","customer":{"id":"string","email":"buyer@example.com","gender":"string","document":{"type":"string","number":"12345678909"},"lastName":"Silva","metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"},"discount":{"type":"string","value":5000,"percentageOfAmount":5000},"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shipping":{},"spplited":true,"createdAt":"string","discounts":[],"shippable":true,"updatedAt":"string","canceledAt":"string","geolocation":{},"cancellation":{"reason":"string","canceledBy":"seller","reasonCode":"price"},"currentCycle":{"id":"scy_0a1b2c3d4e5f60718293","cycle":0,"status":"string","dueDate":"string","endDate":"string","billedAt":"string","createdAt":"string","startDate":"string","updatedAt":"string"},"pixAutomatic":{"status":"pending","journey":"paymentOnApproval","endReason":"string","qrCodeEmv":"string","qrCodeUrl":"string","approvedAt":"string","valueCents":5000,"firstChargeDate":"string"},"renewalTerms":{"shipping":true,"discountMethod":"credit","methodDiscount":true,"shippingAmount":5000,"discountPercentage":0},"externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"cancelSubscription","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","maxLength":255,"description":"Por quê, nas suas palavras (complemento opcional)."},"reasonCode":{"enum":["price","not_using","technical_issue","switched_provider","other"],"type":"string","description":"Por quê, da lista: `price`, `not_using`, `technical_issue`, `switched_provider` ou `other`."},"immediately":{"type":"boolean","description":"`true` cancela agora; `false` (padrão) no fim do período atual."}},"additionalProperties":false},"example":{"reason":"string","reasonCode":"price","immediately":true}}},"required":true}}},"/v1/subscriptions/{subscriptionId}/cycles":{"get":{"tags":["Subscriptions"],"summary":"Lista os ciclos de cobrança de uma assinatura","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt","amount","transactionId","method","expectedAmount","attempts","nextAttemptAt","failure"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","nullable":true,"description":"Valor da última cobrança ligada ao ciclo, em centavos; `null` quando não há."},"method":{"type":"string","nullable":true,"description":"Meio de pagamento dessa cobrança; `null` quando não há."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"failure":{"type":"object","nullable":true,"required":["stage","code","message","at"],"properties":{"at":{"type":"string","nullable":true,"description":"Quando falhou."},"code":{"type":"string","nullable":true,"description":"Código estável da falha (`noCard`, `noBillingAddress`, `unpriceableItems`, ou o código de recusa da cobrança)."},"stage":{"enum":["beforeCharge","charge"],"type":"string","description":"`beforeCharge`: a cobrança nunca foi tentada (sem cartão, boleto sem endereço, item sem preço); `charge`: o pagamento foi recusado."},"message":{"type":"string","nullable":true,"description":"A mensagem da recusa, quando a cobrança foi tentada."}},"description":"Por que o ciclo falhou; `null` quando não falhou, ou quando o motivo não foi registrado.","additionalProperties":false},"attempts":{"type":"integer","description":"Tentativas de cobrança até agora (o limite de retentativas é 5)."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"nextAttemptAt":{"type":"string","nullable":true,"description":"Quando um ciclo falho é tentado de novo; `null` quando não será."},"transactionId":{"type":"string","nullable":true,"description":"A última cobrança ligada ao ciclo; `null` quando não há."},"expectedAmount":{"type":"integer","nullable":true,"description":"No ciclo em aberto: o que ele cobraria agora, em centavos; `null` nos outros, ou quando ainda não dá para saber."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"scy_0a1b2c3d4e5f60718293","cycle":0,"_links":{},"amount":5000,"method":"string","status":"string","dueDate":"string","endDate":"string","failure":{"at":"string","code":"string","stage":"beforeCharge","message":"string"},"attempts":0,"billedAt":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","startDate":"string","updatedAt":"string","nextAttemptAt":"string","transactionId":"string","expectedAmount":5000}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"query","name":"daterange","schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},{"type":"string","format":"date-time","description":"Instante em ISO 8601 (UTC)."}]},"required":false,"description":"Criados neste dia (`YYYY-MM-DD`) ou neste instante."},{"in":"query","name":"daterangegt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados depois deste instante (exclusivo)."},{"in":"query","name":"daterangegte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados a partir deste instante (inclusivo)."},{"in":"query","name":"daterangelt","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados antes deste instante (exclusivo)."},{"in":"query","name":"daterangelte","schema":{"type":"string","format":"date-time"},"required":false,"description":"Criados até este instante (inclusivo)."},{"in":"query","name":"status","schema":{"enum":["scheduled","processing","paid","failed","canceled"],"type":"string"},"required":false,"description":"Só ciclos com este status."},{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listSubscriptionCycles"},"post":{"tags":["Subscriptions"],"summary":"Renova uma assinatura (agenda o próximo ciclo)","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt","amount","transactionId","method","expectedAmount","attempts","nextAttemptAt","failure"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","nullable":true,"description":"Valor da última cobrança ligada ao ciclo, em centavos; `null` quando não há."},"method":{"type":"string","nullable":true,"description":"Meio de pagamento dessa cobrança; `null` quando não há."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"failure":{"type":"object","nullable":true,"required":["stage","code","message","at"],"properties":{"at":{"type":"string","nullable":true,"description":"Quando falhou."},"code":{"type":"string","nullable":true,"description":"Código estável da falha (`noCard`, `noBillingAddress`, `unpriceableItems`, ou o código de recusa da cobrança)."},"stage":{"enum":["beforeCharge","charge"],"type":"string","description":"`beforeCharge`: a cobrança nunca foi tentada (sem cartão, boleto sem endereço, item sem preço); `charge`: o pagamento foi recusado."},"message":{"type":"string","nullable":true,"description":"A mensagem da recusa, quando a cobrança foi tentada."}},"description":"Por que o ciclo falhou; `null` quando não falhou, ou quando o motivo não foi registrado.","additionalProperties":false},"attempts":{"type":"integer","description":"Tentativas de cobrança até agora (o limite de retentativas é 5)."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"nextAttemptAt":{"type":"string","nullable":true,"description":"Quando um ciclo falho é tentado de novo; `null` quando não será."},"transactionId":{"type":"string","nullable":true,"description":"A última cobrança ligada ao ciclo; `null` quando não há."},"expectedAmount":{"type":"integer","nullable":true,"description":"No ciclo em aberto: o que ele cobraria agora, em centavos; `null` nos outros, ou quando ainda não dá para saber."}},"additionalProperties":false},"example":{"id":"scy_0a1b2c3d4e5f60718293","cycle":0,"_links":{},"amount":5000,"method":"string","status":"string","dueDate":"string","endDate":"string","failure":{"at":"string","code":"string","stage":"beforeCharge","message":"string"},"attempts":0,"billedAt":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","startDate":"string","updatedAt":"string","nextAttemptAt":"string","transactionId":"string","expectedAmount":5000}}},"description":"Criado"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"renewSubscriptionCycle"}},"/v1/subscriptions/{subscriptionId}/resume":{"post":{"tags":["Subscriptions"],"summary":"Retoma uma assinatura pausada","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","currency","method","type","currentCycle","customer","billing","canceledAt","cancellation","discount","discounts","renewalTerms","shippable","shipping","spplited","splits","items","callback","geolocation","externalReference","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(subs|sub)_.+$","description":"Identificador público (subs_/sub_…)"},"type":{"type":"string","nullable":true,"description":"Tipo da assinatura (`recurring`)."},"items":{"type":"array","items":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"description":"Os itens."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"method":{"type":"string","nullable":true,"description":"Como os ciclos são cobrados: `credit`, `pix` ou `billet`."},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"nullable":true,"description":"Splits de cada cobrança de ciclo; `null` quando não há."},"status":{"enum":["active","trialing","pending","paused","pastdue","unpaid","canceled"],"type":"string","description":"Status: `active`, `trialing`, `pending`, `paused`, `pastdue`, `unpaid` ou `canceled`."},"billing":{"type":"object","required":["frequency","frequencyCount","endDate","exactDay","freeTrialDays","autoRenew","address"],"properties":{"address":{"type":"object","required":["street","number","complement","district","city","state","country","postcode","line","fingerprint","line1","line2","line3"],"properties":{"city":{"type":"string","nullable":true,"description":"Cidade."},"line":{"type":"string","nullable":true,"description":"O endereço inteiro numa linha."},"line1":{"type":"string","nullable":true,"description":"Primeira linha: logradouro e número."},"line2":{"type":"string","nullable":true,"description":"Segunda linha: bairro."},"line3":{"type":"string","nullable":true,"description":"Terceira linha: cidade, estado e CEP."},"state":{"type":"string","nullable":true,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","nullable":true,"description":"Número."},"street":{"type":"string","nullable":true,"description":"Logradouro."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","nullable":true,"description":"Bairro."},"postcode":{"type":"string","nullable":true,"description":"CEP, só dígitos."},"complement":{"type":"string","nullable":true,"description":"Complemento (apartamento, sala, bloco…)."},"fingerprint":{"type":"string","nullable":true,"description":"Impressão digital do endereço (deduplicação)."}},"description":"O endereço do pagador (usado no boleto de cada ciclo). Todos os campos `null` quando não há.","additionalProperties":false},"endDate":{"type":"string","nullable":true,"description":"Quando a assinatura termina; `null` = nunca."},"exactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que é cobrada; `null` quando não é fixo."},"autoRenew":{"type":"boolean","description":"Se a assinatura se renova sozinha no fim de cada período (`false` depois de um cancelamento no fim do período)."},"frequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança: `daily`, `weekly`, `monthly` ou `yearly`."},"freeTrialDays":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"frequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo."}},"description":"Periodicidade da cobrança e endereço do pagador.","additionalProperties":false},"callback":{"type":"object","nullable":true,"required":["webhookUrl","active"],"properties":{"active":{"type":"boolean","description":"Se o webhook próprio está ativo."},"webhookUrl":{"type":"string","description":"URL que recebe os webhooks desta assinatura."}},"description":"Webhook próprio; `null` quando não há.","additionalProperties":false},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"customer":{"type":"object","required":["id","firstName","lastName","email","birthdate","gender","document","telephone","available","delinquent","externalReference","additionalEmails","metadata","updatedAt","createdAt"],"properties":{"id":{"type":"string","nullable":true,"description":"Id do cliente (`cus_…`)."},"email":{"type":"string","nullable":true,"description":"Endereço de e-mail."},"gender":{"type":"string","nullable":true,"description":"Gênero; `null` quando desconhecido."},"document":{"type":"object","nullable":true,"required":["type","number"],"properties":{"type":{"type":"string","nullable":true,"description":"Tipo do documento."},"number":{"type":"string","nullable":true,"description":"Número do documento."}},"description":"Documento do comprador; `null` quando não há.","additionalProperties":false},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"available":{"type":"boolean","nullable":true,"description":"Se o cliente está ativo e pode ser cobrado."},"birthdate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando desconhecida."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"firstName":{"type":"string","nullable":true,"description":"Nome."},"telephone":{"type":"object","nullable":true,"required":["countryCode","areaCode","number","line"],"properties":{"line":{"type":"string","nullable":true,"description":"O número inteiro com código do país e DDD."},"number":{"type":"string","nullable":true,"description":"Número local."},"areaCode":{"type":"string","nullable":true,"description":"DDD."},"countryCode":{"type":"string","nullable":true,"description":"Código do país."}},"description":"Telefone do comprador, em partes; `null` quando não há.","additionalProperties":false},"updatedAt":{"type":"string","nullable":true,"description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"delinquent":{"type":"boolean","nullable":true,"description":"Se o cliente tem pagamentos em atraso."},"additionalEmails":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Outros e-mails; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do cliente."}},"description":"O comprador.","additionalProperties":false},"discount":{"type":"object","nullable":true,"required":["value","type","percentageOfAmount"],"properties":{"type":{"type":"string","description":"`flat` ou `percentage`."},"value":{"type":"number","description":"O desconto."},"percentageOfAmount":{"type":"number","nullable":true,"description":"O desconto como percentual do valor."}},"description":"Desconto aplicado; `null` quando não há.","additionalProperties":false},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"shipping":{"type":"object","nullable":true,"description":"Retrato do frete, como enviado; `null` quando não há.","additionalProperties":{}},"spplited":{"type":"boolean","description":"Se as cobranças dos ciclos são divididas com outras contas (ver `splits`). O nome mantém a grafia histórica."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Os cupons aplicados; `null` quando não há."},"shippable":{"type":"boolean","description":"Se a assinatura tem itens físicos para enviar."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"canceledAt":{"type":"string","nullable":true,"description":"Quando a assinatura foi encerrada; `null` enquanto está viva."},"geolocation":{"type":"object","nullable":true,"description":"Sinais de dispositivo e localização do comprador, como enviados; `null` quando não há.","additionalProperties":{}},"cancellation":{"type":"object","nullable":true,"required":["reasonCode","reason","canceledBy"],"properties":{"reason":{"type":"string","nullable":true,"description":"O texto livre escrito por quem cancelou."},"canceledBy":{"enum":["seller","customer","platform"],"type":"string","nullable":true,"description":"`seller` (API ou painel), `customer` (portal) ou `platform` (régua de cobrança, chargeback, estorno)."},"reasonCode":{"enum":["price","not_using","technical_issue","switched_provider","other"],"type":"string","nullable":true,"description":"O motivo da lista; `null` nos cancelamentos antigos e nos da própria plataforma."}},"description":"Por que foi cancelada; `null` enquanto ninguém pediu o cancelamento.","additionalProperties":false},"currentCycle":{"type":"object","nullable":true,"required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"description":"O ciclo de cobrança atual; `null` quando não há.","additionalProperties":false},"pixAutomatic":{"type":"object","nullable":true,"required":["status","journey","qrCodeEmv","qrCodeUrl","valueCents","firstChargeDate","approvedAt","endReason"],"properties":{"status":{"enum":["pending","awaitingAuthorization","active","rejected","ended"],"type":"string","description":"`pending` (sendo criado) · `awaitingAuthorization` (QR code exibido) · `active` (debitado a cada ciclo) · `rejected` (o pagador recusou ou revogou) · `ended`. Depois de `rejected`/`ended` os ciclos são cobrados por um QR code cada."},"journey":{"enum":["paymentOnApproval","onlyRecurrency"],"type":"string","description":"`paymentOnApproval`: o primeiro ciclo é pago junto com a autorização; `onlyRecurrency`: só a recorrência é autorizada."},"endReason":{"type":"string","nullable":true,"description":"Por que terminou; `null` enquanto ativo."},"qrCodeEmv":{"type":"string","nullable":true,"description":"O QR code de autorização (copia e cola) — só enquanto `awaitingAuthorization`."},"qrCodeUrl":{"type":"string","nullable":true,"description":"URL da imagem do QR code de autorização — só enquanto `awaitingAuthorization`."},"approvedAt":{"type":"string","nullable":true,"description":"Quando o pagador autorizou; `null` até lá."},"valueCents":{"type":"integer","description":"O valor fixo debitado a cada ciclo, em centavos."},"firstChargeDate":{"type":"string","description":"Data do primeiro débito."}},"description":"Só na leitura individual; `null` quando a assinatura não é paga por Pix Automático.","additionalProperties":false},"renewalTerms":{"type":"object","nullable":true,"required":["shipping","shippingAmount","methodDiscount","discountMethod","discountPercentage"],"properties":{"shipping":{"type":"boolean","description":"Se o frete é cobrado em cada renovação."},"discountMethod":{"enum":["credit","pix","billet"],"type":"string","nullable":true,"description":"O meio que concedeu o desconto no checkout; `null` quando nenhum."},"methodDiscount":{"type":"boolean","description":"Se o desconto do meio de pagamento vale nas renovações cobradas por `discountMethod`."},"shippingAmount":{"type":"integer","description":"O frete cotado no checkout, em centavos (0 = sem frete)."},"discountPercentage":{"type":"number","description":"O desconto desse meio, como percentual (ex.: 5 = 5%)."}},"description":"O que cada renovação cobra além dos itens, congelado na criação; `null` = nada congelado (as renovações cobram itens menos cupons).","additionalProperties":false},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da assinatura; `null` quando não há."}},"additionalProperties":false},"example":{"id":"subs_0a1b2c3d4e5f60718293","type":"string","items":[{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","images":["string"],"enabled":true,"currency":"BRL","metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}],"_links":{},"method":"string","splits":[{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"liable":true,"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}],"status":"active","billing":{"address":{"city":"string","line":"string","line1":"string","line2":"string","line3":"string","state":"string","number":"1000","street":"string","country":"string","district":"string","postcode":"string","complement":"string","fingerprint":"string"},"endDate":"string","exactDay":0,"autoRenew":true,"frequency":"string","freeTrialDays":0,"frequencyCount":0},"callback":{"active":true,"webhookUrl":"string"},"currency":"BRL","customer":{"id":"string","email":"buyer@example.com","gender":"string","document":{"type":"string","number":"12345678909"},"lastName":"Silva","metadata":{},"available":true,"birthdate":"1990-05-20","createdAt":"string","firstName":"João","telephone":{"line":"5511987654321","number":"987654321","areaCode":"11","countryCode":"55"},"updatedAt":"string","delinquent":true,"additionalEmails":["string"],"externalReference":"string"},"discount":{"type":"string","value":5000,"percentageOfAmount":5000},"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"shipping":{},"spplited":true,"createdAt":"string","discounts":[],"shippable":true,"updatedAt":"string","canceledAt":"string","geolocation":{},"cancellation":{"reason":"string","canceledBy":"seller","reasonCode":"price"},"currentCycle":{"id":"scy_0a1b2c3d4e5f60718293","cycle":0,"status":"string","dueDate":"string","endDate":"string","billedAt":"string","createdAt":"string","startDate":"string","updatedAt":"string"},"pixAutomatic":{"status":"pending","journey":"paymentOnApproval","endReason":"string","qrCodeEmv":"string","qrCodeUrl":"string","approvedAt":"string","valueCents":5000,"firstChargeDate":"string"},"renewalTerms":{"shipping":true,"discountMethod":"credit","methodDiscount":true,"shippingAmount":5000,"discountPercentage":0},"externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"resumeSubscription"}},"/v1/subscriptions/{subscriptionId}/splits":{"get":{"tags":["Subscriptions"],"summary":"Lista os splits de uma assinatura","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"_links":{},"liable":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listSubscriptionSplits"},"post":{"tags":["Subscriptions"],"summary":"Adiciona um split (empresa recebedora)","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["subscription","splits","totalPercentage","remainingPercentage","remainingAmount"],"properties":{"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"description":"Todos os splits da assinatura depois da mudança."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"subscription":{"type":"string","pattern":"^(subs|sub)_.+$","description":"A assinatura."},"remainingAmount":{"type":"string","description":"O que sobra do valor recorrente depois das fatias fixas, em centavos (como texto)."},"totalPercentage":{"type":"number","description":"Soma das fatias percentuais."},"remainingPercentage":{"type":"number","description":"O que sobra de 100% depois das fatias percentuais."}},"additionalProperties":false},"example":{"_links":{},"splits":[{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"_links":{},"liable":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}],"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"subscription":"subs_0a1b2c3d4e5f60718293","remainingAmount":"string","totalPercentage":5000,"remainingPercentage":0}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"addSubscriptionSplit","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["recipient","type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","maximum":999999.99,"minimum":0,"description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"recipient":{"type":"string","pattern":"^.+_.+$","description":"A conta que recebe a fatia (`bus_…`)."}},"additionalProperties":false},"example":{"type":"percentage","value":5000,"recipient":"id_0a1b2c3d4e5f60718293"}}},"required":true}}},"/v1/marketplace/kyc/{token}/assets/uploads":{"post":{"tags":["Marketplace"],"summary":"Pede um upload pré-assinado de documento pelo link de credenciamento","security":[],"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","key","upload"],"properties":{"id":{"type":"string","pattern":"^(asset|ass)_.+$","description":"Identificador público (asset_/ass_…)"},"key":{"type":"string","description":"Chave do arquivo no armazenamento."},"status":{"enum":["pending"],"type":"string","description":"Sempre `pending`: os bytes ainda não foram enviados."},"upload":{"type":"object","required":["url","method","headers","expiresInSeconds"],"properties":{"url":{"type":"string","description":"URL pré-assinada para onde fazer o `PUT` dos bytes."},"method":{"enum":["PUT"],"type":"string","description":"Sempre `PUT`."},"headers":{"type":"object","required":["Content-Type"],"properties":{"Content-Type":{"type":"string","description":"O tipo MIME que o envio precisa declarar (o `contentType` enviado)."}},"description":"Cabeçalhos que o `PUT` precisa levar.","additionalProperties":false},"expiresInSeconds":{"type":"integer","description":"Por quanto tempo a URL vale, em segundos."}},"description":"Como enviar o arquivo: um `PUT` dos bytes para `url`, com estes cabeçalhos, antes de expirar; depois confirme o envio.","additionalProperties":false}},"additionalProperties":false},"example":{"id":"asset_0a1b2c3d4e5f60718293","key":"string","status":"pending","upload":{"url":"string","method":"PUT","headers":{"Content-Type":"string"},"expiresInSeconds":0}}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"413":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false}}},"description":"Corpo grande demais"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"429":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Limite de requisições excedido"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"},"503":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false}}},"description":"Serviço indisponível"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"createKycDocumentUpload","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["filename","contentType"],"properties":{"byteSize":{"type":"integer","minimum":1,"description":"Tamanho do arquivo, em bytes. Quando enviado, fica amarrado à URL de envio, e o envio não pode passar dele."},"filename":{"type":"string","maxLength":255,"minLength":1,"description":"Nome do arquivo, com extensão."},"contentType":{"enum":["image/png","image/jpeg","image/webp","image/gif","application/pdf"],"type":"string","description":"Tipo MIME do arquivo: `image/png`, `image/jpeg`, `image/webp`, `image/gif` ou `application/pdf`."}},"additionalProperties":false},"example":{"byteSize":1,"filename":"string","contentType":"image/png"}}},"required":true}}},"/v1/checkouts/payment-links/{paymentLinkId}":{"get":{"tags":["Checkout"],"summary":"Consulta um link de pagamento","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","type","enabled","accessId","signature","accessFullUrl","sessionId","editable","items","discounts","customInputs","expiresAt","availableAt","templateId","integrationId","domainId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(link)_.+$","description":"Identificador público (link_…)"},"name":{"type":"string","description":"Nome do link."},"type":{"type":"string","nullable":true,"description":"Tipo do link (histórico; sempre o tipo persistido)."},"items":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"O carrinho fixo do link."},"enabled":{"type":"boolean","description":"Se o link abre."},"accessId":{"type":"string","description":"O id público de acesso na URL."},"domainId":{"type":"string","nullable":true,"description":"O host em que a URL é montada; `null` = a escolha automática."},"editable":{"type":"boolean","description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Códigos de cupom aplicados quando o link abre; `null` quando não há."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o link deixa de abrir; `null` = nunca."},"sessionId":{"type":"string","nullable":true,"description":"A sessão de checkout ligada ao link, quando há."},"signature":{"type":"string","description":"A assinatura da URL."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"templateId":{"type":"string","nullable":true,"description":"O template de checkout; `null` = o checkout padrão."},"availableAt":{"type":"string","nullable":true,"description":"Quando o link passa a abrir; `null` = já abre."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"nullable":true,"description":"Campos extras que o checkout pede ao comprador; `null` quando não há."},"accessFullUrl":{"type":"string","nullable":true,"description":"A URL para compartilhar com os compradores."},"integrationId":{"type":"string","nullable":true,"description":"A integração a que uma venda pelo link pertence; `null` quando não há."}},"additionalProperties":false},"example":{"id":"link_0a1b2c3d4e5f60718293","name":"Acme Ltda","type":"string","items":[{}],"enabled":true,"accessId":"string","domainId":"string","editable":true,"metadata":{},"createdAt":"string","discounts":[],"expiresAt":"string","sessionId":"string","signature":"string","updatedAt":"string","templateId":"string","availableAt":"string","customInputs":[{}],"accessFullUrl":"string","integrationId":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"paymentLinkId","schema":{"type":"string","pattern":"^(link)_.+$"},"required":true,"description":"Identificador público (link_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getCheckoutPaymentLink"},"put":{"tags":["Checkout"],"summary":"Atualiza um link de pagamento","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","type","enabled","accessId","signature","accessFullUrl","sessionId","editable","items","discounts","customInputs","expiresAt","availableAt","templateId","integrationId","domainId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(link)_.+$","description":"Identificador público (link_…)"},"name":{"type":"string","description":"Nome do link."},"type":{"type":"string","nullable":true,"description":"Tipo do link (histórico; sempre o tipo persistido)."},"items":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"O carrinho fixo do link."},"enabled":{"type":"boolean","description":"Se o link abre."},"accessId":{"type":"string","description":"O id público de acesso na URL."},"domainId":{"type":"string","nullable":true,"description":"O host em que a URL é montada; `null` = a escolha automática."},"editable":{"type":"boolean","description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Códigos de cupom aplicados quando o link abre; `null` quando não há."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o link deixa de abrir; `null` = nunca."},"sessionId":{"type":"string","nullable":true,"description":"A sessão de checkout ligada ao link, quando há."},"signature":{"type":"string","description":"A assinatura da URL."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"templateId":{"type":"string","nullable":true,"description":"O template de checkout; `null` = o checkout padrão."},"availableAt":{"type":"string","nullable":true,"description":"Quando o link passa a abrir; `null` = já abre."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"nullable":true,"description":"Campos extras que o checkout pede ao comprador; `null` quando não há."},"accessFullUrl":{"type":"string","nullable":true,"description":"A URL para compartilhar com os compradores."},"integrationId":{"type":"string","nullable":true,"description":"A integração a que uma venda pelo link pertence; `null` quando não há."}},"additionalProperties":false},"example":{"id":"link_0a1b2c3d4e5f60718293","name":"Acme Ltda","type":"string","items":[{}],"enabled":true,"accessId":"string","domainId":"string","editable":true,"metadata":{},"createdAt":"string","discounts":[],"expiresAt":"string","sessionId":"string","signature":"string","updatedAt":"string","templateId":"string","availableAt":"string","customInputs":[{}],"accessFullUrl":"string","integrationId":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"paymentLinkId","schema":{"type":"string","pattern":"^(link)_.+$"},"required":true,"description":"Identificador público (link_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateCheckoutPaymentLink","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":255,"minLength":1,"description":"Nome do link, para a sua referência."},"items":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Uma variante do seu catálogo."},"quantity":{"type":"integer","default":1,"maximum":100000,"minimum":1,"description":"Quantidade."}},"description":"Uma linha do carrinho do link.","additionalProperties":false},"maxItems":100,"minItems":1,"description":"O carrinho fixo do link (1 a 100 linhas)."},"enabled":{"type":"boolean","description":"Liga ou desliga o link sem trocar a URL."},"domainId":{"type":"string","pattern":"^(dmn|host|cdm)_.+$","nullable":true,"description":"Mover o link para outro host (reescreve `accessFullUrl`, não `accessId`); `null` = volta à escolha automática."},"editable":{"type":"boolean","description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"discounts":{"type":"array","items":{"type":"string","maxLength":50,"minLength":1},"maxItems":20,"description":"Códigos de cupom aplicados quando o link abre (validados na cobrança)."},"expiresAt":{"type":"string","format":"date-time","nullable":true,"description":"Quando o link deixa de abrir; `null` limpa."},"templateId":{"type":"string","pattern":"^(tmpl|ckt)_.+$","nullable":true,"description":"Um template de checkout seu; `null` = volta ao checkout padrão."},"availableAt":{"type":"string","format":"date-time","nullable":true,"description":"Quando o link passa a abrir; `null` limpa."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"maxItems":50,"description":"Campos extras que o checkout pede ao comprador (JSON livre, até 50)."},"integrationId":{"type":"string","pattern":"^(app)_.+$","description":"A integração a que uma venda por este link pertence (`app_…`): a sessão de checkout é marcada com ela."}},"additionalProperties":false},"example":{"name":"Acme Ltda","items":[{"id":"var_0a1b2c3d4e5f60718293","quantity":1}],"enabled":true,"domainId":"dmn_0a1b2c3d4e5f60718293","editable":true,"metadata":{},"discounts":["string"],"expiresAt":"2026-01-15T12:00:00.000Z","templateId":"tmpl_0a1b2c3d4e5f60718293","availableAt":"2026-01-15T12:00:00.000Z","customInputs":[{}],"integrationId":"app_0a1b2c3d4e5f60718293"}}},"required":true}},"patch":{"tags":["Checkout"],"summary":"Atualiza um link de pagamento","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","type","enabled","accessId","signature","accessFullUrl","sessionId","editable","items","discounts","customInputs","expiresAt","availableAt","templateId","integrationId","domainId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(link)_.+$","description":"Identificador público (link_…)"},"name":{"type":"string","description":"Nome do link."},"type":{"type":"string","nullable":true,"description":"Tipo do link (histórico; sempre o tipo persistido)."},"items":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"O carrinho fixo do link."},"enabled":{"type":"boolean","description":"Se o link abre."},"accessId":{"type":"string","description":"O id público de acesso na URL."},"domainId":{"type":"string","nullable":true,"description":"O host em que a URL é montada; `null` = a escolha automática."},"editable":{"type":"boolean","description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Códigos de cupom aplicados quando o link abre; `null` quando não há."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o link deixa de abrir; `null` = nunca."},"sessionId":{"type":"string","nullable":true,"description":"A sessão de checkout ligada ao link, quando há."},"signature":{"type":"string","description":"A assinatura da URL."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"templateId":{"type":"string","nullable":true,"description":"O template de checkout; `null` = o checkout padrão."},"availableAt":{"type":"string","nullable":true,"description":"Quando o link passa a abrir; `null` = já abre."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"nullable":true,"description":"Campos extras que o checkout pede ao comprador; `null` quando não há."},"accessFullUrl":{"type":"string","nullable":true,"description":"A URL para compartilhar com os compradores."},"integrationId":{"type":"string","nullable":true,"description":"A integração a que uma venda pelo link pertence; `null` quando não há."}},"additionalProperties":false},"example":{"id":"link_0a1b2c3d4e5f60718293","name":"Acme Ltda","type":"string","items":[{}],"enabled":true,"accessId":"string","domainId":"string","editable":true,"metadata":{},"createdAt":"string","discounts":[],"expiresAt":"string","sessionId":"string","signature":"string","updatedAt":"string","templateId":"string","availableAt":"string","customInputs":[{}],"accessFullUrl":"string","integrationId":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"paymentLinkId","schema":{"type":"string","pattern":"^(link)_.+$"},"required":true,"description":"Identificador público (link_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateCheckoutPaymentLink__patch","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":255,"minLength":1,"description":"Nome do link, para a sua referência."},"items":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Uma variante do seu catálogo."},"quantity":{"type":"integer","default":1,"maximum":100000,"minimum":1,"description":"Quantidade."}},"description":"Uma linha do carrinho do link.","additionalProperties":false},"maxItems":100,"minItems":1,"description":"O carrinho fixo do link (1 a 100 linhas)."},"enabled":{"type":"boolean","description":"Liga ou desliga o link sem trocar a URL."},"domainId":{"type":"string","pattern":"^(dmn|host|cdm)_.+$","nullable":true,"description":"Mover o link para outro host (reescreve `accessFullUrl`, não `accessId`); `null` = volta à escolha automática."},"editable":{"type":"boolean","description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"discounts":{"type":"array","items":{"type":"string","maxLength":50,"minLength":1},"maxItems":20,"description":"Códigos de cupom aplicados quando o link abre (validados na cobrança)."},"expiresAt":{"type":"string","format":"date-time","nullable":true,"description":"Quando o link deixa de abrir; `null` limpa."},"templateId":{"type":"string","pattern":"^(tmpl|ckt)_.+$","nullable":true,"description":"Um template de checkout seu; `null` = volta ao checkout padrão."},"availableAt":{"type":"string","format":"date-time","nullable":true,"description":"Quando o link passa a abrir; `null` limpa."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"maxItems":50,"description":"Campos extras que o checkout pede ao comprador (JSON livre, até 50)."},"integrationId":{"type":"string","pattern":"^(app)_.+$","description":"A integração a que uma venda por este link pertence (`app_…`): a sessão de checkout é marcada com ela."}},"additionalProperties":false},"example":{"name":"Acme Ltda","items":[{"id":"var_0a1b2c3d4e5f60718293","quantity":1}],"enabled":true,"domainId":"dmn_0a1b2c3d4e5f60718293","editable":true,"metadata":{},"discounts":["string"],"expiresAt":"2026-01-15T12:00:00.000Z","templateId":"tmpl_0a1b2c3d4e5f60718293","availableAt":"2026-01-15T12:00:00.000Z","customInputs":[{}],"integrationId":"app_0a1b2c3d4e5f60718293"}}},"required":true}},"delete":{"tags":["Checkout"],"summary":"Exclui um link de pagamento","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","pattern":"^(link)_.+$","description":"Id público do recurso excluído."},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"resource":{"enum":["checkout-paymentLink"],"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"link_0a1b2c3d4e5f60718293","deleted":true,"resource":"checkout-paymentLink"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"paymentLinkId","schema":{"type":"string","pattern":"^(link)_.+$"},"required":true,"description":"Identificador público (link_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteCheckoutPaymentLink"}},"/v1/checkouts/sessions/{sessionId}/behavior":{"get":{"tags":["Checkout"],"summary":"Lê o resumo comportamental + o diagnóstico de intenção/abandono de uma sessão","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["object","id","status","engagement","insights","behavior"],"properties":{"id":{"type":"string","pattern":"^(sess|ckts|ses)_.+$","description":"Identificador público (sess_/ckts_/ses_…)"},"object":{"enum":["checkout.session.behavior"],"type":"string","description":"Sempre `checkout.session.behavior`."},"status":{"type":"string","description":"Status da sessão."},"behavior":{"type":"object","nullable":true,"description":"O consolidado bruto: contadores, edições por campo, tempo por passo, tentativas de pagamento…; `null` sem sinais.","additionalProperties":{}},"insights":{"type":"object","nullable":true,"required":["intentScore","abandonmentRisk","automationScore","confidence","stage","frictionPoints","recommendedAction","reasons","summary","computedAt"],"properties":{"stage":{"enum":["browsing","filling","paying","stuck","leaving","converted"],"type":"string","description":"Onde o comprador está: `browsing`, `filling`, `paying`, `stuck`, `leaving` ou `converted`."},"reasons":{"type":"array","items":{"type":"string"},"description":"Por quê, em linguagem simples — a narrativa que um operador lê."},"summary":{"type":"string","description":"Leitura da sessão em um parágrafo."},"computedAt":{"type":"string","description":"Quando foi calculado (ISO 8601); recalculado a cada sinal."},"confidence":{"type":"integer","maximum":100,"minimum":0,"description":"Quanta evidência sustenta as notas (0–100): uma sessão de poucos segundos é um palpite, não um diagnóstico."},"intentScore":{"type":"integer","maximum":100,"minimum":0,"description":"Quão perto este comprador está de pagar (0–100)."},"frictionPoints":{"type":"array","items":{"type":"object","required":["area","severity","evidence"],"properties":{"area":{"type":"string","description":"Onde (um campo, um passo, o pagamento)."},"evidence":{"type":"string","description":"O que foi observado."},"severity":{"enum":["low","medium","high"],"type":"string","description":"`low`, `medium` ou `high`."}},"additionalProperties":false},"description":"Onde dói, do pior para o menor."},"abandonmentRisk":{"type":"integer","maximum":100,"minimum":0,"description":"Quão provável é perder esta sessão (0–100) — a chave de ordenação da fila de recuperação."},"automationScore":{"type":"integer","maximum":100,"minimum":0,"description":"Indício de automação/robô (0–100). Consultivo: nunca recusa uma cobrança sozinho."},"recommendedAction":{"enum":["none","wait","offerHelp","offerDiscount","recoverByEmail","recoverByWhatsapp","manualReview"],"type":"string","description":"O que fazer a respeito: `none`, `wait`, `offerHelp`, `offerDiscount`, `recoverByEmail`, `recoverByWhatsapp` ou `manualReview`."}},"description":"O diagnóstico da sessão; `null` sem sinais.","additionalProperties":false},"engagement":{"type":"object","required":["totalTimeSpentMs","activeTimeMs","maxStepReached","visitCount","eventCount","lastTelemetryAt"],"properties":{"eventCount":{"type":"integer","description":"Quantos eventos de interação foram registrados."},"visitCount":{"type":"integer","description":"Quantas vezes o checkout foi aberto."},"activeTimeMs":{"type":"integer","description":"Tempo com a aba ativa, em milissegundos."},"maxStepReached":{"type":"integer","description":"O passo mais avançado do funil alcançado."},"lastTelemetryAt":{"type":"string","nullable":true,"description":"Quando o último sinal chegou; `null` quando não houve."},"totalTimeSpentMs":{"type":"integer","description":"Tempo total no checkout, em milissegundos."}},"description":"Engajamento acumulado da sessão.","additionalProperties":false}},"additionalProperties":false},"example":{"id":"sess_0a1b2c3d4e5f60718293","object":"checkout.session.behavior","status":"string","behavior":{},"insights":{"stage":"browsing","reasons":["string"],"summary":"string","computedAt":"string","confidence":0,"intentScore":0,"frictionPoints":[{"area":"string","evidence":"string","severity":"low"}],"abandonmentRisk":0,"automationScore":0,"recommendedAction":"none"},"engagement":{"eventCount":0,"visitCount":0,"activeTimeMs":0,"maxStepReached":0,"lastTelemetryAt":"string","totalTimeSpentMs":5000}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","pattern":"^(sess|ckts|ses)_.+$"},"required":true,"description":"Identificador público (sess_/ckts_/ses_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getCheckoutSessionBehavior"}},"/v1/withdrawals/destinations/pix-key/recheck":{"post":{"tags":["Withdrawals"],"summary":"Reconfere o destino de saque por chave Pix depois de cadastrar a chave no banco","responses":{"202":{"content":{"application/json":{"schema":{"type":"object","required":["pixKey"],"properties":{"pixKey":{"type":"object","nullable":true,"required":["appliesTo","keyType","keyMasked","holderName","status","canRecheck","recheckAvailableInSeconds","checkedAt"],"properties":{"status":{"enum":["active","pending","keyNotRegistered","documentMissing","blocked","inactive"],"type":"string","description":"`active` (os saques fluem) · `pending` (em conferência) · `keyNotRegistered` (cadastre a chave do seu CPF/CNPJ no seu banco) · `documentMissing` · `blocked` · `inactive`."},"keyType":{"enum":["cpf","cnpj"],"type":"string","nullable":true,"description":"Tipo da chave Pix: `cpf` ou `cnpj`."},"appliesTo":{"enum":["pixSales"],"type":"string","description":"Sempre `pixSales`: este destino recebe a parte do saque que veio do Pix."},"checkedAt":{"type":"string","nullable":true,"description":"Quando a chave foi conferida pela última vez; `null` quando nunca."},"keyMasked":{"type":"string","nullable":true,"description":"A chave Pix, mascarada."},"canRecheck":{"type":"boolean","description":"Se `POST /v1/withdrawals/destinations/pix-key/recheck` pode ser chamado agora."},"holderName":{"type":"string","nullable":true,"description":"Nome do titular da chave."},"recheckAvailableInSeconds":{"type":"integer","description":"Segundos até a próxima reconferência ser permitida (0 = agora)."}},"description":"`null` quando as suas vendas no Pix não ficam separadas (cada parte de um saque vai para a conta bancária escolhida).","additionalProperties":false}},"additionalProperties":false},"example":{"pixKey":{"status":"active","keyType":"cpf","appliesTo":"pixSales","checkedAt":"string","keyMasked":"string","canRecheck":true,"holderName":"JOAO SILVA","recheckAvailableInSeconds":0}}}},"description":"Aceito"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"429":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Limite de requisições excedido"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"recheckPixKeyDestination"}},"/v1/marketplace/kyc/{token}/onboarding/step-1":{"post":{"tags":["Marketplace"],"summary":"Envia o passo 1 do cadastro pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","logo","legalBusinessName","email","cellphone","document","documentType","country","website","description","referrer","revenue","monthlyBillingEstimate","softdescriptor","platformBrand","mcc","status","createdAt","updatedAt","onboarding","_links"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"mcc":{"type":"string","nullable":true,"description":"Código de categoria do estabelecimento (MCC); `null` até ser definido."},"logo":{"type":"string","nullable":true,"description":"URL do logotipo; `null` quando nenhum foi enviado."},"name":{"type":"string","description":"Nome fantasia da empresa (o que os compradores veem)."},"email":{"type":"string","nullable":true,"description":"E-mail de contato da empresa; `null` até o passo 4."},"_links":{"type":"object","required":["self","onboarding"],"properties":{"self":{"type":"string","description":"URL desta empresa."},"onboarding":{"type":"string","description":"URL da visão do onboarding."}},"description":"Links para esta empresa e para o onboarding dela.","additionalProperties":false},"status":{"type":"string","nullable":true,"description":"Status da conta (`pending`, `analyzing`, `active`, `suspended`…); `null` quando não definido."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1); `null` até o passo 1."},"revenue":{"type":"number","nullable":true,"description":"Faturamento mensal declarado, em centavos; `null` até o passo 1."},"website":{"type":"string","nullable":true,"description":"URL do site; `null` quando não há."},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ, só dígitos; `null` até o passo 2."},"referrer":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."},"cellphone":{"type":"string","nullable":true,"description":"Telefone de contato, só dígitos; `null` até o passo 4."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"onboarding":{"type":"object","required":["onboardingId","currentStep","isCompleted","completedAt","inviteCode","referralSource","overview","checklist"],"properties":{"overview":{"type":"object","description":"O que cada passo registrou (campos sensíveis mascarados).","additionalProperties":{}},"checklist":{"type":"object","description":"Quais passos foram concluídos (`checkListStep1Complete`…`checkListStep6Complete`).","additionalProperties":{}},"inviteCode":{"type":"string","nullable":true,"description":"O código de convite resgatado no passo 1; `null` quando não há."},"completedAt":{"type":"string","nullable":true,"description":"Quando o onboarding foi concluído (ISO 8601); `null` até lá."},"currentStep":{"type":"string","description":"O passo em que o onboarding está (`1` a `6`)."},"isCompleted":{"type":"boolean","description":"Se todos os passos foram concluídos."},"onboardingId":{"type":"string","pattern":"^(cob|onb)_.+$","nullable":true,"description":"Identificador público (cob_/onb_…)"},"referralSource":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."}},"description":"Andamento do onboarding.","additionalProperties":false},"description":{"type":"string","nullable":true,"description":"O que a empresa vende, nas palavras dela; `null` até o passo 6."},"reviewDueAt":{"type":"string","nullable":true,"description":"Até quando a análise de KYC responde (ISO 8601); `null` quando a conta não está em análise ou não tem prazo. Só nas leituras."},"documentType":{"type":"string","nullable":true,"description":"`cpf` ou `cnpj`; `null` até o passo 1."},"corporateCnae":{"type":"string","nullable":true,"description":"CNAE principal da empresa; `null` quando desconhecido; omitido nas leituras do lojista."},"platformBrand":{"type":"boolean","description":"Se os links dos e-mails enviados aos compradores levam a marca da plataforma (`true`) ou o domínio próprio da empresa (`false`, marca branca)."},"softdescriptor":{"type":"string","nullable":true,"description":"O que aparece na fatura do cartão do comprador; `null` até o passo 4."},"corporateOpenDate":{"type":"string","nullable":true,"description":"Data de abertura da empresa (`YYYY-MM-DD`); `null` quando desconhecida; omitida nas leituras do lojista."},"legalBusinessName":{"type":"string","nullable":true,"description":"Razão social; `null` para pessoa física (CPF)."},"legalRepresentative":{"type":"object","nullable":true,"required":["firstName","lastName","document","birthYear","birthDate","redacted"],"properties":{"document":{"type":"string","nullable":true,"description":"CPF, mascarado a menos que revelado."},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"redacted":{"type":"boolean","description":"Se os campos estão mascarados."},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando mascarada."},"birthYear":{"type":"integer","nullable":true,"description":"Ano de nascimento."},"firstName":{"type":"string","nullable":true,"description":"Nome."}},"description":"O representante legal vigente; `null` quando a empresa não tem; omitido nas leituras do lojista.","additionalProperties":false},"paymentGroupsBlocked":{"type":"boolean","description":"Se os pagamentos combinados (dois cartões, cartão + Pix) estão bloqueados para esta empresa; omitido nas leituras do lojista."},"monthlyBillingEstimate":{"type":"string","nullable":true,"description":"Volume mensal de vendas esperado, em centavos (como texto); `null` até o passo 6."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","mcc":"string","logo":"string","name":"Acme Ltda","email":"buyer@example.com","_links":{"self":"string","onboarding":"string"},"status":"string","country":"string","revenue":0,"website":"string","document":"string","referrer":"string","cellphone":"string","createdAt":"string","updatedAt":"string","onboarding":{"overview":{},"checklist":{},"inviteCode":"string","completedAt":"string","currentStep":"string","isCompleted":true,"onboardingId":"cob_0a1b2c3d4e5f60718293","referralSource":"string"},"description":"string","reviewDueAt":"string","documentType":"string","corporateCnae":"string","platformBrand":true,"softdescriptor":"string","corporateOpenDate":"string","legalBusinessName":"string","legalRepresentative":{"document":"string","lastName":"Silva","redacted":true,"birthDate":"1990-05-20","birthYear":0,"firstName":"João"},"paymentGroupsBlocked":true,"monthlyBillingEstimate":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"submitKycStep1","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["documentType","country","revenue"],"properties":{"country":{"type":"string","maxLength":3,"minLength":2,"description":"Código do país (ISO 3166-1), convertido para maiúsculas no servidor."},"revenue":{"type":"integer","minimum":5000,"description":"Faturamento mensal declarado, em centavos (mínimo 5000)."},"inviteCode":{"type":"string","maxLength":40,"minLength":1,"description":"Código de convite; obrigatório só quando o `documentType` escolhido não está aberto no cadastro (veja `…/onboarding/document-types`). Normalizado no servidor (maiúsculas, `A-Z0-9`); ignorado nos outros casos. Confira antes com `…/onboarding/invite-code/validate`."},"documentType":{"enum":["cpf","cnpj"],"type":"string","description":"`cpf` (pessoa física) ou `cnpj` (empresa). `…/onboarding/document-types` diz quais estão abertos no cadastro e quais precisam de código de convite."}},"additionalProperties":false},"example":{"country":"string","revenue":5000,"inviteCode":"string","documentType":"cpf"}}},"required":true}}},"/v1/marketplace/kyc/{token}/onboarding/step-2":{"post":{"tags":["Marketplace"],"summary":"Envia o passo 2 do cadastro pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","logo","legalBusinessName","email","cellphone","document","documentType","country","website","description","referrer","revenue","monthlyBillingEstimate","softdescriptor","platformBrand","mcc","status","createdAt","updatedAt","onboarding","_links"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"mcc":{"type":"string","nullable":true,"description":"Código de categoria do estabelecimento (MCC); `null` até ser definido."},"logo":{"type":"string","nullable":true,"description":"URL do logotipo; `null` quando nenhum foi enviado."},"name":{"type":"string","description":"Nome fantasia da empresa (o que os compradores veem)."},"email":{"type":"string","nullable":true,"description":"E-mail de contato da empresa; `null` até o passo 4."},"_links":{"type":"object","required":["self","onboarding"],"properties":{"self":{"type":"string","description":"URL desta empresa."},"onboarding":{"type":"string","description":"URL da visão do onboarding."}},"description":"Links para esta empresa e para o onboarding dela.","additionalProperties":false},"status":{"type":"string","nullable":true,"description":"Status da conta (`pending`, `analyzing`, `active`, `suspended`…); `null` quando não definido."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1); `null` até o passo 1."},"revenue":{"type":"number","nullable":true,"description":"Faturamento mensal declarado, em centavos; `null` até o passo 1."},"website":{"type":"string","nullable":true,"description":"URL do site; `null` quando não há."},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ, só dígitos; `null` até o passo 2."},"referrer":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."},"cellphone":{"type":"string","nullable":true,"description":"Telefone de contato, só dígitos; `null` até o passo 4."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"onboarding":{"type":"object","required":["onboardingId","currentStep","isCompleted","completedAt","inviteCode","referralSource","overview","checklist"],"properties":{"overview":{"type":"object","description":"O que cada passo registrou (campos sensíveis mascarados).","additionalProperties":{}},"checklist":{"type":"object","description":"Quais passos foram concluídos (`checkListStep1Complete`…`checkListStep6Complete`).","additionalProperties":{}},"inviteCode":{"type":"string","nullable":true,"description":"O código de convite resgatado no passo 1; `null` quando não há."},"completedAt":{"type":"string","nullable":true,"description":"Quando o onboarding foi concluído (ISO 8601); `null` até lá."},"currentStep":{"type":"string","description":"O passo em que o onboarding está (`1` a `6`)."},"isCompleted":{"type":"boolean","description":"Se todos os passos foram concluídos."},"onboardingId":{"type":"string","pattern":"^(cob|onb)_.+$","nullable":true,"description":"Identificador público (cob_/onb_…)"},"referralSource":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."}},"description":"Andamento do onboarding.","additionalProperties":false},"description":{"type":"string","nullable":true,"description":"O que a empresa vende, nas palavras dela; `null` até o passo 6."},"reviewDueAt":{"type":"string","nullable":true,"description":"Até quando a análise de KYC responde (ISO 8601); `null` quando a conta não está em análise ou não tem prazo. Só nas leituras."},"documentType":{"type":"string","nullable":true,"description":"`cpf` ou `cnpj`; `null` até o passo 1."},"corporateCnae":{"type":"string","nullable":true,"description":"CNAE principal da empresa; `null` quando desconhecido; omitido nas leituras do lojista."},"platformBrand":{"type":"boolean","description":"Se os links dos e-mails enviados aos compradores levam a marca da plataforma (`true`) ou o domínio próprio da empresa (`false`, marca branca)."},"softdescriptor":{"type":"string","nullable":true,"description":"O que aparece na fatura do cartão do comprador; `null` até o passo 4."},"corporateOpenDate":{"type":"string","nullable":true,"description":"Data de abertura da empresa (`YYYY-MM-DD`); `null` quando desconhecida; omitida nas leituras do lojista."},"legalBusinessName":{"type":"string","nullable":true,"description":"Razão social; `null` para pessoa física (CPF)."},"legalRepresentative":{"type":"object","nullable":true,"required":["firstName","lastName","document","birthYear","birthDate","redacted"],"properties":{"document":{"type":"string","nullable":true,"description":"CPF, mascarado a menos que revelado."},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"redacted":{"type":"boolean","description":"Se os campos estão mascarados."},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando mascarada."},"birthYear":{"type":"integer","nullable":true,"description":"Ano de nascimento."},"firstName":{"type":"string","nullable":true,"description":"Nome."}},"description":"O representante legal vigente; `null` quando a empresa não tem; omitido nas leituras do lojista.","additionalProperties":false},"paymentGroupsBlocked":{"type":"boolean","description":"Se os pagamentos combinados (dois cartões, cartão + Pix) estão bloqueados para esta empresa; omitido nas leituras do lojista."},"monthlyBillingEstimate":{"type":"string","nullable":true,"description":"Volume mensal de vendas esperado, em centavos (como texto); `null` até o passo 6."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","mcc":"string","logo":"string","name":"Acme Ltda","email":"buyer@example.com","_links":{"self":"string","onboarding":"string"},"status":"string","country":"string","revenue":0,"website":"string","document":"string","referrer":"string","cellphone":"string","createdAt":"string","updatedAt":"string","onboarding":{"overview":{},"checklist":{},"inviteCode":"string","completedAt":"string","currentStep":"string","isCompleted":true,"onboardingId":"cob_0a1b2c3d4e5f60718293","referralSource":"string"},"description":"string","reviewDueAt":"string","documentType":"string","corporateCnae":"string","platformBrand":true,"softdescriptor":"string","corporateOpenDate":"string","legalBusinessName":"string","legalRepresentative":{"document":"string","lastName":"Silva","redacted":true,"birthDate":"1990-05-20","birthYear":0,"firstName":"João"},"paymentGroupsBlocked":true,"monthlyBillingEstimate":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"submitKycStep2","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["legalBusinessName","document","address","phone","owner"],"properties":{"owner":{"type":"object","required":["firstName","lastName","document","birthDate","phone"],"properties":{"phone":{"type":"object","required":["countryCode","areaCode","number"],"properties":{"number":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":6,"description":"Número, só dígitos."},"areaCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"DDD, só dígitos (ex.: `11`)."},"countryCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"Código do país, só dígitos (ex.: `55`)."}},"description":"Telefone do representante.","additionalProperties":false},"address":{"type":"object","properties":{"city":{"type":"string","maxLength":100,"minLength":2,"description":"Cidade."},"state":{"type":"string","maxLength":2,"minLength":2,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","maxLength":20,"minLength":1,"description":"Número."},"street":{"type":"string","maxLength":100,"minLength":4,"description":"Logradouro."},"country":{"type":"string","maxLength":3,"minLength":2,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","maxLength":100,"minLength":2,"description":"Bairro."},"postcode":{"type":"string","pattern":"^\\d{5}-?\\d{3}$","description":"CEP, 8 dígitos — o hífen é aceito."},"complement":{"type":"string","maxLength":40,"description":"Complemento (apartamento, sala, bloco…)."}},"description":"Endereço do representante.","additionalProperties":false},"document":{"type":"string","description":"Número do documento: dígitos do CPF ou CNPJ (a máscara é aceita), ou o número do passaporte."},"lastName":{"type":"string","maxLength":60,"minLength":1,"description":"Sobrenome."},"position":{"type":"string","maxLength":60,"description":"Cargo do representante na empresa (ex.: sócio-administrador)."},"birthDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},"firstName":{"type":"string","maxLength":60,"minLength":1,"description":"Nome."},"nacionality":{"type":"string","maxLength":40,"minLength":2,"description":"Nacionalidade do representante (padrão `BR`). O nome mantém a grafia histórica."}},"description":"O representante legal da empresa.","additionalProperties":false},"phone":{"type":"object","required":["countryCode","areaCode","number"],"properties":{"number":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":6,"description":"Número, só dígitos."},"areaCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"DDD, só dígitos (ex.: `11`)."},"countryCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"Código do país, só dígitos (ex.: `55`)."}},"description":"Telefone de contato da empresa.","additionalProperties":false},"address":{"type":"object","required":["postcode","street","number","district"],"properties":{"city":{"type":"string","maxLength":100,"minLength":2,"description":"Cidade."},"state":{"type":"string","maxLength":2,"minLength":2,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","maxLength":20,"minLength":1,"description":"Número."},"street":{"type":"string","maxLength":100,"minLength":4,"description":"Logradouro."},"country":{"type":"string","maxLength":3,"minLength":2,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","maxLength":100,"minLength":2,"description":"Bairro."},"postcode":{"type":"string","pattern":"^\\d{5}-?\\d{3}$","description":"CEP, 8 dígitos — o hífen é aceito."},"complement":{"type":"string","maxLength":40,"description":"Complemento (apartamento, sala, bloco…)."}},"description":"Endereço registrado da empresa.","additionalProperties":false},"document":{"type":"string","description":"Número do documento: dígitos do CPF ou CNPJ (a máscara é aceita), ou o número do passaporte."},"companyName":{"type":"string","maxLength":100,"minLength":1,"description":"Nome fantasia; padrão: `legalBusinessName`."},"legalBusinessName":{"type":"string","maxLength":100,"minLength":1,"description":"Razão social."}},"description":"Uma empresa (`documentType: cnpj` no passo 1).","additionalProperties":false},{"type":"object","required":["firstName","lastName","birthDate","document","address","phone"],"properties":{"phone":{"type":"object","required":["countryCode","areaCode","number"],"properties":{"number":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":6,"description":"Número, só dígitos."},"areaCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"DDD, só dígitos (ex.: `11`)."},"countryCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"Código do país, só dígitos (ex.: `55`)."}},"description":"Telefone de contato.","additionalProperties":false},"address":{"type":"object","required":["postcode","street","number","district"],"properties":{"city":{"type":"string","maxLength":100,"minLength":2,"description":"Cidade."},"state":{"type":"string","maxLength":2,"minLength":2,"description":"Estado (sigla de duas letras)."},"number":{"type":"string","maxLength":20,"minLength":1,"description":"Número."},"street":{"type":"string","maxLength":100,"minLength":4,"description":"Logradouro."},"country":{"type":"string","maxLength":3,"minLength":2,"description":"Código do país (ISO 3166-1)."},"district":{"type":"string","maxLength":100,"minLength":2,"description":"Bairro."},"postcode":{"type":"string","pattern":"^\\d{5}-?\\d{3}$","description":"CEP, 8 dígitos — o hífen é aceito."},"complement":{"type":"string","maxLength":40,"description":"Complemento (apartamento, sala, bloco…)."}},"description":"Endereço residencial.","additionalProperties":false},"website":{"type":"string","format":"uri","description":"URL absoluta."},"document":{"type":"string","description":"Número do documento: dígitos do CPF ou CNPJ (a máscara é aceita), ou o número do passaporte."},"lastName":{"type":"string","maxLength":60,"minLength":1,"description":"Sobrenome, como no documento."},"position":{"type":"string","maxLength":60,"description":"Ocupação."},"birthDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Data, `YYYY-MM-DD`."},"firstName":{"type":"string","maxLength":60,"minLength":1,"description":"Nome, como no documento."},"nacionality":{"type":"string","maxLength":40,"minLength":2,"description":"Nacionalidade (padrão `BR`). O nome mantém a grafia histórica."},"isPoliticallyExposed":{"type":"boolean","description":"Se o titular é pessoa politicamente exposta (PEP)."}},"description":"Uma pessoa física (`documentType: cpf` no passo 1).","additionalProperties":false}]},"example":{"owner":{"phone":{"number":"1000","areaCode":"11","countryCode":"55"},"address":{"city":"string","state":"string","number":"1000","street":"string","country":"string","district":"string","postcode":"id_0a1b2c3d4e5f60718293","complement":"string"},"document":"string","lastName":"Silva","position":"string","birthDate":"1990-05-20","firstName":"João","nacionality":"string"},"phone":{"number":"1000","areaCode":"11","countryCode":"55"},"address":{"city":"string","state":"string","number":"1000","street":"string","country":"string","district":"string","postcode":"id_0a1b2c3d4e5f60718293","complement":"string"},"document":"string","companyName":"string","legalBusinessName":"string"}}},"required":true}}},"/v1/marketplace/kyc/{token}/onboarding/step-3":{"post":{"tags":["Marketplace"],"summary":"Envia o passo 3 do cadastro (documentos) pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","logo","legalBusinessName","email","cellphone","document","documentType","country","website","description","referrer","revenue","monthlyBillingEstimate","softdescriptor","platformBrand","mcc","status","createdAt","updatedAt","onboarding","_links"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"mcc":{"type":"string","nullable":true,"description":"Código de categoria do estabelecimento (MCC); `null` até ser definido."},"logo":{"type":"string","nullable":true,"description":"URL do logotipo; `null` quando nenhum foi enviado."},"name":{"type":"string","description":"Nome fantasia da empresa (o que os compradores veem)."},"email":{"type":"string","nullable":true,"description":"E-mail de contato da empresa; `null` até o passo 4."},"_links":{"type":"object","required":["self","onboarding"],"properties":{"self":{"type":"string","description":"URL desta empresa."},"onboarding":{"type":"string","description":"URL da visão do onboarding."}},"description":"Links para esta empresa e para o onboarding dela.","additionalProperties":false},"status":{"type":"string","nullable":true,"description":"Status da conta (`pending`, `analyzing`, `active`, `suspended`…); `null` quando não definido."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1); `null` até o passo 1."},"revenue":{"type":"number","nullable":true,"description":"Faturamento mensal declarado, em centavos; `null` até o passo 1."},"website":{"type":"string","nullable":true,"description":"URL do site; `null` quando não há."},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ, só dígitos; `null` até o passo 2."},"referrer":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."},"cellphone":{"type":"string","nullable":true,"description":"Telefone de contato, só dígitos; `null` até o passo 4."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"onboarding":{"type":"object","required":["onboardingId","currentStep","isCompleted","completedAt","inviteCode","referralSource","overview","checklist"],"properties":{"overview":{"type":"object","description":"O que cada passo registrou (campos sensíveis mascarados).","additionalProperties":{}},"checklist":{"type":"object","description":"Quais passos foram concluídos (`checkListStep1Complete`…`checkListStep6Complete`).","additionalProperties":{}},"inviteCode":{"type":"string","nullable":true,"description":"O código de convite resgatado no passo 1; `null` quando não há."},"completedAt":{"type":"string","nullable":true,"description":"Quando o onboarding foi concluído (ISO 8601); `null` até lá."},"currentStep":{"type":"string","description":"O passo em que o onboarding está (`1` a `6`)."},"isCompleted":{"type":"boolean","description":"Se todos os passos foram concluídos."},"onboardingId":{"type":"string","pattern":"^(cob|onb)_.+$","nullable":true,"description":"Identificador público (cob_/onb_…)"},"referralSource":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."}},"description":"Andamento do onboarding.","additionalProperties":false},"description":{"type":"string","nullable":true,"description":"O que a empresa vende, nas palavras dela; `null` até o passo 6."},"reviewDueAt":{"type":"string","nullable":true,"description":"Até quando a análise de KYC responde (ISO 8601); `null` quando a conta não está em análise ou não tem prazo. Só nas leituras."},"documentType":{"type":"string","nullable":true,"description":"`cpf` ou `cnpj`; `null` até o passo 1."},"corporateCnae":{"type":"string","nullable":true,"description":"CNAE principal da empresa; `null` quando desconhecido; omitido nas leituras do lojista."},"platformBrand":{"type":"boolean","description":"Se os links dos e-mails enviados aos compradores levam a marca da plataforma (`true`) ou o domínio próprio da empresa (`false`, marca branca)."},"softdescriptor":{"type":"string","nullable":true,"description":"O que aparece na fatura do cartão do comprador; `null` até o passo 4."},"corporateOpenDate":{"type":"string","nullable":true,"description":"Data de abertura da empresa (`YYYY-MM-DD`); `null` quando desconhecida; omitida nas leituras do lojista."},"legalBusinessName":{"type":"string","nullable":true,"description":"Razão social; `null` para pessoa física (CPF)."},"legalRepresentative":{"type":"object","nullable":true,"required":["firstName","lastName","document","birthYear","birthDate","redacted"],"properties":{"document":{"type":"string","nullable":true,"description":"CPF, mascarado a menos que revelado."},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"redacted":{"type":"boolean","description":"Se os campos estão mascarados."},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando mascarada."},"birthYear":{"type":"integer","nullable":true,"description":"Ano de nascimento."},"firstName":{"type":"string","nullable":true,"description":"Nome."}},"description":"O representante legal vigente; `null` quando a empresa não tem; omitido nas leituras do lojista.","additionalProperties":false},"paymentGroupsBlocked":{"type":"boolean","description":"Se os pagamentos combinados (dois cartões, cartão + Pix) estão bloqueados para esta empresa; omitido nas leituras do lojista."},"monthlyBillingEstimate":{"type":"string","nullable":true,"description":"Volume mensal de vendas esperado, em centavos (como texto); `null` até o passo 6."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","mcc":"string","logo":"string","name":"Acme Ltda","email":"buyer@example.com","_links":{"self":"string","onboarding":"string"},"status":"string","country":"string","revenue":0,"website":"string","document":"string","referrer":"string","cellphone":"string","createdAt":"string","updatedAt":"string","onboarding":{"overview":{},"checklist":{},"inviteCode":"string","completedAt":"string","currentStep":"string","isCompleted":true,"onboardingId":"cob_0a1b2c3d4e5f60718293","referralSource":"string"},"description":"string","reviewDueAt":"string","documentType":"string","corporateCnae":"string","platformBrand":true,"softdescriptor":"string","corporateOpenDate":"string","legalBusinessName":"string","legalRepresentative":{"document":"string","lastName":"Silva","redacted":true,"birthDate":"1990-05-20","birthYear":0,"firstName":"João"},"paymentGroupsBlocked":true,"monthlyBillingEstimate":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"submitKycStep3","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["documents"],"properties":{"documents":{"type":"array","items":{"type":"object","required":["documentType","assetId"],"properties":{"assetId":{"type":"string","pattern":"^.+_.+$","description":"Identificador público (prefixo_valor)"},"accessUrl":{"type":"string","format":"uri","description":"URL absoluta."},"documentType":{"enum":["social_contract","certificate_of_registration","municipal_registration","proof_of_address_company","cnpj_card","bank_statement_company","social_proof","proof_of_residence_partner","selfie","cnh_full","cnh_front","cnh_back","rg_front","rg_back","cref","identity_front","identity_back","selfie_holding_id"],"type":"string","description":"O que o arquivo é — um dos `type`s listados por `…/onboarding/document-requirements`."}},"additionalProperties":false},"maxItems":18,"minItems":1,"description":"Os documentos a anexar (1–18): cada um é um arquivo enviado e o que ele é."}},"additionalProperties":false},"example":{"documents":[{"assetId":"id_0a1b2c3d4e5f60718293","accessUrl":"https://example.com","documentType":"social_contract"}]}}},"required":true}}},"/v1/marketplace/kyc/{token}/onboarding/step-4":{"post":{"tags":["Marketplace"],"summary":"Envia o passo 4 do cadastro pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","logo","legalBusinessName","email","cellphone","document","documentType","country","website","description","referrer","revenue","monthlyBillingEstimate","softdescriptor","platformBrand","mcc","status","createdAt","updatedAt","onboarding","_links"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"mcc":{"type":"string","nullable":true,"description":"Código de categoria do estabelecimento (MCC); `null` até ser definido."},"logo":{"type":"string","nullable":true,"description":"URL do logotipo; `null` quando nenhum foi enviado."},"name":{"type":"string","description":"Nome fantasia da empresa (o que os compradores veem)."},"email":{"type":"string","nullable":true,"description":"E-mail de contato da empresa; `null` até o passo 4."},"_links":{"type":"object","required":["self","onboarding"],"properties":{"self":{"type":"string","description":"URL desta empresa."},"onboarding":{"type":"string","description":"URL da visão do onboarding."}},"description":"Links para esta empresa e para o onboarding dela.","additionalProperties":false},"status":{"type":"string","nullable":true,"description":"Status da conta (`pending`, `analyzing`, `active`, `suspended`…); `null` quando não definido."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1); `null` até o passo 1."},"revenue":{"type":"number","nullable":true,"description":"Faturamento mensal declarado, em centavos; `null` até o passo 1."},"website":{"type":"string","nullable":true,"description":"URL do site; `null` quando não há."},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ, só dígitos; `null` até o passo 2."},"referrer":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."},"cellphone":{"type":"string","nullable":true,"description":"Telefone de contato, só dígitos; `null` até o passo 4."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"onboarding":{"type":"object","required":["onboardingId","currentStep","isCompleted","completedAt","inviteCode","referralSource","overview","checklist"],"properties":{"overview":{"type":"object","description":"O que cada passo registrou (campos sensíveis mascarados).","additionalProperties":{}},"checklist":{"type":"object","description":"Quais passos foram concluídos (`checkListStep1Complete`…`checkListStep6Complete`).","additionalProperties":{}},"inviteCode":{"type":"string","nullable":true,"description":"O código de convite resgatado no passo 1; `null` quando não há."},"completedAt":{"type":"string","nullable":true,"description":"Quando o onboarding foi concluído (ISO 8601); `null` até lá."},"currentStep":{"type":"string","description":"O passo em que o onboarding está (`1` a `6`)."},"isCompleted":{"type":"boolean","description":"Se todos os passos foram concluídos."},"onboardingId":{"type":"string","pattern":"^(cob|onb)_.+$","nullable":true,"description":"Identificador público (cob_/onb_…)"},"referralSource":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."}},"description":"Andamento do onboarding.","additionalProperties":false},"description":{"type":"string","nullable":true,"description":"O que a empresa vende, nas palavras dela; `null` até o passo 6."},"reviewDueAt":{"type":"string","nullable":true,"description":"Até quando a análise de KYC responde (ISO 8601); `null` quando a conta não está em análise ou não tem prazo. Só nas leituras."},"documentType":{"type":"string","nullable":true,"description":"`cpf` ou `cnpj`; `null` até o passo 1."},"corporateCnae":{"type":"string","nullable":true,"description":"CNAE principal da empresa; `null` quando desconhecido; omitido nas leituras do lojista."},"platformBrand":{"type":"boolean","description":"Se os links dos e-mails enviados aos compradores levam a marca da plataforma (`true`) ou o domínio próprio da empresa (`false`, marca branca)."},"softdescriptor":{"type":"string","nullable":true,"description":"O que aparece na fatura do cartão do comprador; `null` até o passo 4."},"corporateOpenDate":{"type":"string","nullable":true,"description":"Data de abertura da empresa (`YYYY-MM-DD`); `null` quando desconhecida; omitida nas leituras do lojista."},"legalBusinessName":{"type":"string","nullable":true,"description":"Razão social; `null` para pessoa física (CPF)."},"legalRepresentative":{"type":"object","nullable":true,"required":["firstName","lastName","document","birthYear","birthDate","redacted"],"properties":{"document":{"type":"string","nullable":true,"description":"CPF, mascarado a menos que revelado."},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"redacted":{"type":"boolean","description":"Se os campos estão mascarados."},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando mascarada."},"birthYear":{"type":"integer","nullable":true,"description":"Ano de nascimento."},"firstName":{"type":"string","nullable":true,"description":"Nome."}},"description":"O representante legal vigente; `null` quando a empresa não tem; omitido nas leituras do lojista.","additionalProperties":false},"paymentGroupsBlocked":{"type":"boolean","description":"Se os pagamentos combinados (dois cartões, cartão + Pix) estão bloqueados para esta empresa; omitido nas leituras do lojista."},"monthlyBillingEstimate":{"type":"string","nullable":true,"description":"Volume mensal de vendas esperado, em centavos (como texto); `null` até o passo 6."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","mcc":"string","logo":"string","name":"Acme Ltda","email":"buyer@example.com","_links":{"self":"string","onboarding":"string"},"status":"string","country":"string","revenue":0,"website":"string","document":"string","referrer":"string","cellphone":"string","createdAt":"string","updatedAt":"string","onboarding":{"overview":{},"checklist":{},"inviteCode":"string","completedAt":"string","currentStep":"string","isCompleted":true,"onboardingId":"cob_0a1b2c3d4e5f60718293","referralSource":"string"},"description":"string","reviewDueAt":"string","documentType":"string","corporateCnae":"string","platformBrand":true,"softdescriptor":"string","corporateOpenDate":"string","legalBusinessName":"string","legalRepresentative":{"document":"string","lastName":"Silva","redacted":true,"birthDate":"1990-05-20","birthYear":0,"firstName":"João"},"paymentGroupsBlocked":true,"monthlyBillingEstimate":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"submitKycStep4","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["softDescriptor","email","phone"],"properties":{"email":{"type":"string","format":"email","description":"Endereço de e-mail (normalizado em minúsculas)."},"phone":{"type":"object","required":["countryCode","areaCode","number"],"properties":{"number":{"type":"string","pattern":"^\\d+$","maxLength":20,"minLength":6,"description":"Número, só dígitos."},"areaCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"DDD, só dígitos (ex.: `11`)."},"countryCode":{"type":"string","pattern":"^\\d+$","maxLength":5,"minLength":2,"description":"Código do país, só dígitos (ex.: `55`)."}},"description":"Telefone de contato.","additionalProperties":false},"softDescriptor":{"type":"string","maxLength":13,"minLength":1,"description":"O que aparece na fatura do cartão do comprador (até 13 caracteres)."}},"additionalProperties":false},"example":{"email":"buyer@example.com","phone":{"number":"1000","areaCode":"11","countryCode":"55"},"softDescriptor":"string"}}},"required":true}}},"/v1/marketplace/kyc/{token}/onboarding/step-5":{"post":{"tags":["Marketplace"],"summary":"Envia o passo 5 do cadastro (conta de recebimento) pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["company","wallet"],"properties":{"wallet":{"type":"object","required":["id","name","holderName","bankName","bankCode","routingNumber","accountNumber","accountType","pixKey","primary","enabled","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(wall)_.+$","description":"Identificador público (wall_…)"},"name":{"type":"string","description":"Nome da conta bancária."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"pixKey":{"type":"string","nullable":true,"description":"Chave Pix do destino; `null` quando é conta bancária."},"enabled":{"type":"boolean","description":"Se a conta bancária pode receber saques (`false` depois de arquivada)."},"primary":{"type":"boolean","description":"Se é o destino principal dos saques."},"bankCode":{"type":"string","nullable":true,"description":"Código do banco."},"bankName":{"type":"string","nullable":true,"description":"Nome do banco."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"holderName":{"type":"string","description":"Nome do titular da conta — sempre o dono da conta (a sua empresa)."},"accountType":{"type":"string","description":"Tipo da conta (ex.: `checking`)."},"accountNumber":{"type":"string","nullable":true,"description":"Número da conta."},"routingNumber":{"type":"string","nullable":true,"description":"Agência."}},"description":"A conta bancária registrada como destino dos saques.","additionalProperties":false},"company":{"type":"object","required":["id","name","logo","legalBusinessName","email","cellphone","document","documentType","country","website","description","referrer","revenue","monthlyBillingEstimate","softdescriptor","platformBrand","mcc","status","createdAt","updatedAt","onboarding","_links"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"mcc":{"type":"string","nullable":true,"description":"Código de categoria do estabelecimento (MCC); `null` até ser definido."},"logo":{"type":"string","nullable":true,"description":"URL do logotipo; `null` quando nenhum foi enviado."},"name":{"type":"string","description":"Nome fantasia da empresa (o que os compradores veem)."},"email":{"type":"string","nullable":true,"description":"E-mail de contato da empresa; `null` até o passo 4."},"_links":{"type":"object","required":["self","onboarding"],"properties":{"self":{"type":"string","description":"URL desta empresa."},"onboarding":{"type":"string","description":"URL da visão do onboarding."}},"description":"Links para esta empresa e para o onboarding dela.","additionalProperties":false},"status":{"type":"string","nullable":true,"description":"Status da conta (`pending`, `analyzing`, `active`, `suspended`…); `null` quando não definido."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1); `null` até o passo 1."},"revenue":{"type":"number","nullable":true,"description":"Faturamento mensal declarado, em centavos; `null` até o passo 1."},"website":{"type":"string","nullable":true,"description":"URL do site; `null` quando não há."},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ, só dígitos; `null` até o passo 2."},"referrer":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."},"cellphone":{"type":"string","nullable":true,"description":"Telefone de contato, só dígitos; `null` até o passo 4."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"onboarding":{"type":"object","required":["onboardingId","currentStep","isCompleted","completedAt","inviteCode","referralSource","overview","checklist"],"properties":{"overview":{"type":"object","description":"O que cada passo registrou (campos sensíveis mascarados).","additionalProperties":{}},"checklist":{"type":"object","description":"Quais passos foram concluídos (`checkListStep1Complete`…`checkListStep6Complete`).","additionalProperties":{}},"inviteCode":{"type":"string","nullable":true,"description":"O código de convite resgatado no passo 1; `null` quando não há."},"completedAt":{"type":"string","nullable":true,"description":"Quando o onboarding foi concluído (ISO 8601); `null` até lá."},"currentStep":{"type":"string","description":"O passo em que o onboarding está (`1` a `6`)."},"isCompleted":{"type":"boolean","description":"Se todos os passos foram concluídos."},"onboardingId":{"type":"string","pattern":"^(cob|onb)_.+$","nullable":true,"description":"Identificador público (cob_/onb_…)"},"referralSource":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."}},"description":"Andamento do onboarding.","additionalProperties":false},"description":{"type":"string","nullable":true,"description":"O que a empresa vende, nas palavras dela; `null` até o passo 6."},"reviewDueAt":{"type":"string","nullable":true,"description":"Até quando a análise de KYC responde (ISO 8601); `null` quando a conta não está em análise ou não tem prazo. Só nas leituras."},"documentType":{"type":"string","nullable":true,"description":"`cpf` ou `cnpj`; `null` até o passo 1."},"corporateCnae":{"type":"string","nullable":true,"description":"CNAE principal da empresa; `null` quando desconhecido; omitido nas leituras do lojista."},"platformBrand":{"type":"boolean","description":"Se os links dos e-mails enviados aos compradores levam a marca da plataforma (`true`) ou o domínio próprio da empresa (`false`, marca branca)."},"softdescriptor":{"type":"string","nullable":true,"description":"O que aparece na fatura do cartão do comprador; `null` até o passo 4."},"corporateOpenDate":{"type":"string","nullable":true,"description":"Data de abertura da empresa (`YYYY-MM-DD`); `null` quando desconhecida; omitida nas leituras do lojista."},"legalBusinessName":{"type":"string","nullable":true,"description":"Razão social; `null` para pessoa física (CPF)."},"legalRepresentative":{"type":"object","nullable":true,"required":["firstName","lastName","document","birthYear","birthDate","redacted"],"properties":{"document":{"type":"string","nullable":true,"description":"CPF, mascarado a menos que revelado."},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"redacted":{"type":"boolean","description":"Se os campos estão mascarados."},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando mascarada."},"birthYear":{"type":"integer","nullable":true,"description":"Ano de nascimento."},"firstName":{"type":"string","nullable":true,"description":"Nome."}},"description":"O representante legal vigente; `null` quando a empresa não tem; omitido nas leituras do lojista.","additionalProperties":false},"paymentGroupsBlocked":{"type":"boolean","description":"Se os pagamentos combinados (dois cartões, cartão + Pix) estão bloqueados para esta empresa; omitido nas leituras do lojista."},"monthlyBillingEstimate":{"type":"string","nullable":true,"description":"Volume mensal de vendas esperado, em centavos (como texto); `null` até o passo 6."}},"description":"A empresa depois do passo.","additionalProperties":false}},"additionalProperties":false},"example":{"wallet":{"id":"wall_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"pixKey":"string","enabled":true,"primary":true,"bankCode":"string","bankName":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","updatedAt":"string","holderName":"JOAO SILVA","accountType":"string","accountNumber":"string","routingNumber":"string"},"company":{"id":"bus_0a1b2c3d4e5f60718293","mcc":"string","logo":"string","name":"Acme Ltda","email":"buyer@example.com","_links":{"self":"string","onboarding":"string"},"status":"string","country":"string","revenue":0,"website":"string","document":"string","referrer":"string","cellphone":"string","createdAt":"string","updatedAt":"string","onboarding":{"overview":{},"checklist":{},"inviteCode":"string","completedAt":"string","currentStep":"string","isCompleted":true,"onboardingId":"cob_0a1b2c3d4e5f60718293","referralSource":"string"},"description":"string","reviewDueAt":"string","documentType":"string","corporateCnae":"string","platformBrand":true,"softdescriptor":"string","corporateOpenDate":"string","legalBusinessName":"string","legalRepresentative":{"document":"string","lastName":"Silva","redacted":true,"birthDate":"1990-05-20","birthYear":0,"firstName":"João"},"paymentGroupsBlocked":true,"monthlyBillingEstimate":"string"}}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"submitKycStep5","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bankCode","accountNumber","routingNumber"],"properties":{"bankCode":{"type":"string","pattern":"^\\d+$","maxLength":10,"minLength":1,"description":"Código do banco (COMPE), só dígitos."},"accountNumber":{"type":"string","maxLength":50,"minLength":5,"description":"Número da conta, com o dígito verificador."},"routingNumber":{"type":"string","maxLength":50,"minLength":4,"description":"Agência."}},"additionalProperties":false},"example":{"bankCode":"id_0a1b2c3d4e5f60718293","accountNumber":"string","routingNumber":"string"}}},"required":true}}},"/v1/marketplace/kyc/{token}/onboarding/step-6":{"post":{"tags":["Marketplace"],"summary":"Envia o passo 6 do cadastro (conclusão) pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","logo","legalBusinessName","email","cellphone","document","documentType","country","website","description","referrer","revenue","monthlyBillingEstimate","softdescriptor","platformBrand","mcc","status","createdAt","updatedAt","onboarding","_links"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"mcc":{"type":"string","nullable":true,"description":"Código de categoria do estabelecimento (MCC); `null` até ser definido."},"logo":{"type":"string","nullable":true,"description":"URL do logotipo; `null` quando nenhum foi enviado."},"name":{"type":"string","description":"Nome fantasia da empresa (o que os compradores veem)."},"email":{"type":"string","nullable":true,"description":"E-mail de contato da empresa; `null` até o passo 4."},"_links":{"type":"object","required":["self","onboarding"],"properties":{"self":{"type":"string","description":"URL desta empresa."},"onboarding":{"type":"string","description":"URL da visão do onboarding."}},"description":"Links para esta empresa e para o onboarding dela.","additionalProperties":false},"status":{"type":"string","nullable":true,"description":"Status da conta (`pending`, `analyzing`, `active`, `suspended`…); `null` quando não definido."},"country":{"type":"string","nullable":true,"description":"Código do país (ISO 3166-1); `null` até o passo 1."},"revenue":{"type":"number","nullable":true,"description":"Faturamento mensal declarado, em centavos; `null` até o passo 1."},"website":{"type":"string","nullable":true,"description":"URL do site; `null` quando não há."},"document":{"type":"string","nullable":true,"description":"CPF ou CNPJ, só dígitos; `null` até o passo 2."},"referrer":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."},"cellphone":{"type":"string","nullable":true,"description":"Telefone de contato, só dígitos; `null` até o passo 4."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"onboarding":{"type":"object","required":["onboardingId","currentStep","isCompleted","completedAt","inviteCode","referralSource","overview","checklist"],"properties":{"overview":{"type":"object","description":"O que cada passo registrou (campos sensíveis mascarados).","additionalProperties":{}},"checklist":{"type":"object","description":"Quais passos foram concluídos (`checkListStep1Complete`…`checkListStep6Complete`).","additionalProperties":{}},"inviteCode":{"type":"string","nullable":true,"description":"O código de convite resgatado no passo 1; `null` quando não há."},"completedAt":{"type":"string","nullable":true,"description":"Quando o onboarding foi concluído (ISO 8601); `null` até lá."},"currentStep":{"type":"string","description":"O passo em que o onboarding está (`1` a `6`)."},"isCompleted":{"type":"boolean","description":"Se todos os passos foram concluídos."},"onboardingId":{"type":"string","pattern":"^(cob|onb)_.+$","nullable":true,"description":"Identificador público (cob_/onb_…)"},"referralSource":{"type":"string","nullable":true,"description":"Como a empresa conheceu a plataforma; `null` quando não informado."}},"description":"Andamento do onboarding.","additionalProperties":false},"description":{"type":"string","nullable":true,"description":"O que a empresa vende, nas palavras dela; `null` até o passo 6."},"reviewDueAt":{"type":"string","nullable":true,"description":"Até quando a análise de KYC responde (ISO 8601); `null` quando a conta não está em análise ou não tem prazo. Só nas leituras."},"documentType":{"type":"string","nullable":true,"description":"`cpf` ou `cnpj`; `null` até o passo 1."},"corporateCnae":{"type":"string","nullable":true,"description":"CNAE principal da empresa; `null` quando desconhecido; omitido nas leituras do lojista."},"platformBrand":{"type":"boolean","description":"Se os links dos e-mails enviados aos compradores levam a marca da plataforma (`true`) ou o domínio próprio da empresa (`false`, marca branca)."},"softdescriptor":{"type":"string","nullable":true,"description":"O que aparece na fatura do cartão do comprador; `null` até o passo 4."},"corporateOpenDate":{"type":"string","nullable":true,"description":"Data de abertura da empresa (`YYYY-MM-DD`); `null` quando desconhecida; omitida nas leituras do lojista."},"legalBusinessName":{"type":"string","nullable":true,"description":"Razão social; `null` para pessoa física (CPF)."},"legalRepresentative":{"type":"object","nullable":true,"required":["firstName","lastName","document","birthYear","birthDate","redacted"],"properties":{"document":{"type":"string","nullable":true,"description":"CPF, mascarado a menos que revelado."},"lastName":{"type":"string","nullable":true,"description":"Sobrenome."},"redacted":{"type":"boolean","description":"Se os campos estão mascarados."},"birthDate":{"type":"string","nullable":true,"description":"Data de nascimento (`YYYY-MM-DD`); `null` quando mascarada."},"birthYear":{"type":"integer","nullable":true,"description":"Ano de nascimento."},"firstName":{"type":"string","nullable":true,"description":"Nome."}},"description":"O representante legal vigente; `null` quando a empresa não tem; omitido nas leituras do lojista.","additionalProperties":false},"paymentGroupsBlocked":{"type":"boolean","description":"Se os pagamentos combinados (dois cartões, cartão + Pix) estão bloqueados para esta empresa; omitido nas leituras do lojista."},"monthlyBillingEstimate":{"type":"string","nullable":true,"description":"Volume mensal de vendas esperado, em centavos (como texto); `null` até o passo 6."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","mcc":"string","logo":"string","name":"Acme Ltda","email":"buyer@example.com","_links":{"self":"string","onboarding":"string"},"status":"string","country":"string","revenue":0,"website":"string","document":"string","referrer":"string","cellphone":"string","createdAt":"string","updatedAt":"string","onboarding":{"overview":{},"checklist":{},"inviteCode":"string","completedAt":"string","currentStep":"string","isCompleted":true,"onboardingId":"cob_0a1b2c3d4e5f60718293","referralSource":"string"},"description":"string","reviewDueAt":"string","documentType":"string","corporateCnae":"string","platformBrand":true,"softdescriptor":"string","corporateOpenDate":"string","legalBusinessName":"string","legalRepresentative":{"document":"string","lastName":"Silva","redacted":true,"birthDate":"1990-05-20","birthYear":0,"firstName":"João"},"paymentGroupsBlocked":true,"monthlyBillingEstimate":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"submitKycStep6","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["category","description","monthlyBillingEstimate"],"properties":{"website":{"type":"string","format":"uri","description":"URL absoluta."},"category":{"type":"string","maxLength":50,"minLength":1,"description":"Categoria do negócio."},"referrer":{"type":"string","maxLength":50,"description":"Como a empresa conheceu a plataforma."},"inviteCode":{"type":"string","maxLength":20,"description":"Código de indicação, se houver."},"description":{"type":"string","maxLength":200,"minLength":1,"description":"O que a empresa vende."},"monthlyBillingEstimate":{"type":"integer","minimum":5000,"description":"Volume mensal de vendas esperado, em centavos (mínimo 5000)."}},"additionalProperties":false},"example":{"website":"https://example.com","category":"string","referrer":"string","inviteCode":"string","description":"string","monthlyBillingEstimate":5000}}},"required":true}}},"/v1/marketplace/sub-accounts/{companyId}/plan":{"put":{"tags":["Marketplace"],"summary":"Atribui um plano de taxas a uma sub-conta","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","planId"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"A sub-conta."},"planId":{"type":"string","pattern":"^(rate)_.+$","nullable":true,"description":"O plano de taxas agora atribuído; `null` quando nenhum."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","planId":"rate_0a1b2c3d4e5f60718293"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"assignSubAccountPlan","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["planId"],"properties":{"planId":{"type":"string","pattern":"^(rate)_.+$","nullable":true,"description":"O plano de taxas a atribuir; `null` remove o plano."}},"additionalProperties":false},"example":{"planId":"rate_0a1b2c3d4e5f60718293"}}},"required":true},"x-account-level":"always"}},"/v1/products/{productId}/variants/{variantId}":{"get":{"tags":["Products - Variants"],"summary":"Consulta uma variante de produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"example":{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"in":"path","name":"variantId","schema":{"type":"string","pattern":"^(var|prv)_.+$"},"required":true,"description":"Identificador público (var_/prv_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getProductVariant"},"put":{"tags":["Products - Variants"],"summary":"Atualiza uma variante de produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"example":{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"in":"path","name":"variantId","schema":{"type":"string","pattern":"^(var|prv)_.+$"},"required":true,"description":"Identificador público (var_/prv_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateProductVariant__put","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string","maxLength":50,"description":"O seu SKU."},"name":{"type":"string","maxLength":255,"minLength":1,"description":"Nome da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","pattern":"^\\d{9}$","description":"Código NBS, 9 dígitos (serviço)."},"ncm":{"type":"string","pattern":"^\\d{8}$","description":"Código NCM, 8 dígitos (mercadoria)."},"cest":{"type":"string","pattern":"^\\d{7}$","description":"Código CEST, 7 dígitos (mercadoria com substituição tributária)."},"gtin":{"type":"string","pattern":"^(\\d{8}|\\d{12,14})$","description":"GTIN/EAN — 8, 12, 13 ou 14 dígitos."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` emite NFS-e, `goods` emite NF-e. Omitido: um produto `physical` é mercadoria, os outros são serviço."},"unit":{"type":"string","maxLength":6,"minLength":1,"description":"Unidade comercial (UN, KG, CX…)."},"origin":{"type":"integer","maximum":8,"minimum":0,"description":"Origem da mercadoria (tabela A do ICMS, 0 a 8; 0 = nacional)."},"cClassTrib":{"type":"string","pattern":"^\\d{6}$","description":"Classificação tributária do IBS/CBS (cClassTrib, 6 dígitos)."},"serviceCode":{"type":"string","pattern":"^\\d{1,2}\\.?\\d{2}$","description":"Item da lista de serviços da LC 116 (`01.07` ou `0107`)."},"cityServiceCode":{"type":"string","maxLength":20,"minLength":1,"description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` limpa.","additionalProperties":false},"images":{"type":"array","items":{"type":"string","format":"uri","description":"URL absoluta."},"maxItems":1,"description":"URLs de imagem. Para anexar um arquivo, envie-o antes (`POST /v1/assets/uploads` e depois a confirmação) e mande a URL do arquivo."},"enabled":{"type":"boolean","default":true,"description":"Se a variante está à venda."},"pricing":{"type":"object","properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"type":"array","items":{"type":"object","required":["unitPrice"],"properties":{"upTo":{"type":"integer","maximum":1000000000,"minimum":1,"nullable":true,"description":"Limite superior da faixa (unidades); `null` = sem limite (a última faixa)."},"flatPrice":{"type":"integer","maximum":200000000,"minimum":0,"nullable":true,"description":"Valor fixo somado quando a faixa é atingida, em centavos."},"unitPrice":{"type":"integer","maximum":200000000,"minimum":0,"description":"Preço unitário dentro da faixa, em centavos."}},"additionalProperties":false},"maxItems":50,"description":"As faixas de preço (`schema=tiered`), em ordem crescente de `upTo`."},"cycles":{"type":"integer","maximum":999,"minimum":1,"nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit` (preço × quantidade), `tiered` (por faixas de quantidade) ou `package` (por bloco de unidades)."},"currency":{"type":"string","description":"Código de moeda ISO 4217"},"oldPrice":{"type":"integer","maximum":200000000,"minimum":1,"description":"O preço antes de um desconto, em centavos — mostrado riscado."},"daysTrial":{"type":"integer","maximum":365,"minimum":1,"description":"Duração do período de teste de um plano recorrente, em dias."},"tiersMode":{"enum":["graduated","volume"],"type":"string","description":"`graduated`: cada faixa precifica as próprias unidades; `volume`: a faixa atingida precifica todas as unidades."},"unitPrice":{"type":"integer","maximum":200000000,"minimum":1,"description":"Preço unitário, em centavos (mínimo 500 em `unit`; não usado em `tiered`)."},"usageType":{"enum":["licensed","metered"],"type":"string","description":"`licensed` (quantidade fixa) ou `metered` (cobrado pelo uso que você reporta)."},"billingType":{"enum":["prepaid","postpaid","exactday"],"type":"string","description":"Quando um ciclo é cobrado: `prepaid` (no início), `postpaid` (no fim) ou `exactday` (em `billingExactDay`)."},"costPerItem":{"type":"integer","maximum":200000000,"minimum":0,"description":"O seu custo por unidade, em centavos (para os seus relatórios de margem)."},"trialInterval":{"enum":["day","week","month","year"],"type":"string","description":"Unidade da duração do teste."},"meterEventName":{"type":"string","maxLength":64,"minLength":1,"description":"Nome do medidor de uso que você reporta (só `metered`)."},"billingExactDay":{"type":"integer","maximum":31,"minimum":1,"description":"Dia do mês em que o ciclo é cobrado (`billingType=exactday`)."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: cobrar o frete cotado no checkout em CADA renovação (padrão `true`)."},"billingFrequency":{"enum":["daily","weekly","monthly","yearly"],"type":"string","description":"Unidade do intervalo de cobrança."},"usageAggregation":{"enum":["sum","max","lastDuringPeriod","lastEver"],"type":"string","description":"Como os registros de uso de um ciclo são agregados: `sum`, `max`, `lastDuringPeriod` ou `lastEver`."},"transformQuantity":{"type":"object","required":["divideBy"],"properties":{"round":{"enum":["up","down"],"type":"string","default":"up","description":"Como um bloco parcial é arredondado."},"divideBy":{"type":"integer","maximum":1000000000,"minimum":1,"description":"Unidades por bloco."}},"description":"Em `schema=package`: quantas unidades formam um bloco, e como um bloco parcial é arredondado.","additionalProperties":false},"trialIntervalCount":{"type":"integer","maximum":365,"minimum":1,"description":"Duração do teste, em unidades de `trialInterval`."},"billingFrequencyCount":{"type":"integer","maximum":999,"minimum":1,"description":"Quantas unidades de `billingFrequency` por ciclo."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: estender o desconto do meio de pagamento do checkout às renovações cobradas pelo mesmo meio (padrão `false`)."}},"description":"Preço e modelo de cobrança da variante; só os campos enviados mudam.","additionalProperties":false},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"attributes":{"type":"object","description":"Atributos livres da variante (tamanho, cor…).","additionalProperties":{}},"description":{"type":"string","maxLength":255,"description":"Descrição."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador da variante."}},"additionalProperties":false},"example":{"sku":"string","name":"Acme Ltda","fiscal":{"nbs":"id_0a1b2c3d4e5f60718293","ncm":"id_0a1b2c3d4e5f60718293","cest":"id_0a1b2c3d4e5f60718293","gtin":"id_0a1b2c3d4e5f60718293","kind":"service","unit":"string","origin":0,"cClassTrib":"id_0a1b2c3d4e5f60718293","serviceCode":"id_0a1b2c3d4e5f60718293","cityServiceCode":"string"},"images":["https://example.com"],"enabled":true,"pricing":{"type":"oneTime","tiers":[{"upTo":1,"flatPrice":5000,"unitPrice":5000}],"cycles":1,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":1,"tiersMode":"graduated","unitPrice":5000,"usageType":"licensed","billingType":"prepaid","costPerItem":0,"trialInterval":"day","meterEventName":"string","billingExactDay":1,"renewalShipping":true,"billingFrequency":"daily","usageAggregation":"sum","transformQuantity":{"round":"up","divideBy":1},"trialIntervalCount":1,"billingFrequencyCount":1,"renewalMethodDiscount":true},"metadata":{},"attributes":{},"description":"string","externalReference":"string"}}},"required":true}},"patch":{"tags":["Products - Variants"],"summary":"Atualiza uma variante de produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","productId","name","slug","description","sku","primary","enabled","pricing","images","metadata","attributes","externalReference","checkoutUrl","fiscal","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Identificador público (var_/prv_…)"},"sku":{"type":"string","nullable":true,"description":"O seu SKU; `null` quando não há."},"name":{"type":"string","nullable":true,"description":"Nome da variante."},"slug":{"type":"string","nullable":true,"description":"Slug da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","description":"Código NBS (serviço)."},"ncm":{"type":"string","description":"Código NCM (mercadoria)."},"cest":{"type":"string","description":"Código CEST (mercadoria)."},"gtin":{"type":"string","description":"GTIN/EAN."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` (NFS-e) ou `goods` (NF-e)."},"unit":{"type":"string","description":"Unidade comercial."},"origin":{"type":"integer","description":"Origem da mercadoria (0 a 8)."},"cClassTrib":{"type":"string","description":"Classificação tributária do IBS/CBS."},"serviceCode":{"type":"string","description":"Item da lista de serviços da LC 116."},"cityServiceCode":{"type":"string","description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` = nada.","additionalProperties":false},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"URLs das imagens; `null` quando não há."},"enabled":{"type":"boolean","description":"Se a variante está à venda."},"pricing":{"type":"object","required":["oldPrice","unitPrice","costPerItem","currency","schema","type","daysTrial","billingType","billingFrequency","billingFrequencyCount","billingExactDay","cycles","trialInterval","trialIntervalCount","tiersMode","usageType","usageAggregation","meterEventName","renewalShipping","renewalMethodDiscount"],"properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"nullable":true,"description":"As faixas de preço; `null` fora de `tiered`."},"cycles":{"type":"integer","nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit`, `tiered` ou `package`."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"oldPrice":{"type":"integer","nullable":true,"description":"O preço antes de um desconto, em centavos; `null` quando não há."},"daysTrial":{"type":"integer","nullable":true,"description":"Duração do período de teste, em dias; `null` quando não há."},"tiersMode":{"type":"string","nullable":true,"description":"`graduated` ou `volume`; `null` fora de `tiered`."},"unitPrice":{"type":"integer","nullable":true,"description":"Preço unitário, em centavos; `null` em `tiered`."},"usageType":{"type":"string","description":"`licensed` ou `metered`."},"billingType":{"type":"string","nullable":true,"description":"Quando um ciclo é cobrado: `prepaid`, `postpaid` ou `exactday`; `null` em venda avulsa."},"costPerItem":{"type":"integer","nullable":true,"description":"O seu custo por unidade, em centavos; `null` quando não definido."},"trialInterval":{"type":"string","nullable":true,"description":"Unidade da duração do teste; `null` quando não há."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor de uso; `null` fora de `metered`."},"billingExactDay":{"type":"integer","nullable":true,"description":"Dia do mês em que o ciclo é cobrado; `null` quando não é fixo."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: se o frete cotado no checkout é cobrado em cada renovação."},"billingFrequency":{"type":"string","nullable":true,"description":"Unidade do intervalo de cobrança; `null` em venda avulsa."},"usageAggregation":{"type":"string","nullable":true,"description":"Como o uso é agregado; `null` fora de `metered`."},"transformQuantity":{"nullable":true,"description":"Unidades por bloco e arredondamento; `null` fora de `package`."},"trialIntervalCount":{"type":"integer","nullable":true,"description":"Duração do teste, em unidades de `trialInterval`; `null` quando não há."},"billingFrequencyCount":{"type":"integer","nullable":true,"description":"Quantas unidades por ciclo; `null` em venda avulsa."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: se o desconto do meio de pagamento do checkout se estende às renovações."}},"description":"Preço e modelo de cobrança da variante.","additionalProperties":false},"primary":{"type":"boolean","description":"Se é a variante principal do produto."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"productId":{"type":"string","pattern":"^(prd|pro)_.+$","description":"O produto a que a variante pertence."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"attributes":{"type":"object","nullable":true,"description":"Atributos livres da variante; `null` quando não há.","additionalProperties":{}},"checkoutUrl":{"type":"string","nullable":true,"description":"URL do checkout hospedado desta variante; `null` quando não há."},"description":{"type":"string","nullable":true,"description":"Descrição; `null` quando não há."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador da variante; `null` quando não há."}},"additionalProperties":false},"example":{"id":"var_0a1b2c3d4e5f60718293","sku":"string","name":"Acme Ltda","slug":"string","fiscal":{"nbs":"string","ncm":"string","cest":"string","gtin":"string","kind":"service","unit":"string","origin":0,"cClassTrib":"string","serviceCode":"string","cityServiceCode":"string"},"images":["string"],"enabled":true,"pricing":{"type":"oneTime","cycles":0,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":0,"tiersMode":"string","unitPrice":5000,"usageType":"string","billingType":"string","costPerItem":0,"trialInterval":"string","meterEventName":"string","billingExactDay":0,"renewalShipping":true,"billingFrequency":"string","usageAggregation":"string","trialIntervalCount":0,"billingFrequencyCount":0,"renewalMethodDiscount":true},"primary":true,"metadata":{},"createdAt":"string","productId":"prd_0a1b2c3d4e5f60718293","updatedAt":"string","attributes":{},"checkoutUrl":"string","description":"string","externalReference":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"in":"path","name":"variantId","schema":{"type":"string","pattern":"^(var|prv)_.+$"},"required":true,"description":"Identificador público (var_/prv_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateProductVariant","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sku":{"type":"string","maxLength":50,"description":"O seu SKU."},"name":{"type":"string","maxLength":255,"minLength":1,"description":"Nome da variante."},"fiscal":{"type":"object","nullable":true,"properties":{"nbs":{"type":"string","pattern":"^\\d{9}$","description":"Código NBS, 9 dígitos (serviço)."},"ncm":{"type":"string","pattern":"^\\d{8}$","description":"Código NCM, 8 dígitos (mercadoria)."},"cest":{"type":"string","pattern":"^\\d{7}$","description":"Código CEST, 7 dígitos (mercadoria com substituição tributária)."},"gtin":{"type":"string","pattern":"^(\\d{8}|\\d{12,14})$","description":"GTIN/EAN — 8, 12, 13 ou 14 dígitos."},"kind":{"enum":["service","goods"],"type":"string","description":"`service` emite NFS-e, `goods` emite NF-e. Omitido: um produto `physical` é mercadoria, os outros são serviço."},"unit":{"type":"string","maxLength":6,"minLength":1,"description":"Unidade comercial (UN, KG, CX…)."},"origin":{"type":"integer","maximum":8,"minimum":0,"description":"Origem da mercadoria (tabela A do ICMS, 0 a 8; 0 = nacional)."},"cClassTrib":{"type":"string","pattern":"^\\d{6}$","description":"Classificação tributária do IBS/CBS (cClassTrib, 6 dígitos)."},"serviceCode":{"type":"string","pattern":"^\\d{1,2}\\.?\\d{2}$","description":"Item da lista de serviços da LC 116 (`01.07` ou `0107`)."},"cityServiceCode":{"type":"string","maxLength":20,"minLength":1,"description":"Código do serviço na sua prefeitura."}},"description":"O que a variante muda no perfil fiscal do produto; `null` limpa.","additionalProperties":false},"images":{"type":"array","items":{"type":"string","format":"uri","description":"URL absoluta."},"maxItems":1,"description":"URLs de imagem. Para anexar um arquivo, envie-o antes (`POST /v1/assets/uploads` e depois a confirmação) e mande a URL do arquivo."},"enabled":{"type":"boolean","default":true,"description":"Se a variante está à venda."},"pricing":{"type":"object","properties":{"type":{"enum":["oneTime","recurring"],"type":"string","description":"`oneTime` (uma venda) ou `recurring` (um plano de assinatura)."},"tiers":{"type":"array","items":{"type":"object","required":["unitPrice"],"properties":{"upTo":{"type":"integer","maximum":1000000000,"minimum":1,"nullable":true,"description":"Limite superior da faixa (unidades); `null` = sem limite (a última faixa)."},"flatPrice":{"type":"integer","maximum":200000000,"minimum":0,"nullable":true,"description":"Valor fixo somado quando a faixa é atingida, em centavos."},"unitPrice":{"type":"integer","maximum":200000000,"minimum":0,"description":"Preço unitário dentro da faixa, em centavos."}},"additionalProperties":false},"maxItems":50,"description":"As faixas de preço (`schema=tiered`), em ordem crescente de `upTo`."},"cycles":{"type":"integer","maximum":999,"minimum":1,"nullable":true,"description":"Número de ciclos até a assinatura acabar; `null` = até ser cancelada."},"schema":{"enum":["unit","tiered","package"],"type":"string","description":"Como o preço é calculado: `unit` (preço × quantidade), `tiered` (por faixas de quantidade) ou `package` (por bloco de unidades)."},"currency":{"type":"string","description":"Código de moeda ISO 4217"},"oldPrice":{"type":"integer","maximum":200000000,"minimum":1,"description":"O preço antes de um desconto, em centavos — mostrado riscado."},"daysTrial":{"type":"integer","maximum":365,"minimum":1,"description":"Duração do período de teste de um plano recorrente, em dias."},"tiersMode":{"enum":["graduated","volume"],"type":"string","description":"`graduated`: cada faixa precifica as próprias unidades; `volume`: a faixa atingida precifica todas as unidades."},"unitPrice":{"type":"integer","maximum":200000000,"minimum":1,"description":"Preço unitário, em centavos (mínimo 500 em `unit`; não usado em `tiered`)."},"usageType":{"enum":["licensed","metered"],"type":"string","description":"`licensed` (quantidade fixa) ou `metered` (cobrado pelo uso que você reporta)."},"billingType":{"enum":["prepaid","postpaid","exactday"],"type":"string","description":"Quando um ciclo é cobrado: `prepaid` (no início), `postpaid` (no fim) ou `exactday` (em `billingExactDay`)."},"costPerItem":{"type":"integer","maximum":200000000,"minimum":0,"description":"O seu custo por unidade, em centavos (para os seus relatórios de margem)."},"trialInterval":{"enum":["day","week","month","year"],"type":"string","description":"Unidade da duração do teste."},"meterEventName":{"type":"string","maxLength":64,"minLength":1,"description":"Nome do medidor de uso que você reporta (só `metered`)."},"billingExactDay":{"type":"integer","maximum":31,"minimum":1,"description":"Dia do mês em que o ciclo é cobrado (`billingType=exactday`)."},"renewalShipping":{"type":"boolean","description":"Planos recorrentes: cobrar o frete cotado no checkout em CADA renovação (padrão `true`)."},"billingFrequency":{"enum":["daily","weekly","monthly","yearly"],"type":"string","description":"Unidade do intervalo de cobrança."},"usageAggregation":{"enum":["sum","max","lastDuringPeriod","lastEver"],"type":"string","description":"Como os registros de uso de um ciclo são agregados: `sum`, `max`, `lastDuringPeriod` ou `lastEver`."},"transformQuantity":{"type":"object","required":["divideBy"],"properties":{"round":{"enum":["up","down"],"type":"string","default":"up","description":"Como um bloco parcial é arredondado."},"divideBy":{"type":"integer","maximum":1000000000,"minimum":1,"description":"Unidades por bloco."}},"description":"Em `schema=package`: quantas unidades formam um bloco, e como um bloco parcial é arredondado.","additionalProperties":false},"trialIntervalCount":{"type":"integer","maximum":365,"minimum":1,"description":"Duração do teste, em unidades de `trialInterval`."},"billingFrequencyCount":{"type":"integer","maximum":999,"minimum":1,"description":"Quantas unidades de `billingFrequency` por ciclo."},"renewalMethodDiscount":{"type":"boolean","description":"Planos recorrentes: estender o desconto do meio de pagamento do checkout às renovações cobradas pelo mesmo meio (padrão `false`)."}},"description":"Preço e modelo de cobrança da variante; só os campos enviados mudam.","additionalProperties":false},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"attributes":{"type":"object","description":"Atributos livres da variante (tamanho, cor…).","additionalProperties":{}},"description":{"type":"string","maxLength":255,"description":"Descrição."},"externalReference":{"type":"string","maxLength":255,"description":"O seu próprio identificador da variante."}},"additionalProperties":false},"example":{"sku":"string","name":"Acme Ltda","fiscal":{"nbs":"id_0a1b2c3d4e5f60718293","ncm":"id_0a1b2c3d4e5f60718293","cest":"id_0a1b2c3d4e5f60718293","gtin":"id_0a1b2c3d4e5f60718293","kind":"service","unit":"string","origin":0,"cClassTrib":"id_0a1b2c3d4e5f60718293","serviceCode":"id_0a1b2c3d4e5f60718293","cityServiceCode":"string"},"images":["https://example.com"],"enabled":true,"pricing":{"type":"oneTime","tiers":[{"upTo":1,"flatPrice":5000,"unitPrice":5000}],"cycles":1,"schema":"unit","currency":"BRL","oldPrice":5000,"daysTrial":1,"tiersMode":"graduated","unitPrice":5000,"usageType":"licensed","billingType":"prepaid","costPerItem":0,"trialInterval":"day","meterEventName":"string","billingExactDay":1,"renewalShipping":true,"billingFrequency":"daily","usageAggregation":"sum","transformQuantity":{"round":"up","divideBy":1},"trialIntervalCount":1,"billingFrequencyCount":1,"renewalMethodDiscount":true},"metadata":{},"attributes":{},"description":"string","externalReference":"string"}}},"required":true}},"delete":{"tags":["Products - Variants"],"summary":"Exclui uma variante de produto","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","pattern":"^(var|prv)_.+$","description":"Id público do recurso excluído."},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"resource":{"enum":["variant"],"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"var_0a1b2c3d4e5f60718293","deleted":true,"resource":"variant"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"productId","schema":{"type":"string","pattern":"^(prd|pro)_.+$"},"required":true,"description":"Identificador público (prd_/pro_…)"},{"in":"path","name":"variantId","schema":{"type":"string","pattern":"^(var|prv)_.+$"},"required":true,"description":"Identificador público (var_/prv_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"deleteProductVariant"}},"/v1/subscriptions/{subscriptionId}/thresholds":{"get":{"tags":["Subscriptions"],"summary":"Lista os limiares de cobrança","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["offset","limit","total","page","hasMore","data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","kind","value","enabled","itemId","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(sbt)_.+$","description":"Identificador público (sbt_…)"},"kind":{"enum":["amount","quantity"],"type":"string","description":"O que é medido: `amount` (centavos) ou `quantity` (unidades)."},"value":{"type":"integer","description":"O limiar que dispara uma cobrança."},"itemId":{"type":"string","pattern":"^(sit|item)_.+$","nullable":true,"description":"O item; `null` = a assinatura inteira."},"enabled":{"type":"boolean","description":"Se o limiar está ativo."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."}},"additionalProperties":false},"description":"Os itens desta página."},"page":{"type":"object","required":["offset","current","total"],"properties":{"total":{"type":"integer","description":"Número total de páginas."},"offset":{"type":"object","required":["first","prev","next","last"],"properties":{"last":{"type":"integer","description":"Posição da última página."},"next":{"type":"integer","description":"Posição da próxima página (fica nesta quando ela é a última)."},"prev":{"type":"integer","description":"Posição da página anterior (0 na primeira)."},"first":{"type":"integer","description":"Posição da primeira página."}},"description":"O `offset` para pedir a primeira, a anterior, a próxima e a última página.","additionalProperties":false},"current":{"type":"integer","description":"Número da página atual (a primeira é 1)."}},"description":"Cursores de paginação da lista.","additionalProperties":false},"limit":{"type":"integer","description":"Tamanho da página, como pedido."},"total":{"type":"integer","description":"Número total de itens que atendem aos filtros."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"offset":{"type":"integer","description":"Posição do primeiro item desta página, como pedido."},"hasMore":{"type":"boolean","description":"`true` quando há mais itens depois desta página."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false}},"additionalProperties":false},"example":{"data":[{"id":"sbt_0a1b2c3d4e5f60718293","kind":"amount","value":5000,"itemId":"sit_0a1b2c3d4e5f60718293","enabled":true,"createdAt":"string","updatedAt":"string"}],"page":{"total":5000,"offset":{"last":0,"next":0,"prev":0,"first":0},"current":0},"limit":0,"total":5000,"_links":{},"offset":0,"hasMore":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":20,"maximum":100,"minimum":1},"required":false,"description":"Tamanho da página (itens por página)."},{"in":"query","name":"offset","schema":{"type":"integer","default":0,"minimum":0},"required":false,"description":"Posição do primeiro item (a partir de 0)."},{"in":"query","name":"sort","schema":{"type":"string"},"required":false,"description":"Expressão de ordenação, ex.: \"-createdAt\""},{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"listSubscriptionThresholds"},"post":{"tags":["Subscriptions"],"summary":"Adiciona um limiar de cobrança","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","subscriptionId","itemId","kind","value","enabled"],"properties":{"id":{"type":"string","pattern":"^(sbt)_.+$","description":"Identificador público (sbt_…)"},"kind":{"enum":["amount","quantity"],"type":"string","description":"O que é medido: `amount` (centavos) ou `quantity` (unidades)."},"value":{"type":"integer","description":"O limiar que dispara uma cobrança."},"itemId":{"type":"string","pattern":"^(sit|item)_.+$","nullable":true,"description":"O item; `null` = a assinatura inteira."},"enabled":{"type":"boolean","description":"Se o limiar está ativo."},"subscriptionId":{"type":"string","pattern":"^(subs|sub)_.+$","description":"A assinatura."}},"additionalProperties":false},"example":{"id":"sbt_0a1b2c3d4e5f60718293","kind":"amount","value":5000,"itemId":"sit_0a1b2c3d4e5f60718293","enabled":true,"subscriptionId":"subs_0a1b2c3d4e5f60718293"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"addSubscriptionThreshold","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["kind","value"],"properties":{"kind":{"enum":["amount","quantity"],"type":"string","description":"O que é medido: o `amount` em centavos, ou a `quantity` de uso."},"value":{"type":"integer","maximum":200000000,"minimum":1,"description":"O limiar que dispara uma cobrança (centavos ou unidades, conforme `kind`)."},"itemId":{"type":"string","pattern":"^(sit|item)_.+$","description":"Só este item; omitido = a assinatura inteira."},"enabled":{"type":"boolean","description":"Se o limiar está ativo (padrão `true`)."}},"additionalProperties":false},"example":{"kind":"amount","value":5000,"itemId":"sit_0a1b2c3d4e5f60718293","enabled":true}}},"required":true}}},"/v1/checkouts/payment-links/{paymentLinkId}/test":{"post":{"tags":["Checkout"],"summary":"Cria (ou renova) o link de teste em sandbox de um link de pagamento de produção","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["resource","liveLinkId","created","link","items","warnings"],"properties":{"link":{"type":"object","required":["id","name","type","enabled","accessId","signature","accessFullUrl","sessionId","editable","items","discounts","customInputs","expiresAt","availableAt","templateId","integrationId","domainId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(link)_.+$","description":"Identificador público (link_…)"},"name":{"type":"string","description":"Nome do link."},"type":{"type":"string","nullable":true,"description":"Tipo do link (histórico; sempre o tipo persistido)."},"items":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"O carrinho fixo do link."},"enabled":{"type":"boolean","description":"Se o link abre."},"accessId":{"type":"string","description":"O id público de acesso na URL."},"domainId":{"type":"string","nullable":true,"description":"O host em que a URL é montada; `null` = a escolha automática."},"editable":{"type":"boolean","description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Códigos de cupom aplicados quando o link abre; `null` quando não há."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o link deixa de abrir; `null` = nunca."},"sessionId":{"type":"string","nullable":true,"description":"A sessão de checkout ligada ao link, quando há."},"signature":{"type":"string","description":"A assinatura da URL."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"templateId":{"type":"string","nullable":true,"description":"O template de checkout; `null` = o checkout padrão."},"availableAt":{"type":"string","nullable":true,"description":"Quando o link passa a abrir; `null` = já abre."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"nullable":true,"description":"Campos extras que o checkout pede ao comprador; `null` quando não há."},"accessFullUrl":{"type":"string","nullable":true,"description":"A URL para compartilhar com os compradores."},"integrationId":{"type":"string","nullable":true,"description":"A integração a que uma venda pelo link pertence; `null` quando não há."}},"description":"O link de teste no sandbox.","additionalProperties":false},"items":{"type":"array","items":{"type":"object","required":["liveVariantId","variantId","productId","quantity","copiedNow"],"properties":{"quantity":{"type":"integer","description":"Quantidade."},"copiedNow":{"type":"boolean","description":"Se a cópia no sandbox foi criada por este teste."},"productId":{"type":"string","description":"O produto no sandbox da cópia."},"variantId":{"type":"string","pattern":"^(var|prv)_.+$","description":"A cópia dela no sandbox."},"liveVariantId":{"type":"string","pattern":"^(var|prv)_.+$","description":"A variante de produção."}},"description":"Uma linha do link de teste: a variante de produção e a cópia dela no sandbox.","additionalProperties":false},"description":"As linhas do link de teste."},"created":{"type":"boolean","description":"`true` no primeiro teste deste link; `false` quando o link de teste já existia e foi refeito (mesma URL)."},"resource":{"enum":["checkout-paymentLinkTest"],"type":"string","description":"Sempre `checkout-paymentLinkTest`."},"warnings":{"type":"array","items":{"type":"object","required":["code"],"properties":{"code":{"enum":["variantsNotOnSale","couponsNotInSandbox","templateNotCarried","integrationNotCarried"],"type":"string","description":"O que não passou: `variantsNotOnSale`, `couponsNotInSandbox`, `templateNotCarried` ou `integrationNotCarried`."},"values":{"type":"array","items":{"type":"string"},"description":"Os ids ou códigos afetados."}},"additionalProperties":false},"description":"O que não passou da produção para o link de teste."},"liveLinkId":{"type":"string","pattern":"^(link)_.+$","description":"O link de produção que este link de teste espelha."}},"additionalProperties":false},"example":{"link":{"id":"link_0a1b2c3d4e5f60718293","name":"Acme Ltda","type":"string","items":[{}],"enabled":true,"accessId":"string","domainId":"string","editable":true,"metadata":{},"createdAt":"string","discounts":[],"expiresAt":"string","sessionId":"string","signature":"string","updatedAt":"string","templateId":"string","availableAt":"string","customInputs":[{}],"accessFullUrl":"string","integrationId":"string"},"items":[{"quantity":0,"copiedNow":true,"productId":"string","variantId":"var_0a1b2c3d4e5f60718293","liveVariantId":"var_0a1b2c3d4e5f60718293"}],"created":true,"resource":"checkout-paymentLinkTest","warnings":[{"code":"variantsNotOnSale","values":["string"]}],"liveLinkId":"link_0a1b2c3d4e5f60718293"}}},"description":"Sucesso"},"201":{"content":{"application/json":{"schema":{"type":"object","required":["resource","liveLinkId","created","link","items","warnings"],"properties":{"link":{"type":"object","required":["id","name","type","enabled","accessId","signature","accessFullUrl","sessionId","editable","items","discounts","customInputs","expiresAt","availableAt","templateId","integrationId","domainId","metadata","createdAt","updatedAt"],"properties":{"id":{"type":"string","pattern":"^(link)_.+$","description":"Identificador público (link_…)"},"name":{"type":"string","description":"Nome do link."},"type":{"type":"string","nullable":true,"description":"Tipo do link (histórico; sempre o tipo persistido)."},"items":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"O carrinho fixo do link."},"enabled":{"type":"boolean","description":"Se o link abre."},"accessId":{"type":"string","description":"O id público de acesso na URL."},"domainId":{"type":"string","nullable":true,"description":"O host em que a URL é montada; `null` = a escolha automática."},"editable":{"type":"boolean","description":"Se o comprador pode mudar as quantidades."},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor; `null` quando não há.","additionalProperties":{}},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"discounts":{"type":"array","items":{},"nullable":true,"description":"Códigos de cupom aplicados quando o link abre; `null` quando não há."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o link deixa de abrir; `null` = nunca."},"sessionId":{"type":"string","nullable":true,"description":"A sessão de checkout ligada ao link, quando há."},"signature":{"type":"string","description":"A assinatura da URL."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"templateId":{"type":"string","nullable":true,"description":"O template de checkout; `null` = o checkout padrão."},"availableAt":{"type":"string","nullable":true,"description":"Quando o link passa a abrir; `null` = já abre."},"customInputs":{"type":"array","items":{"type":"object","additionalProperties":{}},"nullable":true,"description":"Campos extras que o checkout pede ao comprador; `null` quando não há."},"accessFullUrl":{"type":"string","nullable":true,"description":"A URL para compartilhar com os compradores."},"integrationId":{"type":"string","nullable":true,"description":"A integração a que uma venda pelo link pertence; `null` quando não há."}},"description":"O link de teste no sandbox.","additionalProperties":false},"items":{"type":"array","items":{"type":"object","required":["liveVariantId","variantId","productId","quantity","copiedNow"],"properties":{"quantity":{"type":"integer","description":"Quantidade."},"copiedNow":{"type":"boolean","description":"Se a cópia no sandbox foi criada por este teste."},"productId":{"type":"string","description":"O produto no sandbox da cópia."},"variantId":{"type":"string","pattern":"^(var|prv)_.+$","description":"A cópia dela no sandbox."},"liveVariantId":{"type":"string","pattern":"^(var|prv)_.+$","description":"A variante de produção."}},"description":"Uma linha do link de teste: a variante de produção e a cópia dela no sandbox.","additionalProperties":false},"description":"As linhas do link de teste."},"created":{"type":"boolean","description":"`true` no primeiro teste deste link; `false` quando o link de teste já existia e foi refeito (mesma URL)."},"resource":{"enum":["checkout-paymentLinkTest"],"type":"string","description":"Sempre `checkout-paymentLinkTest`."},"warnings":{"type":"array","items":{"type":"object","required":["code"],"properties":{"code":{"enum":["variantsNotOnSale","couponsNotInSandbox","templateNotCarried","integrationNotCarried"],"type":"string","description":"O que não passou: `variantsNotOnSale`, `couponsNotInSandbox`, `templateNotCarried` ou `integrationNotCarried`."},"values":{"type":"array","items":{"type":"string"},"description":"Os ids ou códigos afetados."}},"additionalProperties":false},"description":"O que não passou da produção para o link de teste."},"liveLinkId":{"type":"string","pattern":"^(link)_.+$","description":"O link de produção que este link de teste espelha."}},"additionalProperties":false},"example":{"link":{"id":"link_0a1b2c3d4e5f60718293","name":"Acme Ltda","type":"string","items":[{}],"enabled":true,"accessId":"string","domainId":"string","editable":true,"metadata":{},"createdAt":"string","discounts":[],"expiresAt":"string","sessionId":"string","signature":"string","updatedAt":"string","templateId":"string","availableAt":"string","customInputs":[{}],"accessFullUrl":"string","integrationId":"string"},"items":[{"quantity":0,"copiedNow":true,"productId":"string","variantId":"var_0a1b2c3d4e5f60718293","liveVariantId":"var_0a1b2c3d4e5f60718293"}],"created":true,"resource":"checkout-paymentLinkTest","warnings":[{"code":"variantsNotOnSale","values":["string"]}],"liveLinkId":"link_0a1b2c3d4e5f60718293"}}},"description":"Criado"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"paymentLinkId","schema":{"type":"string","pattern":"^(link)_.+$"},"required":true,"description":"Identificador público (link_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"testCheckoutPaymentLink"}},"/v1/marketplace/sub-accounts/{companyId}/suspend":{"post":{"tags":["Marketplace"],"summary":"Suspende uma sub-conta ativa (ela para de cobrar e de sacar)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","suspended"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"status":{"enum":["disabled"],"type":"string","description":"A sub-conta agora está `disabled`: para de cobrar e de sacar."},"suspended":{"enum":[true],"type":"boolean","description":"Sempre `true`."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","status":"disabled","suspended":true}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"suspendSubAccount","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","maxLength":500,"minLength":1,"description":"Por quê — fica no histórico da sub-conta; o vendedor recebe o aviso, não o texto."}},"additionalProperties":false},"example":{"reason":"string"}}},"required":true},"x-account-level":"always"}},"/v1/marketplace/sub-accounts/{companyId}/kyc-link":{"get":{"tags":["Marketplace"],"summary":"Consulta o status do link de credenciamento (KYC) de uma sub-conta","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["active","id","expiresAt"],"properties":{"id":{"type":"string","pattern":"^(kycl)_.+$","nullable":true,"description":"O link ativo; `null` quando não há."},"active":{"type":"boolean","description":"Se há um link ativo."},"expiresAt":{"type":"string","nullable":true,"description":"Quando expira; `null` quando não há."}},"additionalProperties":false},"example":{"id":"kycl_0a1b2c3d4e5f60718293","active":true,"expiresAt":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"getSubAccountKycLink"},"post":{"tags":["Marketplace"],"summary":"Gera (ou regenera) o link de credenciamento (KYC) de uma sub-conta","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","token","url","expiresAt","status"],"properties":{"id":{"type":"string","pattern":"^(kycl)_.+$","description":"Identificador público (kycl_…)"},"url":{"type":"string","description":"A URL de credenciamento para entregar ao vendedor (carrega o token)."},"token":{"type":"string","description":"O token secreto — mostrado UMA vez, aqui."},"status":{"enum":["active"],"type":"string","description":"Sempre `active` na geração."},"expiresAt":{"type":"string","description":"Quando o link expira."}},"additionalProperties":false},"example":{"id":"kycl_0a1b2c3d4e5f60718293","url":"string","token":"string","status":"active","expiresAt":"string"}}},"description":"Criado"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"createSubAccountKycLink","x-account-level":"always"},"delete":{"tags":["Marketplace"],"summary":"Revoga o link de credenciamento (KYC) de uma sub-conta","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","revoked"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"A sub-conta."},"revoked":{"enum":[true],"type":"boolean","description":"Sempre `true`: o link deixou de funcionar."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","revoked":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"revokeSubAccountKycLink","x-account-level":"always"}},"/v1/subscriptions/{subscriptionId}/items/{itemId}":{"get":{"tags":["Subscriptions"],"summary":"Consulta um item","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"example":{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"images":["string"],"enabled":true,"currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"itemId","schema":{"type":"string","pattern":"^(sit|item)_.+$"},"required":true,"description":"Identificador público (sit_/item_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getSubscriptionItem"},"put":{"tags":["Subscriptions"],"summary":"Atualiza a quantidade de um item","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"example":{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"images":["string"],"enabled":true,"currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"itemId","schema":{"type":"string","pattern":"^(sit|item)_.+$"},"required":true,"description":"Identificador público (sit_/item_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateSubscriptionItem__put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["quantity"],"properties":{"quantity":{"type":"integer","maximum":999999,"minimum":1,"description":"A nova quantidade — vale a partir do próximo ciclo."}},"additionalProperties":false},"example":{"quantity":1}}},"required":true}},"patch":{"tags":["Subscriptions"],"summary":"Atualiza a quantidade de um item","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","name","description","enabled","pricingSchema","unitPrice","quantity","currency","images","metadata","externalReference","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(sit|item)_.+$","description":"Identificador público (sit_/item_…)"},"name":{"type":"string","description":"Nome do item, vindo da variante."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"images":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":{}}]},"nullable":true,"description":"Imagens da variante; `null` quando não há."},"enabled":{"type":"boolean","description":"Se o item é cobrado nos próximos ciclos."},"currency":{"type":"string","description":"Moeda (ISO 4217)."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"metadata":{"type":"object","nullable":true,"description":"Os seus metadados chave-valor do item; `null` quando não há.","additionalProperties":{}},"quantity":{"type":"integer","description":"Quantidade."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"unitPrice":{"type":"integer","description":"Preço unitário congelado da variante, em centavos."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"description":{"type":"string","nullable":true,"description":"A sua nota sobre o item."},"pricingSchema":{"type":"string","description":"Esquema de preço da variante: `unit`, `tiered` ou `package`."},"externalReference":{"type":"string","nullable":true,"description":"O seu próprio identificador do item; `null` quando não há."}},"additionalProperties":false},"example":{"id":"sit_0a1b2c3d4e5f60718293","name":"Acme Ltda","_links":{},"images":["string"],"enabled":true,"currency":"BRL","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"metadata":{},"quantity":0,"createdAt":"string","unitPrice":5000,"updatedAt":"string","description":"string","pricingSchema":"string","externalReference":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"itemId","schema":{"type":"string","pattern":"^(sit|item)_.+$"},"required":true,"description":"Identificador público (sit_/item_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateSubscriptionItem","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["quantity"],"properties":{"quantity":{"type":"integer","maximum":999999,"minimum":1,"description":"A nova quantidade — vale a partir do próximo ciclo."}},"additionalProperties":false},"example":{"quantity":1}}},"required":true}},"delete":{"tags":["Subscriptions"],"summary":"Remove um item","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","resource","deleted"],"properties":{"id":{"type":"string","description":"Id público do recurso excluído."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"resource":{"type":"string","description":"Nome do recurso que foi excluído."}},"additionalProperties":false},"example":{"id":"string","_links":{},"deleted":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"resource":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"itemId","schema":{"type":"string","pattern":"^(sit|item)_.+$"},"required":true,"description":"Identificador público (sit_/item_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"removeSubscriptionItem"}},"/v1/checkouts/sessions/{sessionId}/telemetry-token":{"post":{"tags":["Checkout"],"summary":"Emite a credencial de telemetria da sessão para o front-end do checkout","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["object","id","token","expiresAt","endpoint","intervalMs","companyId"],"properties":{"id":{"type":"string","pattern":"^(sess|ckts|ses)_.+$","description":"Identificador público (sess_/ckts_/ses_…)"},"token":{"type":"string","description":"O token de capacidade que amarra os sinais a esta sessão."},"object":{"enum":["checkout.session.telemetryToken"],"type":"string","description":"Sempre `checkout.session.telemetryToken`."},"endpoint":{"type":"string","description":"Para onde fazer o `POST` dos sinais."},"companyId":{"type":"integer","description":"O `companyId` que o envelope de sinais exige (o mesmo que o token carrega)."},"expiresAt":{"type":"string","description":"Quando o token expira (ISO 8601): pare de enviar sinais depois disso."},"intervalMs":{"type":"integer","description":"Intervalo sugerido entre os sinais, em milissegundos."}},"additionalProperties":false},"example":{"id":"sess_0a1b2c3d4e5f60718293","token":"string","object":"checkout.session.telemetryToken","endpoint":"string","companyId":0,"expiresAt":"string","intervalMs":0}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"sessionId","schema":{"type":"string","pattern":"^(sess|ckts|ses)_.+$"},"required":true,"description":"Identificador público (sess_/ckts_/ses_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"createCheckoutTelemetryToken"}},"/v1/marketplace/sub-accounts/{companyId}/reinstate":{"post":{"tags":["Marketplace"],"summary":"Reativa uma sub-conta que a sua plataforma suspendeu","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","reinstated"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"status":{"enum":["active"],"type":"string","description":"A sub-conta está `active` de novo."},"reinstated":{"enum":[true],"type":"boolean","description":"Sempre `true`."}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","status":"active","reinstated":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"reinstateSubAccount","x-account-level":"always"}},"/v1/marketplace/sub-accounts/{companyId}/onboarding":{"get":{"tags":["Marketplace"],"summary":"Consulta o andamento do cadastro de uma sub-conta (passos, documentos, última mudança de status)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","reviewDueAt","onboarding","documents","lastStatusChange"],"properties":{"id":{"type":"string","pattern":"^(bus)_.+$","description":"Identificador público (bus_…)"},"status":{"type":"string","nullable":true,"description":"Status do cadastro: `pending`, `analyzing`, `awaiting-documents`, `active`, `disabled`…"},"documents":{"type":"object","required":["documentType","complete","requirements"],"properties":{"complete":{"type":"boolean","description":"Se todos os documentos exigidos foram aceitos."},"documentType":{"enum":["cpf","cnpj"],"type":"string","nullable":true,"description":"Se o vendedor se cadastra como pessoa (`cpf`) ou empresa (`cnpj`); `null` antes do passo 1."},"requirements":{"type":"array","items":{"type":"object","required":["key","subject","required","status","alternatives"],"properties":{"key":{"type":"string","description":"O que é exigido (ex.: `identity`, `proofOfAddress`)."},"status":{"type":"string","description":"Estado da exigência (`missing`, `pending`, `approved`, `rejected`…)."},"subject":{"enum":["holder","company"],"type":"string","description":"De quem é o documento: do `holder` (a pessoa) ou da `company`."},"required":{"type":"boolean","description":"Se é obrigatório."},"alternatives":{"type":"array","items":{"type":"object","required":["key","status","documents"],"properties":{"key":{"type":"string","description":"Tipo de documento que atende à exigência (ex.: `cnh`, `rg`)."},"status":{"type":"string","description":"Estado desta alternativa."},"documents":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Os documentos enviados para esta alternativa."}},"additionalProperties":false},"description":"Os tipos de documento que atendem à exigência — um basta."}},"additionalProperties":false},"description":"O que o passo 3 precisa entregar, e em que pé está cada exigência."}},"description":"Os documentos de KYC da sub-conta.","additionalProperties":false},"onboarding":{"type":"object","required":["currentStep","isCompleted","completedAt"],"properties":{"completedAt":{"type":"string","nullable":true,"description":"Quando o último passo foi enviado; `null` até lá."},"currentStep":{"type":"string","description":"O passo em que o cadastro está."},"isCompleted":{"type":"boolean","description":"Se todos os passos foram enviados."}},"description":"Andamento dos passos do cadastro.","additionalProperties":false},"reviewDueAt":{"type":"string","nullable":true,"description":"Até quando a análise responde; `null` fora de uma análise."},"lastStatusChange":{"type":"object","nullable":true,"required":["from","to","by","at"],"properties":{"at":{"type":"string","description":"Quando."},"by":{"enum":["staff","provider","seller","platform","system"],"type":"string","description":"Quem mudou: `staff` (Selectwin), `provider`, `seller`, `platform` (você) ou `system`."},"to":{"type":"string","nullable":true,"description":"O status novo."},"from":{"type":"string","nullable":true,"description":"O status anterior."}},"description":"A última mudança de status; `null` quando não há.","additionalProperties":false}},"additionalProperties":false},"example":{"id":"bus_0a1b2c3d4e5f60718293","status":"string","documents":{"complete":true,"documentType":"cpf","requirements":[{"key":"string","status":"string","subject":"holder","required":true,"alternatives":[{"key":"string","status":"string","documents":[{}]}]}]},"onboarding":{"completedAt":"string","currentStep":"string","isCompleted":true},"reviewDueAt":"string","lastStatusChange":{"at":"string","by":"staff","to":"string","from":"string"}}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"getSubAccountOnboarding"}},"/v1/subscriptions/{subscriptionId}/cycles/{cycleId}":{"get":{"tags":["Subscriptions"],"summary":"Consulta um ciclo de cobrança","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","cycle","status","startDate","endDate","dueDate","billedAt","updatedAt","createdAt","amount","transactionId","method","expectedAmount","attempts","nextAttemptAt","failure"],"properties":{"id":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"Identificador público (scy_/cycle_…)"},"cycle":{"type":"integer","description":"Número do ciclo (1 = o primeiro)."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"amount":{"type":"integer","nullable":true,"description":"Valor da última cobrança ligada ao ciclo, em centavos; `null` quando não há."},"method":{"type":"string","nullable":true,"description":"Meio de pagamento dessa cobrança; `null` quando não há."},"status":{"type":"string","description":"Status do ciclo: `scheduled`, `processing`, `paid`, `failed` ou `canceled`."},"dueDate":{"type":"string","description":"Quando o ciclo é cobrado (ou vence)."},"endDate":{"type":"string","nullable":true,"description":"Quando o ciclo termina; `null` enquanto aberto."},"failure":{"type":"object","nullable":true,"required":["stage","code","message","at"],"properties":{"at":{"type":"string","nullable":true,"description":"Quando falhou."},"code":{"type":"string","nullable":true,"description":"Código estável da falha (`noCard`, `noBillingAddress`, `unpriceableItems`, ou o código de recusa da cobrança)."},"stage":{"enum":["beforeCharge","charge"],"type":"string","description":"`beforeCharge`: a cobrança nunca foi tentada (sem cartão, boleto sem endereço, item sem preço); `charge`: o pagamento foi recusado."},"message":{"type":"string","nullable":true,"description":"A mensagem da recusa, quando a cobrança foi tentada."}},"description":"Por que o ciclo falhou; `null` quando não falhou, ou quando o motivo não foi registrado.","additionalProperties":false},"attempts":{"type":"integer","description":"Tentativas de cobrança até agora (o limite de retentativas é 5)."},"billedAt":{"type":"string","nullable":true,"description":"Quando o ciclo foi cobrado; `null` até lá."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"startDate":{"type":"string","description":"Quando o ciclo começa."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"nextAttemptAt":{"type":"string","nullable":true,"description":"Quando um ciclo falho é tentado de novo; `null` quando não será."},"transactionId":{"type":"string","nullable":true,"description":"A última cobrança ligada ao ciclo; `null` quando não há."},"expectedAmount":{"type":"integer","nullable":true,"description":"No ciclo em aberto: o que ele cobraria agora, em centavos; `null` nos outros, ou quando ainda não dá para saber."}},"additionalProperties":false},"example":{"id":"scy_0a1b2c3d4e5f60718293","cycle":0,"_links":{},"amount":5000,"method":"string","status":"string","dueDate":"string","endDate":"string","failure":{"at":"string","code":"string","stage":"beforeCharge","message":"string"},"attempts":0,"billedAt":"string","merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","startDate":"string","updatedAt":"string","nextAttemptAt":"string","transactionId":"string","expectedAmount":5000}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"cycleId","schema":{"type":"string","pattern":"^(scy|cycle)_.+$"},"required":true,"description":"Identificador público (scy_/cycle_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getSubscriptionCycle"}},"/v1/subscriptions/{subscriptionId}/splits/{splitId}":{"get":{"tags":["Subscriptions"],"summary":"Consulta um split","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"example":{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"_links":{},"liable":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"splitId","schema":{"type":"string","pattern":"^(ssp|split)_.+$"},"required":true,"description":"Identificador público (ssp_/split_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getSubscriptionSplit"},"put":{"tags":["Subscriptions"],"summary":"Atualiza um split","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"example":{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"_links":{},"liable":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"splitId","schema":{"type":"string","pattern":"^(ssp|split)_.+$"},"required":true,"description":"Identificador público (ssp_/split_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateSubscriptionSplit__put","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","maximum":999999.99,"minimum":0,"description":"O percentual (0–100) ou o valor fixo, conforme `type`."}},"additionalProperties":false},"example":{"type":"percentage","value":5000}}},"required":true}},"patch":{"tags":["Subscriptions"],"summary":"Atualiza um split","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"example":{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"_links":{},"liable":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"splitId","schema":{"type":"string","pattern":"^(ssp|split)_.+$"},"required":true,"description":"Identificador público (ssp_/split_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"updateSubscriptionSplit","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","value"],"properties":{"type":{"enum":["percentage","flat"],"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","maximum":999999.99,"minimum":0,"description":"O percentual (0–100) ou o valor fixo, conforme `type`."}},"additionalProperties":false},"example":{"type":"percentage","value":5000}}},"required":true}},"delete":{"tags":["Subscriptions"],"summary":"Remove um split","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["subscription","splits","totalPercentage","remainingPercentage","remainingAmount"],"properties":{"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"splits":{"type":"array","items":{"type":"object","required":["id","recipient","type","value","chargeProcessingFee","liable","updatedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(ssp|split)_.+$","description":"Identificador público (ssp_/split_…)"},"type":{"type":"string","description":"`percentage` ou `flat`."},"value":{"type":"number","description":"O percentual (0–100) ou o valor fixo, conforme `type`."},"_links":{"type":"object","description":"Links para operações relacionadas, por ação (`self`, `create`, `update`, `delete`, `list`…).","additionalProperties":{"type":"object","required":["href","method","description"],"properties":{"href":{"type":"string","description":"URL absoluta da operação."},"method":{"type":"string","description":"Método HTTP da operação."},"description":{"type":"string","description":"O que a operação faz."}},"description":"Um link para uma operação relacionada.","additionalProperties":false}},"liable":{"type":"boolean","description":"Se o recebedor arca com os chargebacks da fatia."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"recipient":{"type":"string","nullable":true,"description":"A conta que recebe a fatia."},"updatedAt":{"type":"string","description":"Quando o recurso foi atualizado pela última vez (ISO 8601, UTC)."},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor paga a taxa de processamento da fatia."}},"additionalProperties":false},"description":"Todos os splits da assinatura depois da mudança."},"merchant":{"type":"object","required":["name","merchantId","isSubAccount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome fantasia da conta dona do recurso."},"merchantId":{"type":"string","nullable":true,"description":"Id público da conta dona do recurso (`bus_…`)."},"isSubAccount":{"type":"boolean","description":"`true` quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace."}},"description":"A conta dona do recurso (o vendedor de registro).","additionalProperties":false},"subscription":{"type":"string","pattern":"^(subs|sub)_.+$","description":"A assinatura."},"remainingAmount":{"type":"string","description":"O que sobra do valor recorrente depois das fatias fixas, em centavos (como texto)."},"totalPercentage":{"type":"number","description":"Soma das fatias percentuais."},"remainingPercentage":{"type":"number","description":"O que sobra de 100% depois das fatias percentuais."}},"additionalProperties":false},"example":{"_links":{},"splits":[{"id":"ssp_0a1b2c3d4e5f60718293","type":"string","value":5000,"_links":{},"liable":true,"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"createdAt":"string","recipient":"string","updatedAt":"string","chargeProcessingFee":true}],"merchant":{"name":"Acme Ltda","merchantId":"string","isSubAccount":true},"subscription":"subs_0a1b2c3d4e5f60718293","remainingAmount":"string","totalPercentage":5000,"remainingPercentage":0}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"splitId","schema":{"type":"string","pattern":"^(ssp|split)_.+$"},"required":true,"description":"Identificador público (ssp_/split_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"removeSubscriptionSplit"}},"/v1/marketplace/kyc/{token}/onboarding/document-types":{"get":{"tags":["Marketplace"],"summary":"Os tipos de documento que o passo 1 pode escolher, pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["allowed","accepted","inviteUnlockable","redeemedInvite"],"properties":{"allowed":{"type":"array","items":{"enum":["cpf","cnpj"],"type":"string"},"description":"O que a empresa pode escolher AGORA no passo 1: os tipos abertos mais o que ela já destravou."},"accepted":{"type":"array","items":{"enum":["cpf","cnpj"],"type":"string"},"description":"Os tipos de documento abertos no cadastro da plataforma."},"redeemedInvite":{"type":"object","nullable":true,"required":["code","documentType","unlocks","redeemedAt"],"properties":{"code":{"type":"string","description":"O código, normalizado."},"unlocks":{"type":"array","items":{"enum":["cpf","cnpj"],"type":"string"},"description":"Tipos de documento que ele destrava."},"redeemedAt":{"type":"string","description":"Quando foi resgatado (ISO 8601)."},"documentType":{"enum":["cpf","cnpj"],"type":"string","description":"O tipo de documento para o qual foi resgatado."}},"description":"O convite que a empresa já resgatou; `null` quando não há.","additionalProperties":false},"inviteUnlockable":{"type":"array","items":{"enum":["cpf","cnpj"],"type":"string"},"description":"Tipos de documento fechados no cadastro, mas destravados por código de convite."}},"additionalProperties":false},"example":{"allowed":["cpf"],"accepted":["cpf"],"redeemedInvite":{"code":"string","unlocks":["cpf"],"redeemedAt":"string","documentType":"cpf"},"inviteUnlockable":["cpf"]}}},"description":"Sucesso"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"getKycDocumentTypes"}},"/v1/subscriptions/{subscriptionId}/items/{itemId}/usage":{"post":{"tags":["Subscriptions"],"summary":"Registra o uso medido de um item da assinatura","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","subscriptionId","itemId","meterEventName","quantity","action","idempotent"],"properties":{"id":{"type":"string","pattern":"^(usg)_.+$","description":"Identificador público (usg_…)"},"action":{"type":"string","description":"`increment` ou `set`."},"itemId":{"type":"string","pattern":"^(sit|item)_.+$","description":"O item em que o uso foi registrado."},"quantity":{"type":"integer","description":"O uso registrado."},"idempotent":{"type":"boolean","description":"`true` quando este pedido repetiu um anterior (mesma `idempotencyKey`) e nada foi registrado de novo."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor do item."},"subscriptionId":{"type":"string","pattern":"^(subs|sub)_.+$","description":"A assinatura."}},"additionalProperties":false},"example":{"id":"usg_0a1b2c3d4e5f60718293","action":"string","itemId":"sit_0a1b2c3d4e5f60718293","quantity":0,"idempotent":true,"meterEventName":"string","subscriptionId":"subs_0a1b2c3d4e5f60718293"}}},"description":"Sucesso"},"201":{"content":{"application/json":{"schema":{"type":"object","required":["id","subscriptionId","itemId","meterEventName","quantity","action","idempotent"],"properties":{"id":{"type":"string","pattern":"^(usg)_.+$","description":"Identificador público (usg_…)"},"action":{"type":"string","description":"`increment` ou `set`."},"itemId":{"type":"string","pattern":"^(sit|item)_.+$","description":"O item em que o uso foi registrado."},"quantity":{"type":"integer","description":"O uso registrado."},"idempotent":{"type":"boolean","description":"`true` quando este pedido repetiu um anterior (mesma `idempotencyKey`) e nada foi registrado de novo."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor do item."},"subscriptionId":{"type":"string","pattern":"^(subs|sub)_.+$","description":"A assinatura."}},"additionalProperties":false},"example":{"id":"usg_0a1b2c3d4e5f60718293","action":"string","itemId":"sit_0a1b2c3d4e5f60718293","quantity":0,"idempotent":true,"meterEventName":"string","subscriptionId":"subs_0a1b2c3d4e5f60718293"}}},"description":"Criado"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"itemId","schema":{"type":"string","pattern":"^(sit|item)_.+$"},"required":true,"description":"Identificador público (sit_/item_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"recordSubscriptionUsage","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["quantity"],"properties":{"action":{"enum":["increment","set"],"type":"string","description":"`increment` (padrão) soma ao uso do ciclo; `set` substitui."},"metadata":{"type":"object","description":"Objeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.","additionalProperties":{}},"quantity":{"type":"integer","maximum":1000000000,"minimum":0,"description":"O uso, na unidade do medidor."},"occurredAt":{"type":"string","format":"date-time","description":"Quando o uso aconteceu (padrão agora) — decide em que ciclo ele cai."},"idempotencyKey":{"type":"string","maxLength":128,"description":"A sua chave para este registro: reenviá-la não conta o uso duas vezes."}},"additionalProperties":false},"example":{"action":"increment","metadata":{},"quantity":0,"occurredAt":"2026-01-15T12:00:00.000Z","idempotencyKey":"string"}}},"required":true}}},"/v1/marketplace/sub-accounts/{companyId}/closure-request":{"get":{"tags":["Marketplace"],"summary":"O pedido de exclusão atual de uma sub-conta, com o que ainda o bloqueia","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","reason","blockers","decisionNote","decidedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(clo)_.+$","description":"Identificador público (clo_…)"},"reason":{"type":"string","description":"Por que o encerramento foi pedido."},"status":{"enum":["requested","running","completed","blocked","failed","rejected","canceled"],"type":"string","description":"`requested` (aguardando a Selectwin), `running`, `completed`, `blocked`, `failed`, `rejected` ou `canceled` (você desistiu)."},"blockers":{"type":"array","items":{"type":"object","required":["reason","detail"],"properties":{"detail":{"type":"string","description":"Detalhes, em texto."},"reason":{"type":"string","description":"O que bloqueia o encerramento (ex.: um saldo a liquidar, uma cobrança em andamento)."}},"description":"Algo que precisa ser resolvido antes de o encerramento poder rodar.","additionalProperties":false},"description":"O que precisa ser resolvido antes de o encerramento poder rodar — reavaliado a cada leitura."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"decidedAt":{"type":"string","nullable":true,"description":"Quando a Selectwin decidiu; `null` até lá."},"decisionNote":{"type":"string","nullable":true,"description":"Por que a Selectwin recusou; `null` nos demais casos."}},"additionalProperties":false},"example":{"id":"clo_0a1b2c3d4e5f60718293","reason":"string","status":"requested","blockers":[{"detail":"string","reason":"string"}],"createdAt":"string","decidedAt":"string","decisionNote":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"getSubAccountClosureRequest"},"post":{"tags":["Marketplace"],"summary":"Pede a exclusão de uma sub-conta (a Selectwin analisa e executa)","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","reason","blockers","decisionNote","decidedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(clo)_.+$","description":"Identificador público (clo_…)"},"reason":{"type":"string","description":"Por que o encerramento foi pedido."},"status":{"enum":["requested","running","completed","blocked","failed","rejected","canceled"],"type":"string","description":"`requested` (aguardando a Selectwin), `running`, `completed`, `blocked`, `failed`, `rejected` ou `canceled` (você desistiu)."},"blockers":{"type":"array","items":{"type":"object","required":["reason","detail"],"properties":{"detail":{"type":"string","description":"Detalhes, em texto."},"reason":{"type":"string","description":"O que bloqueia o encerramento (ex.: um saldo a liquidar, uma cobrança em andamento)."}},"description":"Algo que precisa ser resolvido antes de o encerramento poder rodar.","additionalProperties":false},"description":"O que precisa ser resolvido antes de o encerramento poder rodar — reavaliado a cada leitura."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"decidedAt":{"type":"string","nullable":true,"description":"Quando a Selectwin decidiu; `null` até lá."},"decisionNote":{"type":"string","nullable":true,"description":"Por que a Selectwin recusou; `null` nos demais casos."}},"additionalProperties":false},"example":{"id":"clo_0a1b2c3d4e5f60718293","reason":"string","status":"requested","blockers":[{"detail":"string","reason":"string"}],"createdAt":"string","decidedAt":"string","decisionNote":"string"}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"requestSubAccountClosure","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","maxLength":500,"minLength":1,"description":"Por que a empresa está sendo encerrada"}},"additionalProperties":false},"example":{"reason":"string"}}},"required":true},"x-account-level":"always"},"delete":{"tags":["Marketplace"],"summary":"Desiste da exclusão da sub-conta — só enquanto nada foi executado","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","reason","blockers","decisionNote","decidedAt","createdAt"],"properties":{"id":{"type":"string","pattern":"^(clo)_.+$","description":"Identificador público (clo_…)"},"reason":{"type":"string","description":"Por que o encerramento foi pedido."},"status":{"enum":["requested","running","completed","blocked","failed","rejected","canceled"],"type":"string","description":"`requested` (aguardando a Selectwin), `running`, `completed`, `blocked`, `failed`, `rejected` ou `canceled` (você desistiu)."},"blockers":{"type":"array","items":{"type":"object","required":["reason","detail"],"properties":{"detail":{"type":"string","description":"Detalhes, em texto."},"reason":{"type":"string","description":"O que bloqueia o encerramento (ex.: um saldo a liquidar, uma cobrança em andamento)."}},"description":"Algo que precisa ser resolvido antes de o encerramento poder rodar.","additionalProperties":false},"description":"O que precisa ser resolvido antes de o encerramento poder rodar — reavaliado a cada leitura."},"createdAt":{"type":"string","nullable":true,"description":"Quando o recurso foi criado (ISO 8601, UTC)."},"decidedAt":{"type":"string","nullable":true,"description":"Quando a Selectwin decidiu; `null` até lá."},"decisionNote":{"type":"string","nullable":true,"description":"Por que a Selectwin recusou; `null` nos demais casos."}},"additionalProperties":false},"example":{"id":"clo_0a1b2c3d4e5f60718293","reason":"string","status":"requested","blockers":[{"detail":"string","reason":"string"}],"createdAt":"string","decidedAt":"string","decisionNote":"string"}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"409":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"idempotencyInProgress","status":"Conflict","message":"A request with this idempotency key is already being processed.","category":"client","resource":"server","statusCode":409}}}},"description":"Conflito (idempotência ou estado)"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"companyId","schema":{"type":"string","pattern":"^(bus)_.+$"},"required":true,"description":"Identificador público (bus_…)"}],"operationId":"cancelSubAccountClosureRequest","x-account-level":"always"}},"/v1/subscriptions/{subscriptionId}/cycles/{cycleId}/usage":{"get":{"tags":["Subscriptions"],"summary":"Uso agregado + valores calculados por item de um ciclo","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["cycleId","windowStart","windowEnd","billedAmount","currency","aggregatedByItem","totalUsageAmount"],"properties":{"cycleId":{"type":"string","pattern":"^(scy|cycle)_.+$","description":"O ciclo."},"currency":{"type":"string","nullable":true,"description":"Moeda (ISO 4217)."},"windowEnd":{"type":"string","nullable":true,"description":"Fim da janela de uso."},"windowStart":{"type":"string","nullable":true,"description":"Início da janela de uso."},"billedAmount":{"type":"number","nullable":true,"description":"O que o ciclo cobrou, em centavos; `null` até ser cobrado."},"aggregatedByItem":{"type":"array","items":{"type":"object","required":["itemId","name","meterEventName","usage","lineAmount"],"properties":{"name":{"type":"string","nullable":true,"description":"Nome do item."},"usage":{"type":"number","description":"Uso agregado do ciclo, na unidade do medidor."},"itemId":{"type":"string","pattern":"^(sit|item)_.+$","description":"O item."},"lineAmount":{"type":"number","description":"Quanto esse uso custa, em centavos."},"meterEventName":{"type":"string","nullable":true,"description":"Nome do medidor do item."}},"additionalProperties":false},"description":"Uso e valor por item."},"totalUsageAmount":{"type":"number","description":"Soma dos valores de uso do ciclo, em centavos."}},"additionalProperties":false},"example":{"cycleId":"scy_0a1b2c3d4e5f60718293","currency":"BRL","windowEnd":"string","windowStart":"string","billedAmount":5000,"aggregatedByItem":[{"name":"Acme Ltda","usage":0,"itemId":"sit_0a1b2c3d4e5f60718293","lineAmount":5000,"meterEventName":"string"}],"totalUsageAmount":5000}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"cycleId","schema":{"type":"string","pattern":"^(scy|cycle)_.+$"},"required":true,"description":"Identificador público (scy_/cycle_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"getSubscriptionCycleUsage"}},"/v1/marketplace/kyc/{token}/onboarding/invite-code/validate":{"post":{"tags":["Marketplace"],"summary":"Confere um código de convite pelo link de credenciamento — não consome","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["valid","reason","unlocks","label","expiresAt","remainingRedemptions"],"properties":{"label":{"type":"string","nullable":true,"description":"Sempre `null`. Mantido para clientes antigos."},"valid":{"type":"boolean","description":"Se o código destrava o tipo de documento pedido."},"reason":{"enum":["unknown","revoked","expired","exhausted","notForDocumentType"],"type":"string","nullable":true,"description":"Sempre `null`: a resposta não diz por que um código não serve. Mantido para clientes antigos."},"unlocks":{"type":"array","items":{"enum":["cpf","cnpj"],"type":"string"},"description":"Tipos de documento que o convite destrava (`[]` quando não serve)."},"expiresAt":{"type":"string","nullable":true,"description":"Quando o convite expira (ISO 8601); `null` quando não expira, ou não serve."},"remainingRedemptions":{"type":"integer","nullable":true,"description":"Sempre `null`. Mantido para clientes antigos."}},"additionalProperties":false},"example":{"label":"string","valid":true,"reason":"unknown","unlocks":["cpf"],"expiresAt":"string","remainingRedemptions":0}}},"description":"Sucesso"},"400":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Requisição inválida (validação)"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"validateKycInviteCode","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","maxLength":40,"minLength":1,"description":"O codigo digitado pelo lojista — normalizado no servidor"},"documentType":{"enum":["cpf","cnpj"],"type":"string","default":"cpf","description":"O tipo de documento que o convite deve destravar (padrão `cpf`)."}},"additionalProperties":false},"example":{"code":"string","documentType":"cpf"}}},"required":true}}},"/v1/subscriptions/{subscriptionId}/thresholds/{thresholdId}":{"delete":{"tags":["Subscriptions"],"summary":"Remove um limiar de cobrança","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","deleted"],"properties":{"id":{"type":"string","pattern":"^(sbt)_.+$","description":"Id público do limiar excluído."},"deleted":{"enum":[true],"type":"boolean","description":"Sempre `true`: a exclusão foi feita."}},"additionalProperties":false},"example":{"id":"sbt_0a1b2c3d4e5f60718293","deleted":true}}},"description":"Sucesso"},"401":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"unauthorized","status":"Unauthorized","message":"Authentication is required to access this resource.","category":"authentication","resource":"server","statusCode":401}}}},"description":"Não autenticado (credencial ausente ou inválida)"},"403":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"forbidden","status":"Forbidden","message":"You do not have permission to perform this action.","category":"authorization","resource":"server","statusCode":403}}}},"description":"Sem permissão"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"subscriptionId","schema":{"type":"string","pattern":"^(subs|sub)_.+$"},"required":true,"description":"Identificador público (subs_/sub_…)"},{"in":"path","name":"thresholdId","schema":{"type":"string","pattern":"^(sbt)_.+$"},"required":true,"description":"Identificador público (sbt_…)"},{"$ref":"#/components/parameters/SelectwinAccount"}],"operationId":"removeSubscriptionThreshold"}},"/v1/marketplace/kyc/{token}/assets/uploads/{assetId}/confirm":{"post":{"tags":["Marketplace"],"summary":"Confirma o upload de um documento pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id","status","kind","confidential","filename","contentType","byteSize","url","createdAt"],"properties":{"id":{"type":"string","pattern":"^(asset|ass)_.+$","description":"Identificador público (asset_/ass_…)"},"url":{"type":"string","nullable":true,"description":"Onde ler: a URL da CDN (público) ou uma URL assinada de curta duração (confidencial); `null` enquanto pendente."},"kind":{"type":"string","description":"Para que o arquivo serve."},"status":{"enum":["pending","ready"],"type":"string","description":"`pending` até o envio ser confirmado; `ready` depois."},"byteSize":{"type":"integer","nullable":true,"description":"Tamanho, em bytes; `null` enquanto pendente."},"filename":{"type":"string","nullable":true,"description":"Nome do arquivo; `null` quando desconhecido."},"createdAt":{"type":"string","description":"Quando o recurso foi criado (ISO 8601, UTC)."},"contentType":{"type":"string","nullable":true,"description":"Tipo MIME; `null` enquanto pendente."},"confidential":{"type":"boolean","description":"Se o arquivo é privado."}},"additionalProperties":false},"example":{"id":"asset_0a1b2c3d4e5f60718293","url":"string","kind":"string","status":"pending","byteSize":0,"filename":"string","createdAt":"string","contentType":"string","confidential":true}}},"description":"Sucesso"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"413":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false}}},"description":"Corpo grande demais"},"422":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"invalidParameters","status":"Bad Request","message":"Validation errors occurred.","category":"validation","resource":"server","statusCode":400}}}},"description":"Regra de negócio impede o processamento"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"},"503":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false}}},"description":"Serviço indisponível"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."},{"in":"path","name":"assetId","schema":{"type":"string","pattern":"^(asset|ass)_.+$"},"required":true,"description":"Identificador público (asset_/ass_…)"}],"operationId":"confirmKycDocumentUpload"}},"/v1/marketplace/kyc/{token}/onboarding/document-requirements":{"get":{"tags":["Marketplace"],"summary":"O que o passo 3 precisa pedir, pelo link de credenciamento","security":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["documentType","complete","requirements","unclassified","captureQuality"],"properties":{"complete":{"type":"boolean","description":"Se toda exigência obrigatória tem uma alternativa enviada ou aprovada."},"documentType":{"enum":["cpf","cnpj"],"type":"string","nullable":true,"description":"`cpf` ou `cnpj` (passo 1); `null` antes dele, quando só os documentos do titular são listados."},"requirements":{"type":"array","items":{"type":"object","required":["key","subject","required","status","alternatives"],"properties":{"key":{"type":"string","description":"Id estável da exigência (`identity`, `selfie`, `bank_statement_company`…)."},"status":{"enum":["missing","pending","approved","rejected"],"type":"string","description":"O estado mais avançado entre as alternativas: `approved` > `pending` > `rejected` > `missing`."},"subject":{"enum":["holder","company"],"type":"string","description":"De quem é o documento: `holder` (a pessoa — o lojista CPF ou o representante legal) ou `company`."},"required":{"type":"boolean","description":"Se a exigência precisa ser cumprida."},"alternatives":{"type":"array","items":{"type":"object","required":["key","status","documents"],"properties":{"key":{"type":"string","description":"Id estável: os tipos de documento da alternativa unidos por `+` (`rg_front+rg_back`)."},"status":{"enum":["missing","pending","approved","rejected"],"type":"string","description":"`approved` quando todos os documentos estão; `rejected` quando algum está; `pending` quando todos foram enviados; senão `missing`."},"documents":{"type":"array","items":{"type":"object","required":["type","kind","side","file","status","documentId","rejectionReason"],"properties":{"file":{"type":"object","required":["maxBytes","contentTypes"],"properties":{"maxBytes":{"type":"integer","description":"Tamanho máximo, em bytes (para todos os formatos listados)."},"contentTypes":{"type":"array","items":{"type":"string"},"description":"Tipos MIME aceitos."}},"description":"O que o arquivo precisa ser — a mesma regra que o anexo aplica.","additionalProperties":false},"kind":{"type":"string","description":"O que o documento é (`rg`, `cnh`, `cref`, `selfie`, `bank_statement`…)."},"side":{"enum":["front","back","full"],"type":"string","description":"Qual parte do documento o arquivo contém: `front`, `back` ou `full`."},"type":{"type":"string","description":"O `documentType` a enviar no passo 3."},"status":{"enum":["missing","pending","approved","rejected"],"type":"string","description":"Estado do documento mais recente deste tipo que a empresa enviou; `missing` quando não há."},"documentId":{"type":"string","nullable":true,"description":"Id desse documento; `null` quando não há."},"rejectionReason":{"type":"string","nullable":true,"description":"Por que foi rejeitado; `null` nos outros casos."}},"additionalProperties":false},"description":"Os documentos da alternativa."}},"additionalProperties":false},"description":"QUALQUER alternativa satisfaz a exigência; uma alternativa precisa de TODOS os seus documentos."}},"additionalProperties":false},"description":"O que precisa ser enviado, e o estado de cada exigência."},"unclassified":{"type":"array","items":{"type":"object","required":["documentId","type","status","rejectionReason"],"properties":{"type":{"type":"string","description":"O tipo legado sob o qual foi enviado."},"status":{"enum":["pending","approved","rejected"],"type":"string","description":"O estado dele."},"documentId":{"type":"string","description":"Id do documento."},"rejectionReason":{"type":"string","nullable":true,"description":"Por que foi rejeitado; `null` nos outros casos."}},"additionalProperties":false},"description":"Documentos enviados sob um tipo legado que não diz o que são; não satisfazem nenhuma exigência até serem classificados na aprovação."},"captureQuality":{"type":"object","required":["minShortSide","detailSide","minSharpness","minMeanBrightness","maxMeanBrightness","darkLevel","brightLevel","maxDarkFraction","maxBrightFraction"],"properties":{"darkLevel":{"type":"integer","description":"Nível de cinza até o qual um pixel conta como escuro."},"detailSide":{"type":"integer","description":"Lado do quadrado em que a imagem em tons de cinza é reduzida para caber (nunca ampliada) antes de medir nitidez e exposição, em pixels."},"brightLevel":{"type":"integer","description":"Nível de cinza a partir do qual um pixel conta como claro."},"minSharpness":{"type":"number","description":"Nitidez mínima: a variância do laplaciano de 4 vizinhos sobre o interior da imagem reduzida."},"minShortSide":{"type":"integer","description":"Comprimento mínimo do lado menor da imagem original, em pixels."},"maxDarkFraction":{"type":"number","description":"Fração máxima de pixels escuros (0–1)."},"maxBrightFraction":{"type":"number","description":"Fração máxima de pixels claros (0–1)."},"maxMeanBrightness":{"type":"number","description":"Nível médio de cinza máximo (0–255)."},"minMeanBrightness":{"type":"number","description":"Nível médio de cinza mínimo (0–255)."}},"description":"A régua que a foto de um documento deve passar — para a tela avisar enquanto a pessoa ainda pode tirar outra. Consultiva: uma foto abaixo dela ainda é aceita.","additionalProperties":false}},"additionalProperties":false},"example":{"complete":true,"documentType":"cpf","requirements":[{"key":"string","status":"missing","subject":"holder","required":true,"alternatives":[{"key":"string","status":"missing","documents":[{"file":{"maxBytes":0,"contentTypes":[]},"kind":"string","side":"front","type":"string","status":"missing","documentId":"string","rejectionReason":"string"}]}]}],"unclassified":[{"type":"string","status":"pending","documentId":"string","rejectionReason":"string"}],"captureQuality":{"darkLevel":0,"detailSide":0,"brightLevel":0,"minSharpness":0,"minShortSide":0,"maxDarkFraction":0,"maxBrightFraction":0,"maxMeanBrightness":0,"minMeanBrightness":0}}}},"description":"Sucesso"},"404":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"notFound","status":"Not Found","message":"The requested resource was not found.","category":"client","resource":"server","statusCode":404}}}},"description":"Não encontrado"},"500":{"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["status","statusCode","category","code","message","resource"],"properties":{"code":{"type":"string"},"params":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"status":{"type":"string"},"details":{"type":"string"},"message":{"type":"string"},"category":{"enum":["validation","authentication","authorization","payment","client","server","rate_limit","pending"],"type":"string"},"resource":{"type":"string"},"statusCode":{"type":"integer"}},"additionalProperties":false}},"description":"Envelope de erro padrão","additionalProperties":false},"example":{"error":{"code":"serverError","status":"Internal Server Error","details":"If the problem persists, contact support with the correlationId from the response headers.","message":"An unexpected error occurred. Please try again later.","category":"server","resource":"server","statusCode":500}}}},"description":"Erro interno do servidor"}},"parameters":[{"in":"path","name":"token","schema":{"type":"string","maxLength":128,"minLength":40},"required":true,"description":"O token secreto do link de credenciamento (a credencial destas operações)."}],"operationId":"getKycDocumentRequirements"}}},"openapi":"3.1.0","servers":[{"url":"https://api.selectwin.io","description":"Produção (HTTPS, TLS 1.2+)"}],"security":[{"SelectKeyAuth":[]},{"BearerAuth":[]}],"webhooks":{"eventDelivery":{"post":{"tags":["Webhooks"],"summary":"Entrega de evento na sua URL","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":true},"received":{"type":"boolean","example":true}},"description":"Resposta opcional; qualquer JSON é aceito com 200/201.","additionalProperties":true},"examples":{"empty":{"value":{},"summary":"Sem corpo"},"receivedFlag":{"value":{"received":true},"summary":"Confirmação mínima"}}}},"description":"Recebido — entrega bem-sucedida."},"201":{"content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":true},"received":{"type":"boolean","example":true}},"description":"Resposta opcional; qualquer JSON é aceito com 200/201.","additionalProperties":true},"examples":{"empty":{"value":{},"summary":"Sem corpo"},"receivedFlag":{"value":{"received":true},"summary":"Confirmação mínima"}}}},"description":"Recebido — entrega bem-sucedida."}},"description":"Corpo JSON que a Selectwin envia (POST) para a URL que você configurou quando ocorre um evento. **Responda 200 ou 201** para confirmar; qualquer outro status (incluindo outros 2xx) é tratado como falha e pode acionar retentativas.","operationId":"webhookEventDelivery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEventPayload"},"example":{"id":"wbh_758c47e09f43c6d99cfe","type":"transaction.approved","source":"webhook","payload":{"object":{"id":"tra_0a1b2c3d4e5f60718293","status":"approved"}},"createdAt":"2026-01-15T12:00:00.000Z","updatedAt":"2026-01-15T12:00:00.000Z","correlationId":"cor_1776016593"}}},"required":true}}}},"components":{"schemas":{"WebhookEventPayload":{"type":"object","title":"WebhookEventPayload","example":{"id":"wbh_758c47e09f43c6d99cfe","type":"transaction.approved","source":"webhook","payload":{"object":{"id":"tra_0a1b2c3d4e5f60718293","status":"approved"}},"createdAt":"2026-01-15T12:00:00.000Z","updatedAt":"2026-01-15T12:00:00.000Z","correlationId":"cor_1776016593"},"required":["id","type","source","payload","createdAt","updatedAt","correlationId"],"properties":{"id":{"type":"string","example":"wbh_758c47e09f43c6d99cfe","description":"Identificador público do evento."},"type":{"type":"string","example":"transaction.approved","description":"Tipo no formato `recurso.acao`."},"source":{"type":"string","example":"webhook","description":"Origem do evento na plataforma."},"account":{"type":"string","example":"bus_01hqzvsub1","description":"Só nos eventos que uma plataforma de marketplace recebe de uma SUB-CONTA dela: o `id` (`bus_…`) da sub-conta a que o evento pertence. Ausente nos eventos da própria conta."},"payload":{"type":"object","required":["object"],"properties":{"object":{"type":"object","description":"Recurso associado ao evento."}},"description":"Conteúdo do evento; `object` é o recurso relacionado (campos variam por `type`).","additionalProperties":false},"createdAt":{"type":"string","format":"date-time","example":"2026-01-15T12:00:00.000Z","description":"Criação do evento (UTC, ISO 8601)."},"updatedAt":{"type":"string","format":"date-time","example":"2026-01-15T12:00:00.000Z","description":"Última atualização (UTC, ISO 8601)."},"correlationId":{"type":"string","example":"cor_1776016593","description":"Identificador para correlacionar logs/suporte."}},"description":"Envelope do evento entregue à sua URL. A forma de `payload.object` depende de `type` (ex.: `transaction.approved`).","additionalProperties":false}},"parameters":{"SelectwinAccount":{"in":"header","name":"X-Selectwin-Account","schema":{"type":"string","pattern":"^bus_[A-Za-z0-9]+$"},"required":false,"description":"Plataformas de marketplace: o `id` (`bus_…`) de uma sub-conta sua. A operação roda na sub-conta (dados, saldo, vendas dela) com a sua chave de API; a resposta traz `merchant.isSubAccount: true`. Só com chave de API e com a sua plataforma ativa; uma conta que não é sub-conta sua, ou uma plataforma que não está ativa, responde 401 `actingAccountInvalid`."}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"JWT de sessão (painel/usuário) emitido por `POST /v1/authentication/token`. Envie em `Authorization: Bearer <token>`.","bearerFormat":"JWT"},"SelectKeyAuth":{"in":"header","name":"selectkey","type":"apiKey","description":"API key para requisições autenticadas. Envie sua chave no cabeçalho `selectkey` (sandbox `sk_test_…`, produção `sk_live_…`)."}}},"x-tagGroups":[{"name":"Gestão de clientes","tags":["Customers","Addresses","Cards"]},{"name":"Pagamentos","tags":["Transactions","Subscriptions","Simulators"]},{"name":"Recebíveis e saques","tags":["Receivables","Withdrawals","Finance","Wallets"]},{"name":"Checkout","tags":["Checkout","Coupons"]},{"name":"Marketplace","tags":["Marketplace"]},{"name":"Catálogo","tags":["Products","Products - Variants"]},{"name":"Webhooks","tags":["Webhooks"]},{"name":"Utilidades","tags":["Utils","Pricing","tokenization"]}],"externalDocs":{"url":"https://selectwin.io/docs","description":"Documentação geral, guias e referência de erros"},"jsonSchemaDialect":"https://spec.openapis.org/oas/3.1/dialect/base"}