Erros
Todo erro volta com o mesmo formato: uma message legível em português, um code estável para o seu código decidir o que fazer e, nos erros de campo, errors com o caminho de cada campo.
Os caminhos seguem o corpo enviado: customer.email, items.0.pix.key.
{ "message": "Dados inválidos", "code": "validation_error", "errors": { "customer.email": [ "O campo e-mail do cliente deve ser um endereço de e-mail válido." ] }}Códigos
validation_error- 422. Campo ausente ou inválido; detalhes em
errors. idempotency_key_required- 422.
POST /chargessem o headerIdempotency-Key. reference_required- 422. Saque ou pré-aprovação sem
referencee semIdempotency-Key. duplicate_reference- 409. A
referencejá foi usada; a resposta traz o registro existente empayoutoupre_approval. request_in_progress- 409. Outro saque da conta está sendo processado agora; tente de novo em instantes.
limit_exceeded- 422. Limite de saque atingido.
reasondiz qual (daily_count_reached,daily_amount_reached,daily_amount_left,per_cashout_amount_exceeded,settlement_hold) econtexttraz os números. processor_rejected- 422. O processador recusou o saque na hora;
processor_statustraz o status recebido. Nada foi debitado. recipient_tax_id_required- 422. A conta exige
recipient.tax_idno saque e ele não foi enviado. recipient_tax_id_invalid- 422. O
recipient.tax_idnão é um CPF/CNPJ válido. key_not_found- 422. Validação da chave: nenhum recebedor encontrado para a chave Pix.
account_not_found- 422. Nenhuma conta vinculada ao acesso do token (credencial sem conta ativa).
access_denied- 403. Sem acesso à conta ou sem a permissão da rota.
account_closed- 403. A conta foi encerrada e não pode movimentar.
not_found- 404. Recurso inexistente ou de outra conta.
processing_error- 400. Falha ao processar a solicitação; a
messageexplica.
Status HTTP
200/201: sucesso (201 quando algo foi criado).202: aceito, falta uma etapa (validação da chave).401: token ausente, inválido ou expirado. Gere outro em/oauth/token.403,404,409,422: veja ocode. Não repita sem corrigir.429: limite de chamadas; aguarde e tente de novo.5xx: instabilidade; repita com a mesma chave de idempotência.