Schemas da API
Esta página contém a documentação detalhada de todos os modelos de dados utilizados na API Autorizou.OrderRequest
Código MCC da transação
Código da venda no estabelecimento
Descrição da transação
CustomerRequest
Nome do cliente
Email do cliente
CardRequest
Dados do cartão criptografados
ID do cliente
RefundRequest
ID do pagamento
Valor em centavos
Error
Código do erro
Mensagem de erro
Payment Status (Status de Pagamento)
Os pagamentos na Autorizou seguem um ciclo de vida com diferentes status. Cada status representa uma etapa específica no processamento do pagamento.Status Gerais
Pagamento autorizado com sucessoO pagamento foi aprovado pela instituição financeira. Para cartão de crédito com captura automática, o valor foi capturado. Para PIX Recorrente, indica que a cobrança foi bem-sucedida.
Aguardando pagamento do cliente
- Boleto: Aguardando pagamento do boleto bancário
- PIX: Aguardando escaneamento do QR Code
- PIX Recorrente: Aguardando primeiro pagamento para autorizar recorrência
Pagamento em processamentoO pagamento está sendo processado pela adquirente. Comum em PIX Recorrente quando a cobrança é enviada para a Adyen (2 dias antes do vencimento).
Pagamento recusadoO pagamento foi negado pela instituição financeira.Motivos comuns:
- Saldo insuficiente
- Cartão bloqueado ou vencido
- Limite de crédito excedido
- Dados inválidos
- Suspeita de fraude
retry_policy = true, o sistema tentará novamente automaticamente (até 3 vezes).Pagamento expiradoO prazo para pagamento expirou sem que o cliente tenha completado a transação.
- Boleto: Passou da data de vencimento
- PIX: QR Code expirou
- PIX Recorrente: QR Code inicial não foi pago no prazo
Pagamento agendadoExclusivo para PIX Recorrente. O pagamento foi agendado para ser processado em uma data futura. Ocorre 3 dias antes da data de cobrança. Utilizado para a primeira cobrança de assinaturas com trial e para posteriores cobranças.
Pagamento estornadoO valor foi devolvido ao cliente completamente. Este é um estado final.
Pagamento estornado parcialmenteParte do valor foi devolvida ao cliente. O pagamento pode receber estornos adicionais até o valor total.
Estornado por chargebackO pagamento foi estornado devido a um chargeback. Este é um estado final e não pode ser revertido.
Estornado por fraudeO pagamento foi identificado como fraudulento e estornado. Este é um estado final e não pode ser revertido.
Estorno solicitadoUm estorno foi solicitado e está sendo processado. Aguardando confirmação da adquirente.
Chargeback confirmadoO cliente contestou a cobrança junto ao banco e o chargeback foi confirmado. O valor foi revertido.
Notificação de chargebackUm chargeback foi iniciado pelo cliente. Você tem prazo limitado para contestar (geralmente 7-10 dias).
Em disputaHá uma disputa ativa sobre o pagamento. Aguardando resolução.
Pagamento liquidadoO pagamento foi processado e liquidado. O valor está disponível para transferência.
Enviado para liquidaçãoO pagamento foi enviado para o processo de liquidação (settlement). Em breve estará disponível.
Erro no processamentoOcorreu um erro técnico durante o processamento. Entre em contato com o suporte se o erro persistir.
Autenticação solicitadaPara cartão de crédito com 3D Secure, indica que o cliente precisa completar a autenticação adicional.
Transições de Status
Os status seguem regras específicas de transição. Nem todos os status podem mudar para qualquer outro status.Fluxo PIX Recorrente
Fluxo Cartão de Crédito
Fluxo PIX / Boleto
Respostas de erro
Guie-se sempre pelo status HTTP. O corpo de erro traz uma mensagem legível e, em erros de validação (422), um objeto errors com a lista por campo:
O
Idempotency-Key obrigatório nas cobranças responde 400 quando ausente e 409 em conflito de
chave (com header Retry-After quando a primeira requisição ainda está em processamento).