Headers obrigatórios
Todas as requisições usam estes headers:ApiKey diferencia maiúsculas de minúsculas e deve ser seguido por um único espaço e pela chave completa.
Ambientes
O prefixo da chave determina o ambiente usado na autenticação:
A chave, o merchant e a conta do provedor precisam pertencer ao mesmo ambiente. Chaves revogadas, expiradas ou associadas a um merchant desabilitado são rejeitadas.
Envelope de sucesso
Respostas bem-sucedidas usam esta estrutura:data contém a página retornada pelo Spring Data. Em consultas individuais, data contém o Produto ou Cupom. A criação de Cliente retorna o cliente em data, enquanto a criação de cobrança retorna os dados do pagamento Pix.
Envelope de erro
Erros tratados pelo backend seguem a mesma estrutura, comdata nulo e detalhes em error:
As mensagens de erro atuais são retornadas em português pelo backend.
Paginação
As listagens aceitam os parâmetros nativos do Spring Data:
Produtos são ordenados pelo ID interno em ordem decrescente. Cupons, Clientes e Cobranças são ordenados pela data de criação em ordem decrescente. As listagens de Clientes e Cobranças limitam o tamanho efetivo da página a 100.
Valores e datas
Preço de produto
Preço de produto
price é retornado em reais, sempre convertido do valor armazenado em centavos para duas casas decimais.Valor do cupom
Valor do cupom
Na entrada,
FIXED_AMOUNT.value é enviado em centavos. Na resposta, ele é convertido para reais com duas casas decimais. Em PERCENTAGE, permanece um percentual inteiro.Valores da cobrança
Valores da cobrança
amount, fee_amount e net_amount são valores decimais em reais. A criação de cobrança também retorna amount em reais.Datas
Datas
Datas devolvidas pelo backend são serializadas em ISO-8601 com o offset de
America/Sao_Paulo. Campos opcionais podem ser null.