Autenticação: Publica (sem autenticacao, CSRF dispensado) — use apenas em contextos de servidor confiaveis.
amount e description livres e nao esta vinculado a um registro de venda online.
A busca do vendedor utiliza o id do vendedor presente na URL. Um id legado especifico (fa5f39e4-828b-4b0c-9147-0af813f03f50) e reescrito para um vendedor fixo na infraestrutura de processamento — esse e um ajuste de retrocompatibilidade, nao se apoie nele.
Um cliente da transacao e registrado a cada cobranca bem-sucedida.
Pre-requisitos
- O vendedor deve existir e ter identificador na infraestrutura de processamento (
seller.zoop_id). Veja Cadastrar vendedor. - Para pagamentos que nao sejam PIX, nome/email/telefone do cliente sao obrigatorios (e para boleto: CPF/CNPJ + endereco completo).
Parametros de caminho
UUID do vendedor. Observe que e o id do vendedor, nao o id da conta unificada.
Corpo da requisicao
Nivel raiz:Valor total em BRL como valor decimal em reais (ex.:
"199.90"). Multiplicado por 100 para obter centavos antes do envio. Inconsistencia conhecida com a convencao de centavos do restante da API.Descricao mostrada no extrato/boleto. Maximo 255 caracteres; saneada para ser compativel com a infraestrutura de processamento.
Veja campos aninhados abaixo.
charge:
Um de
credit_card, pix, boleto.Nome completo do comprador (deve conter pelo menos duas partes).
E-mail do comprador.
Telefone do comprador, somente digitos. Validado pelo codigo do pais abaixo.
Codigo do pais do telefone, ex.:
+55.CPF/CNPJ. Obrigatorio quando
type=boleto.Obrigatorio quando
type=boleto. Chaves: line1, line2, neighborhood, city, state (2 letras), postalCode (8 digitos).Numero de parcelas. Obrigatorio quando
type=credit_card. Intervalo 1-21.Obrigatorio quando
type=credit_card. Ou { "id": "<token>" } para cartao tokenizado, ou { "number", "cvv", "name", "expirationMonth", "expirationYear" }.Resposta
200 OK (sim, mesmo na criacao — comportamento historico).
Payload encapsulado com os campos abaixo.
UUID interno da transacao.
Identificador historico da transacao na infraestrutura de processamento (
zoop_id).Status retornado pela infraestrutura de processamento:
succeeded, failed, pending, etc.Presente apenas quando
type=boleto. URL do PDF do boleto hospedado.Presente apenas quando
type=pix. String EMV BR Code (copia e cola).Presente apenas quando
type=pix. Imagem do QR data:image/png;base64,... gerada localmente.Erros
| Status | Quando |
|---|---|
400 | Validacao do corpo falhou, vendedor nao encontrado ou busca invalida. |
402 | Cartao recusado — o payload de erro da infraestrutura de processamento e retornado verbatim. |
405 | Metodo diferente de POST. |
500 | Erro desconhecido na infraestrutura de processamento — a resposta bruta e encaminhada sob acquirerError e a falha e reportada ao monitoramento. |