Status e Códigos de Erro
Disponível apenas em Sandbox
O Pix Agendado está disponível somente no ambiente Sandbox. Não há suporte em produção no momento.
O Pix Agendado não está disponível para todas as contas e depende de habilitação prévia pela Marlim. Para verificar a elegibilidade da sua conta, entre em contato com o nosso time comercial.
O link e cada pagamento 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 aprovação está em andamento. |
payment_pending | O cliente aprovou o agendamento e há pagamentos a liquidar. |
completed | Todas as datas do agendamento foram processadas. Consulte cada pagamento para saber o resultado. |
canceled | Link cancelado por você antes da aprovação. |
expired | O link expirou antes de o cliente concluir a aprovação. |
error | A jornada terminou sem aprovação ou houve falha no processamento. Veja o objeto error. |
Status do pagamento
| Status | Significado |
|---|---|
pending | Pagamento recebido e em validação. |
awaiting_authorization | Aguardando a aprovação do cliente no banco. |
authorized | Aprovado pelo cliente. Aguardando o agendamento no banco. |
scheduled | Agendado no banco do cliente para a data informada. |
processing | Enviado para liquidação. |
paid | Valor creditado na conta recebedora. Status final de sucesso. |
rejected | Pagamento recusado. Veja o error.code. |
canceled | Cancelado antes da liquidação, pelo cliente no banco dele ou por você. |
expired | O cliente não aprovou antes da expiração do link. |
Códigos de rejeição
Rejeições da aprovação
Retornadas no campo error.code do link.
| Código | Significado |
|---|---|
rejected_by_customer | O cliente recusou o agendamento no banco. |
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 Agendado (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 aprovação. |
invalid_payment_method | Forma de recebimento 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. |
Rejeições de pagamento
Retornadas no campo error.code de cada pagamento.
| Código | Significado |
|---|---|
insufficient_balance | Conta do cliente sem saldo suficiente, mesmo após a nova tentativa do banco no dia. |
amount_above_limit | Valor acima do limite de Pix definido pelo cliente no banco. |
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). |
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). |
account_holder_mismatch | A conta não pertence mais ao CPF ou CNPJ do pagador. |
invalid_payment_details | Algum parâmetro não respeita as regras do arranjo. |
same_source_and_destination_account | A conta de origem é igual à de destino. |
scheduling_failure | Não foi possível agendar o pagamento no banco do cliente. |
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. |
Ação recomendada
| Situação | O que fazer |
|---|---|
insufficient_balance e amount_above_limit | Avise o cliente e ofereça outra forma de pagamento para a data que falhou. Os demais pagamentos do agendamento continuam valendo. |
rejected_by_customer, authorization_time_expired e journey_time_expired | Pergunte ao cliente se ele quer tentar de novo e crie um novo link. |
account_holder_mismatch | O cliente trocou de conta. Cancele os pagamentos restantes e crie um novo link. |
Falhas de infraestrutura (infrastructure_failure e demais códigos terminados em _failure) | Ofereça outra forma de pagamento para a data que falhou. Se o problema se repetir, fale com o nosso suporte. |