Pix Automático | Notificações de Agendamento

Após a autorização concedida pelo usuário pagador por meio de uma das jornadas previstas (AUT1, AUT2, AUT3 ou AUT4), o PSP do recebedor tem de 2 a 10 dias antes da data de liquidação (indicada no momento da autorização) para enviar a instrução de pagamento contendo os dados necessários para realizar o agendamento.

Os eventos relacionados a Pix automático disparam mensagens que comunicam ao destinatário os detalhes sobre os agendamentos do Pix automático.

PIX_AUTOMATIC_PAYMENT_WAS_SCHEDULED

Este evento sinaliza que o agendamento foi realizado com sucesso.

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
`code`	`string`	Código da notificação.
`reason`	`string`	Motivo da notificação.
`isPixOpenBanking`	`boolean`	Transação iniciada por Open Finance.
`recurrence`	`object`	Objeto que contém os dados referentes à recorrência.
`recurrence.requestIdentifier`	`string`	Identificador único da recorrência.
`schedule`	`object`	Objeto que contem os dados do agendamento.
`schedule.endToEndId`	`string`	Identificador da Transação.
`schedule.dateSchedule`	`date`	Data de liquidação do agendamento.
`schedule.expirationDate`	`date`	Data de vencimento do agendamento.
`schedule.status`	`string`	Status do agendamento: `SCHEDULED` - Agendado `SENT` - Pagamento enviado `ERROR` - Erro no pagamento `SUCCESS` - Pagamento liquidado com sucesso `CANCELED` - Pagamento cancelado
`schedule.transactionIdentification`	`string`	Identificador da transação (txid).
`schedule.purpose`	`string`	Tipo do agendamento: `AGND` - Primeiro agendamento `RIFL` - Retentativa de agendamento pós falha `NTAG` - Retentativa pós vencimento
`schedule.finalAttempt`	`boolean`	Indica se o agendamento pode ter retentativas nos próximos dias.
`schedule.amount`	`string`	Valor do agendamento.
`schedule.description`	`string`	Descrição do agendamento.
`schedule.creditor`	`object`	Objeto que contém os dados do recebedor do agendamento.
`schedule.creditor.name`	`string`	Nome do recebedor.
`schedule.creditor.privateIdentification`	`string`	CNPJ do cliente recebedor.
`schedule.creditor.account`	`object`	Objeto que contém os dados da conta do cliente recebedor.
`schedule.creditor.branch`	`string`	Número da agência do recebedor.
`schedule.creditor.number`	`string`	Número da conta do recebedor.
`schedule.creditor.participant`	`string`	ISPB do banco do cliente recebedor.
`schedule.creditor.type`	`string`	Tipo de conta do cliente recebedor. `CACC` - Conta corrente `SVGS` - Conta de Poupança. `TRAN` - Conta de Pagamento.
`schedule.debtor`	`object`	Objeto que contém os dados da conta do cliente pagador.
`schedule.debtor.name`	`string`	Nome do pagador.
`schedule.debtor.privateIdentification`	`string`	CPF ou CNPJ do cliente pagador.
`schedule.debtor.account`	object	Objeto que contém os dados da conta do cliente pagador.
`schedule.debtor.account.branch`	`string`	Número da agência do pagador.
`schedule.debtor.account.number`	`string`	Número da conta do pagador.
`schedule.debtor.account.participant`	`string`	ISPB do banco do cliente pagador.
`schedule.debtor.account.type`	`string`	Tipo de conta do cliente recebedor. `CACC` - Conta corrente `SVGS` - Conta de Poupança. `TRAN` - Conta de Pagamento.
`schedule.debtor.account.companyKey`	`string`	Chave que identifica o parceiro dentro do Bankly.

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": "SC131400882025052972I0WCAUTOM",
  "companyKey": "AUTOMATED_TESTS",
  "idempotencyKey": "bf66caa3-bdfe-4b4e-a265-dd3f11f01525",
  "context": "Pix",
  "metadata": {},
  "name": "PIX_AUTOMATIC_PAYMENT_WAS_SCHEDULED",
  "timestamp": "2025-08-15T13:13:04.7486251Z",
  "correlationId": "cff39660-c365-4e6c-aed3-224ab2bd466f",
  "data": {
    "code": "1528",
    "isPixOpenBanking": false,
    "reason": "Pagamento agendado com sucesso",
    "recurrence": {
      "requestIdentifier": "RAxxxxxxxxyyyyMMddkkkkkkkkkkk"
    },
    "schedule": {
      "endToEndId": "ExxxxxxxxyyyyMMddHHmmkkkkkkkkkkk",
      "dateSchedule": "2025-01-01",
      "expirationDate": "2025-01-01",
      "status": "SCHEDULED",
      "transactionIdentification": "asdjaskdljasdkajdlkajsdlasdjkl",
      "purpose": "AGND",
      "finalAttempt": "true",
      "amount": 1.99,
      "description": "teste de recorrencia",
      "creditor": {
        "name": "RECEBEDOR",
        "privateIdentification": "12312312312",
        "account": {
          "branch": "1234",
          "number": "123456",
          "participant": "12345678",
          "type": "CACC"
        }
      },
      "debtor": {
        "name": "PAGADOR",
        "privateIdentification": "45645645645",
        "account": {
          "branch": "1234",
          "number": "123456",
          "participant": "12345678",
          "type": "CACC",
          "companyKey": "1234567891011"
        }
      }
    }
  },
  "version": "1.0",
  "licenseUuid": "70141cc1-03aa-484e-a3be-ee63c56fb9b7",
  "licenses": [
    {
      "id": "70141cc1-03aa-484e-a3be-ee63c56fb9b7",
      "provider": "BCO BV S.A.",
      "types": ["Banking"]
    }
  ]
}

Código(s) de agendamento pix automático (Code)

O evento PIX_AUTOMATIC_PAYMENT_WAS_SCHEDULED pode receber o seguinte código no campo code, referentes ao cancelamento:

Código	Descrição
1528	Pagamento agendado com sucesso.

PIX_AUTOMATIC_SCHEDULE_PAYMENT_WAS_CANCELED

Este evento sinaliza que o agendamento do pagamento foi CANCELADO a pedido do Recebedor.

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
`code`	`string`	Código da notificação.
`reason`	`string`	Motivo da notificação.
`recurrence`	`object`	Objeto que contém os dados referentes à recorrência.
`recurrence.requestIdentifier`	`string`	Identificador único da recorrência
`schedule`	`object`	Objeto que contem os dados do agendamento
`schedule.endToEndId`	`string`	Identificador da Transação
`schedule.dateSchedule`	`date`	Data de liquidação do agendamento.
`schedule.expirationDate`	`date`	Data de vencimento do agendamento.
`schedule.status`	`string`	Status do agendamento: `SCHEDULED` - Agendado `SENT` - Pagamento enviado `ERROR` - Erro no pagamento `SUCCESS` - Pagamento liquidado com sucesso `CANCELED` - Pagamento cancelado
`schedule.transactionIdentification`	`string`	Identificador da transação (txid)
`schedule.purpose`	`string`	Tipo do agendamento: `AGND` - Primeiro agendamento `RIFL` - Retentativa de agendamento pós falha `NTAG` - Retentativa pós vencimento
`schedule.finalAttempt`	`boolean`	Indica se o agendamento pode ter novas retentativas.
`schedule.amount`	`string`	Valor do agendamento.
`schedule.description`	`string`	Descrição do agendamento.
`schedule.creditor`	`object`	Objeto que contém os dados do recebedor do agendamento.
`schedule.creditor.name`	`string`	Nome do recebedor.
`schedule.creditor.privateIdentification`	`string`	CNPJ do cliente recebedor.
`schedule.creditor.account`	`object`	Objeto que contém os dados da conta do cliente recebedor.
`schedule.creditor.branch`	`string`	Número da agência do recebedor.
`schedule.creditor.number`	`string`	Número da conta do recebedor.
`schedule.creditor.participant`	`string`	ISPB do banco do cliente recebedor.
`schedule.creditor.type`	`string`	Tipo de conta do cliente recebedor. `CACC` - Conta corrente `SVGS` - Conta de Poupança. `TRAN` - Conta de Pagamento.
`schedule.debtor`	`object`	Objeto que contém os dados da conta do cliente pagador.
`schedule.debtor.name`	`string`	Nome do pagador.
`schedule.debtor.privateIdentification`	`string`	CNPJ do cliente pagador.
`schedule.debtor.account`	`object`	Objeto que contém os dados da conta do cliente pagador.
`schedule.debtor.account.branch`	`string`	Número da agência do pagador.
`schedule.debtor.account.number`	`string`	Número da conta do pagador.
`schedule.debtor.account.participant`	`string`	ISPB do banco do cliente pagador.
`schedule.debtor.account.type`	`string`	Tipo de conta do cliente recebedor. `CACC` - Conta corrente `SVGS` - Conta de Poupança. `TRAN` - Conta de Pagamento.
`schedule.debtor.account.companyKey`	`string`	Chave que identifica o parceiro dentro do Bankly.

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": "SC131400882025052972I0WCAUTOM",
  "companyKey": "AUTOMATED_TESTS",
  "idempotencyKey": "bf66caa3-bdfe-4b4e-a265-dd3f11f01525",
  "context": "Pix",
  "metadata": {},
  "name": "PIX_AUTOMATIC_SCHEDULE_PAYMENT_WAS_CANCELED",
  "timestamp": "2025-08-15T13:13:04.7486251Z",
  "correlationId": "cff39660-c365-4e6c-aed3-224ab2bd466f",
  "data": {
    "reason": "Cancelamento de agendamento solicitado pelo Recebedor efetuado com sucesso",
    "code": "1530",
    "recurrence": {
      "requestIdentifier": "RAxxxxxxxxyyyyMMddkkkkkkkkkkk"
    },
    "schedule": {
      "endToEndId": "ExxxxxxxxyyyyMMddHHmmkkkkkkkkkkk",
      "dateSchedule": "2025-01-01",
      "expirationDate": "2025-01-01",
      "status": "SCHEDULED",
      "transactionIdentification": "asdjaskdljasdkajdlkajsdlasdjkl",
      "purpose": "AGND",
      "finalAttempt": "true",
      "amount": 1.99,
      "description": "teste de recorrencia",
      "creditor": {
        "name": "RECEBEDOR",
        "privateIdentification": "12312312312",
        "account": {
          "branch": "1234",
          "number": "123456",
          "participant": "12345678",
          "type": "CACC"
        }
      },
      "debtor": {
        "name": "PAGADOR",
        "privateIdentification": "45645645645",
        "account": {
          "branch": "1234",
          "number": "123456",
          "participant": "12345678",
          "type": "CACC",
          "companyKey": "1234567891011"
        }
      }
    }
  },
  "version": "1.0",
  "licenseUuid": "70141cc1-03aa-484e-a3be-ee63c56fb9b7",
  "licenses": [
    {
      "id": "70141cc1-03aa-484e-a3be-ee63c56fb9b7",
      "provider": "BCO BV S.A.",
      "types": ["Banking"]
    }
  ]
}

Código(s) de agendamento pix automático (Code)

O evento PIX_AUTOMATIC_SCHEDULE_PAYMENT_WAS_CANCELED pode receber o seguinte código no campo code, referentes ao cancelamento:

Código	Descrição
1530	Cancelamento de agendamento solicitado pelo Recebedor efetuado com sucesso.

PIX_AUTOMATIC_SCHEDULE_PAYMENT_WAS_FAILED

Este evento sinaliza os possíveis motivos para insucesso na liquidação do pagamento para o Pix Automático.

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
`code`	`string`	Código da notificação.
`reason`	`string`	Motivo da notificação.
`isPixOpenBanking`	`boolean`	Transação iniciada por Open Finance
`recurrence`	`object`	Objeto que contém os dados referentes à recorrência.
`recurrence.requestIdentifier`	`string`	Identificador único da recorrência
`schedule`	`object`	Objeto que contem os dados do agendamento
`schedule.endToEndId`	`string`	Identificador da Transação
`schedule.dateSchedule`	`date`	Data de liquidação do agendamento.
`schedule.expirationDate`	`date`	Data de vencimento do agendamento.
`schedule.status`	`string`	Status do agendamento: `SCHEDULED` - Agendado `SENT` - Pagamento enviado `ERROR` - Erro no pagamento `SUCCESS` - Pagamento liquidado com sucesso `CANCELED` - Pagamento cancelado
`schedule.transactionIdentification`	`string`	Identificador da transação (txid)
`schedule.purpose`	`string`	Tipo do agendamento: `AGND` - Primeiro agendamento `RIFL` - Retentativa de agendamento pós falha `NTAG` - Retentativa pós vencimento
`schedule.finalAttempt`	`boolean`	Indica se o agendamento pode ter novas retentativas.
`schedule.amount`	`string`	Valor do agendamento.
`schedule.description`	`string`	Descrição do agendamento.
`schedule.paymentInitiator`	`string`	CNPJ do iniciador de pagamento
`schedule.creditor`	`object`	Objeto que contém os dados do recebedor do agendamento.
`schedule.creditor.name`	`string`	Nome do recebedor.
`schedule.creditor.privateIdentification`	`string`	CNPJ do cliente recebedor.
`schedule.creditor.account`	`object`	Objeto que contém os dados da conta do cliente recebedor.
`schedule.creditor.branch`	`string`	Número da agência do recebedor.
`schedule.creditor.number`	`string`	Número da conta do recebedor.
`schedule.creditor.participant`	`string`	ISPB do banco do cliente recebedor.
`schedule.creditor.type`	`string`	Tipo de conta do cliente recebedor. `CACC` - Conta corrente `SVGS` - Conta de Poupança. `TRAN` - Conta de Pagamento.
`schedule.debtor`	`object`	Objeto que contém os dados da conta do cliente pagador.
`schedule.debtor.name`	`string`	Nome do pagador.
`schedule.debtor.privateIdentification`	`string`	CNPJ do cliente pagador.
`schedule.debtor.account`	object	Objeto que contém os dados da conta do cliente pagador.
`schedule.debtor.account.branch`	`string`	Número da agência do pagador.
`schedule.debtor.account.number`	`string`	Número da conta do pagador.
`schedule.debtor.account.participant`	`string`	ISPB do banco do cliente pagador.
`schedule.debtor.account.type`	`string`	Tipo de conta do cliente recebedor. `CACC` - Conta corrente `SVGS` - Conta de Poupança. `TRAN` - Conta de Pagamento.
`schedule.debtor.account.companyKey`	`string`	Chave que identifica o parceiro dentro do Bankly.

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": "SC131400882025052972I0WCAUTOM",
  "companyKey": "AUTOMATED_TESTS",
  "idempotencyKey": "bf66caa3-bdfe-4b4e-a265-dd3f11f01525",
  "context": "Pix",
  "metadata": {},
  "name": "PIX_AUTOMATIC_SCHEDULE_PAYMENT_WAS_FAILED",
  "timestamp": "2025-08-15T13:13:04.7486251Z",
  "correlationId": "cff39660-c365-4e6c-aed3-224ab2bd466f",
  "data": {
    "isPixOpenBanking": true,
    "reason": "O valor do agendamento excedeu o valor máximo autorizado",
    "code": "1515",
    "recurrence": {
      "requestIdentifier": "RAxxxxxxxxyyyyMMddkkkkkkkkkkk"
    },
    "schedule": {
      "endToEndId": "ExxxxxxxxyyyyMMddHHmmkkkkkkkkkkk",
      "dateSchedule": "2025-01-01",
      "expirationDate": "2025-01-01",
      "status": "SCHEDULED",
      "transactionIdentification": "asdjaskdljasdkajdlkajsdlasdjkl",
      "purpose": "AGND",
      "finalAttempt": "true",
      "amount": 1.99,
      "description": "teste de recorrencia",
      "paymentInitiator": "01858774000110",
      "creditor": {
        "name": "RECEBEDOR",
        "privateIdentification": "12312312312",
        "account": {
          "branch": "1234",
          "number": "123456",
          "participant": "12345678",
          "type": "CACC"
        }
      },
      "debtor": {
        "name": "PAGADOR",
        "privateIdentification": "45645645645",
        "account": {
          "branch": "1234",
          "number": "123456",
          "participant": "12345678",
          "type": "CACC",
          "companyKey": "1234567891011"
        }
      }
    }
  },
  "version": "1.0",
  "licenseUuid": "70141cc1-03aa-484e-a3be-ee63c56fb9b7",
  "licenses": [
    {
      "id": "70141cc1-03aa-484e-a3be-ee63c56fb9b7",
      "provider": "BCO BV S.A.",
      "types": ["Banking"]
    }
  ]
}

Códigos de cancelamento (Code)

O evento PIX_AUTOMATIC_SCHEDULE_PAYMENT_WAS_FAILED podem receber os seguintes códigos no campo code, referentes ao cancelamento:

Código	Descrição	Observação
1515	O valor do agendamento excedeu o valor máximo autorizado	—
1516	O valor do agendamento não corresponde ao valor autorizado	—
1531	`TRANSFER_ORDER_NOT_PROCESSED`	Conforme página de erros.
9912	Os seguintes valores podem ser retornados para justificar a falha na liquidação: `SENDER_ACCOUNT_STATUS_NOT_ALLOW_CASH_OUT` `SENDER_ACCOUNT_NOT_FOUND` `SENDER_ACCOUNT_DOES_NOT_MATCH_THE_DOCUMENT` `CASHOUT_LIMIT_NOT_ENOUGH` `TRANSFER_WAS_REPROVED`	Conforme página de erros
9914	`INSUFFICIENT_BALANCE`	Conforme página de erros
9915	`INSUFFICIENT_BALANCE`	Conforme página de erros
9916	`TRANSFER_ORDER_NOT_PROCESSED`	Conforme página de erros
9917	`TRANSFER_ORDER_NOT_PROCESSED`	Conforme página de erros
9918	`TRANSFER_ORDER_NOT_PROCESSED`	Conforme página de erros