Status e Códigos de Erro

Disponível apenas em Sandbox

O Pix Automático está disponível somente no ambiente Sandbox. Não há suporte em produção no momento.

O link, a autorização e a cobrança têm status próprios, retornados no campo current_status das consultas e dos webhooks.

Status do link

Status	Significado
created	Link criado, ainda não acessado pelo cliente.
processing	O cliente acessou o link e a autorização está em andamento.
completed	Jornada finalizada. Consulte o status da autorização para saber se foi aprovada ou rejeitada.
canceled	Link cancelado por você antes da conclusão.
expired	O link expirou antes de o cliente concluir a autorização.
error	Falha no processamento do link. Veja o objeto error.

Status da autorização

Status	Significado
awaiting_authorization	Status inicial. Aguardando a aprovação do cliente no banco.
partially_accepted	Conta com múltiplos aprovadores (comum em pessoa jurídica): parte aprovou e os demais ainda não.
authorized	Aprovada. Cobranças já podem ser agendadas.
rejected	Não aprovada pelo cliente ou expirou antes da aprovação. Não pode mais ser usada. Veja o objeto rejection.
revoked	Estava aprovada e foi revogada pelo cliente, por você ou pelo banco do cliente. Veja o objeto revocation.
consumed	Autorização utilizada até o fim do seu propósito.
canceled	Cancelada por ação externa.
expired	Atingiu o fim da vigência.

Status da cobrança

Status	Significado
pending	Cobrança recebida e em validação.
scheduled	Agendada para a data informada.
processing	Enviada para liquidação.
debited	Valor debitado da conta do cliente.
paid	Valor creditado na conta recebedora. Status final de sucesso.
rejected	Cobrança recusada. Veja o error.code.
canceled	Cancelada antes da liquidação.

Códigos de rejeição

Rejeições de cobrança

Retornadas no campo error.code da cobrança.

Código	Significado
insufficient_balance	Conta do cliente sem saldo suficiente.
amount_above_limit	Valor acima do limite de Pix Automático definido pelo cliente no banco. Esse limite é separado do limite diário do Pix comum.
invalid_amount	Valor enviado não é válido.
reason_not_informed	O banco do cliente não informou o motivo (pode ter sido bloqueio do antifraude do banco).
payment_authorization_mismatch	Dados da cobrança não batem com a autorização.
refused_by_bank	Recusado pelo banco do cliente. O motivo vem em error.detail.
refused_by_spi	Recusado pelo Sistema de Pagamentos Instantâneos (SPI).
invalid_authorization	Autorização inválida, expirada ou não aprovada.
authorization_pending_approval	Autorização ainda aguardando a aprovação de todos os aprovadores.
authorization_revoked	Autorização revogada.
account_holder_mismatch	A conta não pertence mais ao CPF ou CNPJ da autorização.
period_amount_limit_exceeded	Valor acumulado no período passou do permitido.
period_quantity_limit_exceeded	Quantidade de cobranças no período passou do permitido (ex.: duas cobranças no mês em autorização mensal).
charge_amount_limit_exceeded	Valor da cobrança acima do teto por cobrança definido pelo cliente.
total_amount_limit_exceeded	O valor total da autorização foi atingido.
attempts_limit_exceeded	Número máximo de tentativas do arranjo atingido.
outside_allowed_period	Data agendada fora da vigência da autorização ou fora do prazo de envio.
insufficient_permission	Operação não permitida para esta autorização.
invalid_retry_details	Na retentativa, algum dado difere da cobrança original.
invalid_payment_details	Algum parâmetro não respeita as regras do arranjo.
missing_parameter	Parâmetro obrigatório ausente.
invalid_parameter	Parâmetro inválido.
idempotency_error	Requisição duplicada com dados divergentes.
same_source_and_destination_account	A conta de origem é igual à de destino.
scheduling_failure	Não foi possível agendar a cobrança.
infrastructure_failure	Falha de infraestrutura não especificada.
spi_failure	Falha no SPI.
dict_failure	Falha no DICT (diretório de chaves Pix).
icp_failure	Falha na Infraestrutura de Chaves Públicas.
receiving_institution_failure	Falha na instituição recebedora.
bank_failure	Falha no banco do cliente.

Rejeições de autorização

Retornadas no campo rejection.code da autorização e no error.code do link.

Código	Significado
rejected_by_customer	O cliente recusou a autorização.
authorization_time_expired	O cliente não aprovou dentro do prazo.
journey_time_expired	O cliente não finalizou a jornada a tempo.
account_not_allowed	O tipo de conta escolhido não permite Pix Automático (ex.: conta salário).
same_source_and_destination_account	A conta do cliente é igual à conta recebedora.
authorization_attempts_exceeded	Excedido o número de tentativas de criar a autorização.
invalid_payment_method	Forma de pagamento inválida.
invalid_payment_date	Data de pagamento inválida.
missing_parameter	Parâmetro obrigatório ausente.
invalid_parameter	Parâmetro inválido.
infrastructure_failure	Falha de infraestrutura durante a jornada.

Ação recomendada

Situação	O que fazer
insufficient_balance e amount_above_limit	Avise o cliente, sugira verificar o saldo e o limite de Pix Automático no banco e retente dentro da janela.
authorization_revoked	Interrompa as cobranças e ofereça um novo link de autorização.
payment_authorization_mismatch, period_amount_limit_exceeded, period_quantity_limit_exceeded, charge_amount_limit_exceeded e total_amount_limit_exceeded	Revise valor e data em relação às regras da autorização. Se o valor mudou, gere uma nova autorização.
Falhas de infraestrutura (infrastructure_failure e demais códigos terminados em _failure)	Retente dentro da janela permitida.