Pix Automático | Notificações de Autorização de Recorrência
Os eventos relacionados a Pix automático disparam mensagens que comunicam ao destinatário os detalhes sobre a autorização de recorrência do Pix automático.
PIX_RECURRENCE_PENDING_REQUEST_AUTH_CONFIRM
Este evento sinaliza que existe uma solicitação de autorização de recorrência pendente de confirmação por parte do usuário pagador.
Descrição do objeto data do evento
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
|---|---|---|
|
| Motivo da notificação |
|
| Código do evento que, neste caso, é 9930 (existe uma solicitação de autorização de recorrência pendente de confirmação por parte do usuário pagador). |
|
| Objeto que contém datas referentes à autorização. |
|
| Data de criação da autorização, no formato ISO 8601 - UTC. |
|
| Data de expiração da autorização, no formato ISO 8601 - UTC. |
|
| Objeto que contém dados da autorização da recorrência de pagamento. |
|
| Identificador único da recorrência, conforme especificação detalhada:
|
|
| Objeto que contém os dados do cliente pagador da recorrência de pagamento. |
|
| CPF ou CNPJ do cliente pagador. |
|
| Objeto que contém os dados da conta do cliente pagador. |
|
| ISPB do banco do cliente pagador. |
|
| Número da conta. |
|
| Número da agência. |
|
| Objeto que contém os dados do usuário devedor da recorrência de pagamento. |
|
| CPF ou CNPJ do usuário devedor. |
|
| Nome do usuário devedor. |
|
| Objeto que contém os dados do recebedor da recorrência de pagamento. |
|
| CNPJ do cliente recebedor. |
|
| Nome do recebedor. |
|
| ISPB do participante do credor |
|
| |
|
| Identificador do objeto da autorização (contrato, pedido, etc.) |
|
| Descrição do serviço/produto associado à recorrência. |
|
| Frequência da recorrência de pagamento, a qual pode ser pode ser: |
|
| Valor do pagamento recorrente. |
|
| Status da autorização de recorrência de pagamento. Neste caso, será PENDING. |
|
| Chave que identifica o parceiro dentro do Bankly. |
|
| Data estimada do primeiro pagamento. |
|
| Data final, compatível com a frequência e data inicial |
Payload do evento
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"licenseUuid": "f64197e4-80b3-4820-bfae-1419049b15b5",
"context": "Pix",
"name": "PIX_RECURRENCE_PENDING_REQUEST_AUTH_CONFIRM",
"version": "1",
"timestamp": "2025-06-24T12:28:06.8095614",
"correlationId": "d921609e-c77a-4385-b8ad-bc33a49bf5b6",
"entityId": "SC0185877420250624JPYHNPAUW9I",
"idempotencyKey": "124f8b49-7819-5ade-99d4-d631aed5a17b",
"licenses": [
{
"id": "f64197e4-80b3-4820-bfae-1419049b15b5",
"provider": "BCO BV S.A.",
"types": [
"Banking"
]
}
],
"data": {
"reason": "Existe uma solicitação de autorização de recorrência pendente de confirmação por parte do usuário pagador",
"code": "9930",
"authorization": {
"creationDateTime": "2025-06-24T12:23:00.106Z",
"expirationDateTime": "2025-06-25T12:23:00.107Z"
},
"recurrence": {
"requestIdentifier": "RN0185877420250624OZ7MEPLP3YS",
"debtor": {
"privateIdentification": "10367443538",
"name": "Teste MELIUZ",
"account": {
"number": "502001481167",
"branch": "2020"
},
"participant": "01858774"
},
"originalDebtor": {
"privateIdentification": "32022137841",
"name": "ALEXANDRE KRUKAS AGUIAR LOPES"
},
"creditor": {
"privateIdentification": "31076696600",
"name": "ANTONIO CARLOS DA SILVA",
"participant": "59588111"
},
"reference": {
"referenceId": "abc123456aafsdf2315",
"description": "Pagamento XPTO"
},
"frequency": "WEEK",
"amount": 100.0,
"status": "PENDING",
"companyKey": "AUTOMATED_TESTS_SDB",
"initialDateSchedule": "2025-06-24",
"finalDateSchedule": "2028-12-31"
}
}
}PIX_RECURRENCE_AUTH_WAS_CONFIRMED
Este evento sinaliza sucesso da confirmação da autorização de recorrência do Pix automático.
Descrição do objeto datado evento
datado eventoO objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
|---|---|---|
|
| Motivo da notificação |
|
| Código do evento que, neste caso, é 9950 (Autorização confirmada com sucesso pelo banco recebedor). |
|
| Objeto que contém dados da autorização da recorrência de pagamento. |
|
| Identificador único da recorrência, conforme especificação detalhada:
|
|
| Objeto que contém os dados do cliente pagador da recorrência de pagamento. |
|
| CPF ou CNPJ do cliente pagador. |
|
| Nome do pagador. |
|
| Objeto que contém os dados da conta do cliente pagador. |
|
| ISPB do banco do cliente pagador. |
|
| Número da conta. |
|
| Número da agência. |
|
| Objeto que contém os dados do recebedor da recorrência de pagamento. |
|
| CNPJ do cliente recebedor. |
|
| Nome do recebedor. |
|
| ISPB do participante do credor |
|
| |
|
| Identificador do objeto da autorização (contrato, pedido, etc.) |
|
| Descrição do serviço/produto associado à recorrência. |
|
| Frequência da recorrência de pagamento, a qual pode ser pode ser: |
|
| Valor do pagamento recorrente. |
|
| Status da autorização de recorrência de pagamento. Neste caso, será APPROVED. |
|
| Chave que identifica o parceiro dentro do Bankly. |
|
| Data estimada do primeiro pagamento. |
|
| Data final, compatível com a frequência e data inicial |
|
| Política de retentativas pós vencimento da recorrência: |
|
| Tipo de autorização: |
|
| Código da cidade |
Payload do evento
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "SC1314008820250602KHYTE1W13O6",
"context": "Pix",
"name": "PIX_RECURRENCE_AUTH_WAS_CONFIRMED",
"correlationId": "47539fec-493a-4f7b-9f89-942053678167",
"companyKey": "AUTOMATED_TESTS_SDB",
"idempotencyKey": "85b8f681-a429-5c49-80a1-da738f69dc15",
"data": {
"reason": "Autorização confirmada com sucesso pelo banco recebedor.",
"recurrence": {
"requestIdentifier": "RR1314008820250602FPIZZW47P9A",
"debtor": {
"privateIdentification": "27273849804",
"name": "Teste BANCO ACESSO",
"participant": "13140088",
"account": {
"number": "1102958724",
"branch": "0001"
}
},
"creditor": {
"privateIdentification": "31076696600",
"name": "ANTONIO CARLOS DA SILVA",
"participant": "59588111"
},
"reference": {
"referenceId": "abc123456aafsdf2315",
"description": "Automation Test f4bbbcee-0905-494b-b342-74f734bd1c49"
},
"frequency": "WEEK",
"amount": 100,
"status": "APPROVED",
"initialDateSchedule": "2025-06-02",
"finalDateSchedule": "2028-12-31",
"authorizationType": "AUT2",
"companyKey": "AUTOMATED_TESTS_SDB"
},
"code": "9950"
},
"version": "1",
"timestamp": "2025-06-02T16:31:44.0029113",
"licenseUuid": "25bcb44c-992c-4cfa-98ef-d344c1ce838a",
"licenses": [
{
"id": "25bcb44c-992c-4cfa-98ef-d344c1ce838a",
"provider": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO",
"types": [
"Banking"
]
}
]
}PIX_RECURRENCE_PENDING_REQUEST_AUTH_CONFIRM_DEADLINE_TODAY
Este evento sinaliza que o prazo para confirmação da solicitação de autorização de recorrência pendente se encerra hoje.
Descrição do objeto data do evento
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
|---|---|---|
|
| Motivo da notificação |
|
| Código do evento que, neste caso, é 9931 (O prazo para confirmação da solicitação de autorização de recorrência pendente se encerra hoje). |
|
| Objeto que contém datas referentes à autorização. |
|
| Data de criação da autorização, no formato ISO 8601 - UTC. |
|
| Data de expiração da autorização, no formato ISO 8601 - UTC. |
|
| Objeto que contém dados da autorização da recorrência de pagamento. |
|
| Identificador único da recorrência, conforme especificação detalhada:
|
|
| Objeto que contém os dados do cliente pagador da recorrência de pagamento. |
|
| CPF ou CNPJ do cliente pagador. |
|
| ISPB do banco do cliente pagador. |
|
| Objeto que contém os dados da conta do cliente pagador. |
|
| Número da conta. |
|
| Número da agência. |
|
| Objeto que contém os dados do usuário devedor da recorrência de pagamento. |
|
| CPF ou CNPJ do usuário devedor. |
|
| Nome do usuário devedor. |
|
| Objeto que contém os dados do recebedor da recorrência de pagamento. |
|
| CNPJ do cliente recebedor. |
|
| Nome do recebedor. |
|
| ISPB do participante do credor |
|
| |
|
| Identificador do objeto da autorização (contrato, pedido, etc.) |
|
| Descrição do serviço/produto associado à recorrência. |
|
| Frequência da recorrência de pagamento, a qual pode ser pode ser: |
|
| Valor do pagamento recorrente. |
|
| Status da autorização de recorrência de pagamento. Neste caso, será PENDING. |
|
| Chave que identifica o parceiro dentro do Bankly. |
|
| Data estimada do primeiro pagamento. |
|
| Data final, compatível com a frequência e data inicial |
Payload do evento
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "SC1314008820250602KHYTE1W13O6",
"companyKey": "AUTOMATED_TESTS_SDB",
"idempotencyKey": "85b8f681-a429-5c49-80a1-da738f69dc15",
"context": "Pix",
"name": "PIX_RECURRENCE_PENDING_REQUEST_AUTH_CONFIRM_DEADLINE_TODAY",
"version": "1",
"timestamp": "2025-06-02T16:31:44.0029113",
"correlationId": "0a5c5f33-7af8-4052-ae60-3443282fb7ac",
"data": {
"reason": "O prazo para confirmação da solicitação de autorização de recorrência pendente se encerra hoje.",
"authorization": {
"creationDateTime": "2025-06-03T15:31:42.863Z",
"expirationDateTime": "2025-06-03T16:31:42.863Z"
},
"recurrence": {
"requestIdentifier": "RR1314008820250602FPIZZW47P9A",
"debtor": {
"privateIdentification": "27273849804",
"participant": "13140088",
"account": {
"number": "1102958724",
"branch": "0001"
}
},
"originalDebtor": {},
"creditor": {
"privateIdentification": "31076696600",
"name": "ANTONIO CARLOS DA SILVA",
"participant": "59588111"
},
"reference": {
"referenceId": "abc123456aafsdf2315",
"description": "Automation Test c2f301b2-10e2-4e66-a319-b48a6fd88052"
},
"frequency": "WEEK",
"status": "PENDING",
"initialDateSchedule": "2025-06-02",
"companyKey": "AUTOMATED_TESTS_SDB"
},
"code": "9931"
},
"licenseUuid": "25bcb44c-992c-4cfa-98ef-d344c1ce838a",
"licenses": [
{
"id": "25bcb44c-992c-4cfa-98ef-d344c1ce838a",
"provider": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO",
"types": [
"Banking"
]
}
]
}PIX_RECURRENCE_AUTH_REQUEST_WAS_CANCELED
Este evento sinaliza que autorização para recorrência de pagamento via Pix automático foi cancelada.
Descrição do objeto data do evento
O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:
Nome | Tipo | Descrição |
|---|---|---|
|
| Motivo da notificação. |
|
| Código do evento que, neste caso, é 9932 ou algum dos motivos listados na tabela de Códigos de Cancelamento. |
|
| Objeto que contém datas referentes à autorização. |
|
| Data de criação da autorização, no formato ISO 8601 - UTC. |
|
| Data de expiração da autorização, no formato ISO 8601 - UTC. |
|
| Objeto que contém dados da autorização da recorrência de pagamento. |
|
| Identificador único da recorrência, conforme especificação detalhada:
|
|
| Objeto que contém os dados do cliente pagador da recorrência de pagamento. |
|
| CPF ou CNPJ do cliente pagador. |
|
| ISPB do banco do cliente pagador. |
|
| Objeto que contém os dados da conta do cliente pagador. |
|
| Número da conta. |
|
| Número da agência. |
|
| Objeto que contém os dados do usuário devedor da recorrência de pagamento. |
|
| CPF ou CNPJ do usuário devedor. |
|
| Nome do usuário devedor. |
|
| Objeto que contém os dados do recebedor da recorrência de pagamento. |
|
| CNPJ do cliente recebedor. |
|
| Nome do recebedor. |
|
| ISPB do participante do credor. |
|
| |
|
| Identificador do objeto da autorização (contrato, pedido, etc.) |
|
| Descrição do serviço/produto associado à recorrência. |
|
| Frequência da recorrência de pagamento, a qual pode ser pode ser: |
|
| Valor do pagamento recorrente. |
|
| Status da autorização de recorrência de pagamento. Neste caso, será PENDING. |
|
| Chave que identifica o parceiro dentro do Bankly. |
|
| Data estimada do primeiro pagamento. |
|
| Data final, compatível com a frequência e data inicial |
|
| Código conforme o campo CancellationReason da mensagem PAIN.011 |
Payload do evento
O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:
Exemplo de payload
{
"entityId": "SC1314008820250602KHYTE1W13O6",
"companyKey": "AUTOMATED_TESTS_SDB",
"idempotencyKey": "85b8f681-a429-5c49-80a1-da738f69dc15",
"licenses": [
{
"id": "25bcb44c-992c-4cfa-98ef-d344c1ce838a",
"provider": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO",
"types": [
"Banking"
]
}
],
"licenseUuid": "25bcb44c-992c-4cfa-98ef-d344c1ce838a",
"context": "Pix",
"name": "PIX_RECURRENCE_AUTH_REQUEST_WAS_CANCELED",
"version": "1",
"timestamp": "2025-06-02T16:31:44.0029113",
"correlationId": "4622d778-e7c7-43a0-a44e-434520ca6640",
"data": {
"reason": "Primeiro pagamento imediato associado à recorrência não foi identificado.",
"recurrence": {
"code": "9955",
"requestIdentifier": "RR1314008820250602FPIZZW47P9A",
"debtor": {
"privateIdentification": "10367443538",
"name": "Teste MELIUZ",
"participant": "13140088",
"account": {
"number": "502001481167",
"branch": "2020"
}
},
"creditor": {
"privateIdentification": "31076696600",
"name": "ANTONIO CARLOS DA SILVA",
"participant": "59588111"
},
"reference": {
"referenceId": "abc123456aafsdf2315",
"description": "Pagamento XPTO"
},
"frequency": "WEEK",
"amount": 100,
"status": "CANCELED",
"initialDateSchedule": "2025-06-02",
"finalDateSchedule": "2028-12-31",
"authorizationType": "AUT2",
"companyKey": "AUTOMATED_TESTS_SDB"
}
}
}Códigos de cancelamento (Code)
O evento PIX_RECURRENCE_AUTH_REQUEST_WAS_CANCELED podem receber os seguintes códigos no campo code, referentes ao cancelamento:
| Código | Descrição |
|---|---|
| 9932 | Solicitação de recorrência cancelada por ausência de resposta. |
| 9933 | Solicitação de recorrência cancelada porque o usuário pagador realizou a confirmação da mesma recorrência por meio de outra jornada. |
| 9934 | Solicitação de recorrência cancelada por erro na confirmação da recorrência. |
| 9935 | Solicitação de recorrência cancelada. |
| 9936 | Autorização de recorrência cancelada a pedido do recebedor. |
| 9951 | Divergência no campo de atualização dos dados da recorrência para os pagamentos periódicos e o status da recorrência para os pagamentos periódicos (exemplo: falta de sincronização). |
| 9952 | ID da recorrência inválido ou não corresponde ao original. |
| 9953 | Status da recorrência para os pagamentos periódicos inconsistente. |
| 9954 | CPF/CNPJ do usuário recebedor diferente do constante na pain.009 ou do payload. Ou, no caso de cancelamento, o CPF/CNPJ usuário recebedor não coincide com o contido nos dados da recorrência para os pagamentos periódicos. |
| 9955 | Primeiro pagamento imediato associado à recorrência não foi identificado. (Válido apenas para a Jornada 3 de autorização.) |
| 9956 | ISPB do PSP pagador diverge da informação contida na recorrência para pagamentos periódicos. |
| 9957 | ISPB do PSP recebedor diverge da informação contida na recorrência para pagamentos periódicos. |
| 9958 | Preenchimento do conteúdo da mensagem incorreto ou incompatível com as regras de negócio. |
| 9959 | Participante não se encontra cadastrado ou ainda não iniciou a operação no SPI. |
| 9960 | ISPB do participante do usuário recebedor inválido ou inexistente. |
| 9961 | O recebedor não respondeu dentro de uma hora. |
Updated 2 days ago
