Para quem vende · API e webhooks

API: formato do endereço do comprador

No boleto e no cartão o endereço é obrigatório: country em ISO 3166-1 alfa-2 (BR), state como UF (aceitamos BR-SP), zipCode com ou sem hífen (volta com hífen) e complement opcional. Em GET /gateway/producer, o endereço de PJ é o da empresa.

Passo a passo

Envie client.address com country, state, zipCode, city, neighborhood, street e number.
Use a UF em state (SP) e o CEP com 8 dígitos.
Leia o endereço de volta sempre com o CEP formatado.

Já tem conta? Este passo a passo fica em Abrir API, no painel.

Isso ajudou?

Artigos relacionados

Verificação da conta: o que pedimos e por quêPedimos só o que é usado: seus dados pessoais e endereço (o Banco Central manda identificar quem recebe, e os nossos parceiros de pagamento pedem esses mesmos dados), o site ou Instagram onde você vende e, se for empresa, o tipo de empresa e o faturamento médio por mês. O que você vende já veio das perguntas do cadastro. Cada campo tem um exemplo embaixo e confere na hora as regras dos parceiros (nome sem números, como no documento; CEP de 8 números; bairro e cidade sem passar do tamanho). O CEP preenche a rua, o bairro, a cidade e a UF. Na empresa, a razão social (nome oficial no cartão CNPJ) já veio do cadastro; o nome fantasia é o nome da marca e é opcional. Se a sua conta precisa de celular para a verificação de identidade e o do cadastro não serve, a tela pede um celular do Brasil com DDD. Documentos: selfie com o documento, documento com foto (com a CNH digital em PDF, pode enviar sem o verso; a equipe confere se o PDF tem os dois lados) e, na empresa, o contrato social, CCMEI ou cartão CNPJ.
Por que o checkout não pede endereçoO checkout da Korvex é feito para infoproduto (curso, e-book, mentoria, assinatura, evento online): ele não pede endereço de entrega e, no produto digital, mostra “Acesso imediato no seu e-mail” no resumo. Vende produto físico? Cadastre normalmente e pegue o endereço na sua página de vendas: o checkout cobra sem pedir o endereço. As opções de entrega no checkout só aparecem quando a Korvex libera.
API: formato de erro, códigos e limitesTodo erro volta como statusCode, errorCode (GATEWAY_*), message e details. Há limite de vendas pendentes por método e janela (cada venda pendente com cobrança viva ocupa uma vaga; paga, cancelada, expirada ou recusada libera) e de consultas repetidas (TOO_MANY_REQUESTS); a análise de segurança da compra recusa com GATEWAY_TRANSACTION_DENIED.
Como liberar o recebimento no cartão e no boletoNo cartão e no boleto, o nosso parceiro de pagamento deposita direto numa conta no seu nome. Para isso ele precisa de quatro coisas: o cadastro aprovado, a conta bancária no seu CPF ou CNPJ, os dados completos (nome com sobrenome, data de nascimento, celular do Brasil com DDD e o endereço com CEP, rua, bairro, cidade e UF) e uma verificação de identidade rápida (o seu CPF, a foto do documento e uma selfie). O bloco Receber no cartão e no boleto, na Verificação da conta, mostra em que passo você está e, se faltar algo, o nome do campo com o link direto para ele. Complemento é opcional: sem ele, a gente envia "Sem complemento". O Pix funciona normalmente enquanto isso.