{"openapi":"3.1.0","info":{"title":"API de PDV — Moeda Nobre","version":"1.0.0","description":"Integração de sistemas de caixa (PDV) com a Moeda Nobre: o caixa cria a cobrança, o cliente paga pelo app. Mesmo contrato em testes (chave mn_test_) e produção (chave mn_live_)."},"servers":[{"url":"https://moedanobre.com/api/v1"}],"security":[{"chave":[]}],"components":{"securitySchemes":{"chave":{"type":"http","scheme":"bearer","bearerFormat":"mn_test_… | mn_live_…","description":"A chave fica no SERVIDOR do PDV, nunca no navegador."}},"schemas":{"Cobranca":{"type":"object","properties":{"id":{"type":"string","description":"Id da cobrança (é o `tid` do QR)"},"status":{"type":"string","enum":["PENDENTE","PAGA","CANCELADA","EXPIRADA","ESTORNADA"]},"valorCentavos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pontoDeVendaId":{"type":"string"},"lojaId":{"type":"string"},"referenciaExterna":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadados":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"qrCode":{"description":"Só enquanto PENDENTE","type":"object","properties":{"conteudo":{"type":"string","description":"Texto do QR — desenhe com qualquer biblioteca de QR"},"imagemPng":{"description":"data:image/png;base64,… (omitida com ?semImagem=true)","type":"string"}},"required":["conteudo"],"additionalProperties":false},"criadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"expiraEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"pagaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"canceladaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"expiradaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"estornadaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]}},"required":["id","status","valorCentavos","pontoDeVendaId","lojaId","referenciaExterna","metadados","criadoEm","expiraEm","pagaEm","canceladaEm","expiradaEm","estornadaEm","ambiente"],"additionalProperties":false},"PontoDeVenda":{"type":"object","properties":{"id":{"type":"string"},"identificadorExterno":{"type":"string"},"nome":{"type":"string"},"status":{"type":"string","enum":["ATIVO","DESATIVADO"]},"loja":{"type":"object","properties":{"id":{"type":"string"},"nomeFantasia":{"type":"string"},"cidade":{"anyOf":[{"type":"string"},{"type":"null"}]},"estado":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","nomeFantasia","cidade","estado"],"additionalProperties":false},"ativadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"desativadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]}},"required":["id","identificadorExterno","nome","status","loja","ativadoEm","desativadoEm","ambiente"],"additionalProperties":false},"Evento":{"type":"object","properties":{"id":{"type":"string","description":"evt_… — use para não processar o mesmo evento duas vezes"},"tipo":{"type":"string","enum":["cobranca.paga","cobranca.cancelada","cobranca.expirada","cobranca.estornada","ponto_de_venda.desativado","ponto_de_venda.reativado","ping"]},"criadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]},"dados":{"type":"object","properties":{"cobranca":{"type":"object","properties":{"id":{"type":"string","description":"Id da cobrança (é o `tid` do QR)"},"status":{"type":"string","enum":["PENDENTE","PAGA","CANCELADA","EXPIRADA","ESTORNADA"]},"valorCentavos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pontoDeVendaId":{"type":"string"},"lojaId":{"type":"string"},"referenciaExterna":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadados":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"qrCode":{"description":"Só enquanto PENDENTE","type":"object","properties":{"conteudo":{"type":"string","description":"Texto do QR — desenhe com qualquer biblioteca de QR"},"imagemPng":{"description":"data:image/png;base64,… (omitida com ?semImagem=true)","type":"string"}},"required":["conteudo"],"additionalProperties":false},"criadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"expiraEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"pagaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"canceladaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"expiradaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"estornadaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]}},"required":["id","status","valorCentavos","pontoDeVendaId","lojaId","referenciaExterna","metadados","criadoEm","expiraEm","pagaEm","canceladaEm","expiradaEm","estornadaEm","ambiente"],"additionalProperties":false},"pontoDeVenda":{"type":"object","properties":{"id":{"type":"string"},"identificadorExterno":{"type":"string"},"nome":{"type":"string"},"status":{"type":"string","enum":["ATIVO","DESATIVADO"]},"loja":{"type":"object","properties":{"id":{"type":"string"},"nomeFantasia":{"type":"string"},"cidade":{"anyOf":[{"type":"string"},{"type":"null"}]},"estado":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","nomeFantasia","cidade","estado"],"additionalProperties":false},"ativadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"desativadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]}},"required":["id","identificadorExterno","nome","status","loja","ativadoEm","desativadoEm","ambiente"],"additionalProperties":false}},"additionalProperties":false}},"required":["id","tipo","criadoEm","ambiente","dados"],"additionalProperties":false},"Erro":{"type":"object","properties":{"erro":{"type":"object","properties":{"codigo":{"type":"string","enum":["VALIDACAO","CAMPO_DESCONHECIDO","IDEMPOTENCY_KEY_OBRIGATORIA","CENARIO_SO_EM_TESTE","CENARIO_INVALIDO","CHAVE_INVALIDA","CHAVE_REVOGADA","PARCEIRO_SUSPENSO","PRODUCAO_NAO_LIBERADA","APLICATIVO_DESATIVADO","CHAVE_EM_NAVEGADOR","PDV_NAO_ENCONTRADO","COBRANCA_NAO_ENCONTRADA","RECURSO_NAO_ENCONTRADO","METODO_NAO_PERMITIDO","COBRANCA_PENDENTE_EXISTE","COBRANCA_NAO_PENDENTE","REQUISICAO_EM_ANDAMENTO","PDV_JA_ATIVO","CODIGO_ATIVACAO_EXPIRADO","CORPO_GRANDE","CONTENT_TYPE","IDEMPOTENCY_CONFLITO","PDV_INATIVO","LOJA_INATIVA","VINCULO_REVOGADO","CODIGO_ATIVACAO_INVALIDO","LIMITE_EXCEDIDO","ERRO_INTERNO","INDISPONIVEL"]},"mensagem":{"type":"string"},"detalhes":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"requestId":{"type":"string","description":"Mande este id ao suporte"}},"required":["codigo","mensagem","requestId"],"additionalProperties":false}},"required":["erro"],"additionalProperties":false},"Ping":{"type":"object","properties":{"ok":{"type":"boolean","const":true},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]},"aplicativo":{"type":"object","properties":{"id":{"type":"string"},"nome":{"type":"string"}},"required":["id","nome"],"additionalProperties":false},"servidorEm":{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"}},"required":["ok","ambiente","aplicativo","servidorEm"],"additionalProperties":false},"CriarCobranca":{"type":"object","properties":{"pontoDeVendaId":{"type":"string","minLength":1,"maxLength":64},"valorCentavos":{"type":"integer","minimum":1,"maximum":9999999},"referenciaExterna":{"type":"string","minLength":1,"maxLength":64},"expiraEmSegundos":{"default":300,"type":"integer","minimum":60,"maximum":900},"metadados":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":40},"additionalProperties":{"type":"string","maxLength":100}},"cancelarPendenteAnterior":{"default":false,"type":"boolean"}},"required":["pontoDeVendaId","valorCentavos"],"additionalProperties":false},"AtivarPontoDeVenda":{"type":"object","properties":{"codigoAtivacao":{"type":"string","minLength":1,"maxLength":40},"identificadorExterno":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"},"nome":{"type":"string","minLength":1,"maxLength":60}},"required":["codigoAtivacao","identificadorExterno"],"additionalProperties":false},"PaginaCobrancas":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id da cobrança (é o `tid` do QR)"},"status":{"type":"string","enum":["PENDENTE","PAGA","CANCELADA","EXPIRADA","ESTORNADA"]},"valorCentavos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pontoDeVendaId":{"type":"string"},"lojaId":{"type":"string"},"referenciaExterna":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadados":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"qrCode":{"description":"Só enquanto PENDENTE","type":"object","properties":{"conteudo":{"type":"string","description":"Texto do QR — desenhe com qualquer biblioteca de QR"},"imagemPng":{"description":"data:image/png;base64,… (omitida com ?semImagem=true)","type":"string"}},"required":["conteudo"],"additionalProperties":false},"criadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"expiraEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"pagaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"canceladaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"expiradaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"estornadaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]}},"required":["id","status","valorCentavos","pontoDeVendaId","lojaId","referenciaExterna","metadados","criadoEm","expiraEm","pagaEm","canceladaEm","expiradaEm","estornadaEm","ambiente"],"additionalProperties":false}},"proximoCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","proximoCursor"],"additionalProperties":false},"PaginaPontosDeVenda":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"identificadorExterno":{"type":"string"},"nome":{"type":"string"},"status":{"type":"string","enum":["ATIVO","DESATIVADO"]},"loja":{"type":"object","properties":{"id":{"type":"string"},"nomeFantasia":{"type":"string"},"cidade":{"anyOf":[{"type":"string"},{"type":"null"}]},"estado":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","nomeFantasia","cidade","estado"],"additionalProperties":false},"ativadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"desativadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]}},"required":["id","identificadorExterno","nome","status","loja","ativadoEm","desativadoEm","ambiente"],"additionalProperties":false}},"proximoCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","proximoCursor"],"additionalProperties":false},"PaginaEventos":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"evt_… — use para não processar o mesmo evento duas vezes"},"tipo":{"type":"string","enum":["cobranca.paga","cobranca.cancelada","cobranca.expirada","cobranca.estornada","ponto_de_venda.desativado","ponto_de_venda.reativado","ping"]},"criadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]},"dados":{"type":"object","properties":{"cobranca":{"type":"object","properties":{"id":{"type":"string","description":"Id da cobrança (é o `tid` do QR)"},"status":{"type":"string","enum":["PENDENTE","PAGA","CANCELADA","EXPIRADA","ESTORNADA"]},"valorCentavos":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pontoDeVendaId":{"type":"string"},"lojaId":{"type":"string"},"referenciaExterna":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadados":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"qrCode":{"description":"Só enquanto PENDENTE","type":"object","properties":{"conteudo":{"type":"string","description":"Texto do QR — desenhe com qualquer biblioteca de QR"},"imagemPng":{"description":"data:image/png;base64,… (omitida com ?semImagem=true)","type":"string"}},"required":["conteudo"],"additionalProperties":false},"criadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"expiraEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"pagaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"canceladaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"expiradaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"estornadaEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]}},"required":["id","status","valorCentavos","pontoDeVendaId","lojaId","referenciaExterna","metadados","criadoEm","expiraEm","pagaEm","canceladaEm","expiradaEm","estornadaEm","ambiente"],"additionalProperties":false},"pontoDeVenda":{"type":"object","properties":{"id":{"type":"string"},"identificadorExterno":{"type":"string"},"nome":{"type":"string"},"status":{"type":"string","enum":["ATIVO","DESATIVADO"]},"loja":{"type":"object","properties":{"id":{"type":"string"},"nomeFantasia":{"type":"string"},"cidade":{"anyOf":[{"type":"string"},{"type":"null"}]},"estado":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","nomeFantasia","cidade","estado"],"additionalProperties":false},"ativadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"desativadoEm":{"anyOf":[{"type":"string","description":"Data ISO-8601 com fuso de Brasília, ex. 2026-09-25T14:03:11-03:00"},{"type":"null"}]},"ambiente":{"type":"string","enum":["TESTE","PRODUCAO"]}},"required":["id","identificadorExterno","nome","status","loja","ativadoEm","desativadoEm","ambiente"],"additionalProperties":false}},"additionalProperties":false}},"required":["id","tipo","criadoEm","ambiente","dados"],"additionalProperties":false}},"proximoCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","proximoCursor"],"additionalProperties":false}},"parameters":{"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","maxLength":128},"description":"Único por cobrança que você quer criar (ex.: o id do cupom). Repetir com o mesmo corpo devolve a mesma cobrança."},"Cenario":{"name":"Moeda-Nobre-Teste-Cenario","in":"header","required":false,"schema":{"type":"string","enum":["pagar_em_3s","expirar_em_10s","loja_cancela_em_3s","pagar_e_estornar"]},"description":"Só com chave de teste."}}},"paths":{"/ping":{"get":{"summary":"A chave funciona?","operationId":"ping","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ping"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/pontos-de-venda/ativar":{"post":{"summary":"Ligar um caixa com o código de ativação","description":"Produção: código XXXX-XXXX gerado pelo gerente da loja. Testes: código T-XXXX-XXXX gerado no portal. Uso único; 5 códigos errados por chave em 1 hora bloqueiam por 1 hora.","operationId":"ativarPontoDeVenda","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtivarPontoDeVenda"}}}},"responses":{"201":{"description":"Caixa ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PontoDeVenda"}}}},"400":{"description":"VALIDACAO · CAMPO_DESCONHECIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"PDV_JA_ATIVO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"410":{"description":"CODIGO_ATIVACAO_EXPIRADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"CODIGO_ATIVACAO_INVALIDO · LOJA_INATIVA","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/pontos-de-venda":{"get":{"summary":"Listar os caixas","operationId":"listarPontosDeVenda","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["ATIVO","DESATIVADO"]}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"limite","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Página","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginaPontosDeVenda"}}}},"400":{"description":"VALIDACAO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/pontos-de-venda/{id}":{"get":{"summary":"Um caixa","operationId":"obterPontoDeVenda","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Id do caixa"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PontoDeVenda"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"PDV_NAO_ENCONTRADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/pontos-de-venda/{id}/desativar":{"post":{"summary":"Desligar um caixa (cancela a pendente dele)","operationId":"desativarPontoDeVenda","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Id do caixa"}],"responses":{"200":{"description":"Caixa desligado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PontoDeVenda"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"PDV_NAO_ENCONTRADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/cobrancas":{"post":{"summary":"Criar uma cobrança","description":"Uma cobrança pendente por caixa. Com cancelarPendenteAnterior=true a anterior é cancelada (se o cliente não tiver acabado de pagá-la).","operationId":"criarCobranca","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"},{"$ref":"#/components/parameters/Cenario"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CriarCobranca"}}}},"responses":{"200":{"description":"Repetição com a mesma Idempotency-Key (cabeçalho Idempotent-Replayed: true)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cobranca"}}}},"201":{"description":"Cobrança criada (com o QR)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cobranca"}}}},"400":{"description":"VALIDACAO · CAMPO_DESCONHECIDO · IDEMPOTENCY_KEY_OBRIGATORIA · CENARIO_SO_EM_TESTE · CENARIO_INVALIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"PDV_NAO_ENCONTRADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"COBRANCA_PENDENTE_EXISTE · COBRANCA_NAO_PENDENTE · REQUISICAO_EM_ANDAMENTO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"IDEMPOTENCY_CONFLITO · PDV_INATIVO · LOJA_INATIVA · VINCULO_REVOGADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"get":{"summary":"Listar cobranças","operationId":"listarCobrancas","parameters":[{"name":"pontoDeVendaId","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["PENDENTE","PAGA","CANCELADA","EXPIRADA","ESTORNADA"]}},{"name":"criadoDe","in":"query","required":false,"schema":{"type":"string"}},{"name":"criadoAte","in":"query","required":false,"schema":{"type":"string"}},{"name":"referenciaExterna","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"limite","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Página","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginaCobrancas"}}}},"400":{"description":"VALIDACAO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/cobrancas/{id}":{"get":{"summary":"Uma cobrança — com ?aguardar=N espera até N segundos por uma mudança (long-poll)","operationId":"obterCobranca","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Id da cobrança"},{"name":"aguardar","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":25}},{"name":"semImagem","in":"query","required":false,"schema":{"type":"string","enum":["0","1","true","false"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cobranca"}}}},"400":{"description":"VALIDACAO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"COBRANCA_NAO_ENCONTRADA","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/cobrancas/{id}/cancelar":{"post":{"summary":"Cancelar uma cobrança pendente","operationId":"cancelarCobranca","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Id da cobrança"}],"responses":{"200":{"description":"Cancelada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cobranca"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"COBRANCA_NAO_ENCONTRADA","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"COBRANCA_NAO_PENDENTE","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/eventos":{"get":{"summary":"Eventos dos últimos 30 dias, em ordem (conciliação / quem não recebe webhook)","operationId":"listarEventos","parameters":[{"name":"apos","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"limite","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Página","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginaEventos"}}}},"400":{"description":"VALIDACAO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"CHAVE_INVALIDA · CHAVE_REVOGADA · PARCEIRO_SUSPENSO · PRODUCAO_NAO_LIBERADA · APLICATIVO_DESATIVADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"CHAVE_EM_NAVEGADOR","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"RECURSO_NAO_ENCONTRADO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"LIMITE_EXCEDIDO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"ERRO_INTERNO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}}}