Skip to main content

Schemas da API

Esta página contém a documentação detalhada de todos os modelos de dados utilizados na API Autorizou.

OrderRequest

mcc
string
required
Código MCC da transação
code
string
required
Código da venda no estabelecimento
description
string
Descrição da transação
customer
object
required
payment
object
required

CustomerRequest

name
string
required
Nome do cliente
email
string
required
Email do cliente
documents
array
required
addresses
array
phone
object

CardRequest

encrypted
string
required
Dados do cartão criptografados
customer_id
string
required
ID do cliente

RefundRequest

payment_id
string
required
ID do pagamento
amount
integer
required
Valor em centavos

Error

code
string
required
Código do erro
message
string
required
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

authorized
status
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.
waiting_payment
status
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
processing
status
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).
refused
status
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
PIX Recorrente: Se retry_policy = true, o sistema tentará novamente automaticamente (até 3 vezes).
expired
status
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
scheduled
status
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.
refunded
status
Pagamento estornadoO valor foi devolvido ao cliente completamente. Este é um estado final.
refunded_partially
status
Pagamento estornado parcialmenteParte do valor foi devolvida ao cliente. O pagamento pode receber estornos adicionais até o valor total.
refunded_chargeback
status
Estornado por chargebackO pagamento foi estornado devido a um chargeback. Este é um estado final e não pode ser revertido.
Chargebacks impactam negativamente a reputação do merchant junto às adquirentes e podem resultar em taxas adicionais.
refunded_fraud
status
Estornado por fraudeO pagamento foi identificado como fraudulento e estornado. Este é um estado final e não pode ser revertido.
Este status indica fraude confirmada. Revise seus processos de prevenção antifraude.
refund_requested
status
Estorno solicitadoUm estorno foi solicitado e está sendo processado. Aguardando confirmação da adquirente.
chargeback
status
Chargeback confirmadoO cliente contestou a cobrança junto ao banco e o chargeback foi confirmado. O valor foi revertido.
chargeback_notification
status
Notificação de chargebackUm chargeback foi iniciado pelo cliente. Você tem prazo limitado para contestar (geralmente 7-10 dias).
disputed
status
Em disputaHá uma disputa ativa sobre o pagamento. Aguardando resolução.
settled
status
Pagamento liquidadoO pagamento foi processado e liquidado. O valor está disponível para transferência.
sent_for_settle
status
Enviado para liquidaçãoO pagamento foi enviado para o processo de liquidação (settlement). Em breve estará disponível.
error
status
Erro no processamentoOcorreu um erro técnico durante o processamento. Entre em contato com o suporte se o erro persistir.
authentication_requested
status
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

Primeiro pagamento:
waiting_payment → authorized → settled
waiting_payment → expired

Cobranças recorrentes:
scheduled → waiting_payment → authorized → settled
scheduled → waiting_payment → refused → scheduled (retry automático)
scheduled → error

Fluxo Cartão de Crédito

processing → authorized → sent_for_settle → settled
processing → refused
authorized → refund_requested → refunded
authorized → chargeback_notification → chargeback

Fluxo PIX / Boleto

waiting_payment → authorized → sent_for_settle → settled
waiting_payment → expired
authorized → refund_requested → refunded

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:
{
  "message": "Pagamento não encontrado."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "email": ["O campo email é obrigatório."]
  }
}
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).