Notificações de Agendamento Único e Agendamento Recorrente

Os eventos a seguir disparam mensagens que comunicam ao destinatário os detalhes sobre os Agendamentos Únicos e/ou Agendamentos Recorrentes.

PIX_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
`schedule`	`object`	Objeto que contem os dados do agendamento
`schedule.liquidationCodeSubType`	`string`	Subtipo do código de liquidação
`schedule.dateSchedule`	`date`	Data de liquidação do agendamento.
`schedule.requestIdentifier`	`date`	Identificador da solicitação de agendamento.
`schedule.schedulingUniqueKey`	`string`	Identificador do agendamento interno no sistema de gestão de agendamento
`schedule.status`	`string`	Status do agendamento
`recurrence`	`object`	Objeto que contém os dados referentes à recorrência.
`recurrence.frequency`	`Enum`	Frequência da recorrência de pagamento.
`recurrence.initialDateSchedule`	`string`	Data inicial da recorrência.
`recurrence.finalDateSchedule`	`string`	Data final da recorrência
`recurrence.repetition`	`string`	Repetição da recorrência
`recurrence.interbankSettlementAmount`	`string`	Valor de liquidação interbancária
`recurrence.description`	`string`	Descrição da recorrência.
`recurrence.requestIdentifier`	`string`	Identificador da solicitação de recorrência
`recurrence.status`	`string`	Status da recorrência
`payment`	`object`	Objeto que contém os dados do pagamento
`payment.initiationForm`	`string`	Forma de iniciação do pagamento `DICT` - pagamento por chave Pix `MANU` - pagamento por inserção manual dos dados da conta transacional do usuário recebedor `QRDN` - pagamento por QR code dinâmico na modalidade de cobrança com vencimento `QRES` - pagamento por QR code estático `INIC` - pagamento iniciado por open finance `AUTO` - pagamento Pix Automático
`payment.interbankSettlementAmount`	`string`	Valor do agendamento interbancário
`payment.description`	`string`	Descrição do pagamento
`payment.creditor`	`objeto`	Objeto que deve conter os dados do recebedor da recorrência de pagamento.
`payment.creditor.name`	`string`	Nome do recebedor
`payment.creditor.agentMemberIdentification`	`string`	ISPB do banco do recebedor
`payment.creditor.privateIdentification`	`string`	CNPJ do cliente recebedor
`payment.creditor.accountProxy`	`string`	Chave Pix do recebedor
`payment.debtor`	`object`	Objeto que contém os dados da conta do cliente pagador.
`payment.debtor.name`	`string`	Nome do pagador.
`payment.debtor.agentMemberIdentification`	object	ISPB do banco do pagador.
`payment.debtor.privateIdentification`	`string`	CNPJ do cliente pagador.
`payment.debtor.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": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a",
  "companyKey": "AUTOMATED_TESTS",
  "idempotencyKey": "bf66caa3-bdfe-4b4e-a265-dd3f11f01525",
  "context": "Pix",
  "metadata": {},
  "name": "PIX_PAYMENT_WAS_SCHEDULED",
  "timestamp": "2025-08-15T13:13:04.7486251Z",
  "correlationId": "cff39660-c365-4e6c-aed3-224ab2bd466f",
  "data": {
    "code": "9911",
    "isPixOpenBanking": false,
    "reason": "Novo agendamento criado",
    "schedule": {
      "liquidationCodeSubType": "1",
      "dateSchedule": "2024-09-05",
      "requestIdentifier": "E9999901012341234123412345678900",
      "schedulingUniqueKey": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a",
      "status": "SCHEDULED"
    },
    "recurrence": {
      "frequency": "MONTHLY",
      "initialDateSchedule": "2024-09-05",
      "finalDateSchedule": "2024-10-10",
      "repetition": 12,
      "interbankSettlementAmount": 1.99,
      "description": "Recorrencia 1",
      "requestIdentifier": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a",
      "status": "PROCESSING"
    },
    "payment": {
      "initiationForm": "DICT",
      "interbankSettlementAmount": 1.99,
      "description": "teste de recorrencia",
      "creditor": {
        "name": "RECEBEDOR",
        "agentMemberIdentification": "99999010",
        "privateIdentification": "12312312312",
        "accountProxy": "[email protected]"
      },
      "debtor": {
        "name": "PAGADOR",
        "agentMemberIdentification": "99999010",
        "privateIdentification": "45645645645",
        "companyKey": "TEST_COMPANY"
      }
    }
  },
  "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_PAYMENT_WAS_SCHEDULED pode receber o seguinte código no campo code, referentes ao cancelamento:

Código	Descrição
9911	Novo agendamento criado.

PIX_SCHEDULE_PAYMENT_WAS_FAILED

Este evento sinaliza os possíveis motivos para insucesso na liquidação do pagamento para o agendamento recorrente.

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.frequency`	`Enum`	Frequência da recorrência de pagamento.
`recurrence.initialDateSchedule`	`string`	Data inicial da recorrência.
`recurrence.finalDateSchedule`	`string`	Data final da recorrência
`recurrence.repetition`	`string`	Repetição da recorrência
`recurrence.interbankSettlementAmount`	`string`	Valor de liquidação interbancária
`recurrence.description`	`string`	Descrição da recorrência.
`recurrence.requestIdentifier`	`string`	Identificador da solicitação de recorrência
`recurrence.status`	`string`	Status da recorrência
`payment`	`object`	Objeto que contém os dados do pagamento
`payment.initiationForm`	`string`	Forma de iniciação do pagamento `DICT` - pagamento por chave Pix `MANU` - pagamento por inserção manual dos dados da conta transacional do usuário recebedor `QRDN` - pagamento por QR code dinâmico na modalidade de cobrança com vencimento `QRES` - pagamento por QR code estático `INIC` - pagamento iniciado por open finance `AUTO` - pagamento Pix Automático
`payment.interbankSettlementAmount`	`string`	Valor do agendamento interbancário
`payment.description`	`string`	Descrição do pagamento
`payment.creditor`	`objeto`	Objeto que deve conter os dados do recebedor da recorrência de pagamento.
`payment.creditor.name`	`string`	Nome do recebedor
`payment.creditor.agentMemberIdentification`	`string`	ISPB do banco do recebedor
`payment.creditor.privateIdentification`	`string`	CNPJ do cliente recebedor
`payment.creditor.accountProxy`	`string`	Chave Pix do recebedor
`payment.debtor`	`object`	Objeto que contém os dados da conta do cliente pagador.
`payment.debtor.name`	`string`	Nome do pagador.
`payment.debtor.agentMemberIdentification`	object	ISPB do banco do pagador.
`payment.debtor.privateIdentification`	`string`	CNPJ do cliente pagador.
`immediatePayment`	`string`	Chave que identifica o parceiro dentro do Bankly.
`immediatePayment.endToEndIdentification`	`string`	Identificação do pagamento imediato
`immediatePayment.status`	`string`	Status do pagamento imediato: `COMPLETED` - Será retornado `COMPLETED` quando o pagamento imediato for efetuado com sucesso, porém houve falha ao criar a recorrência do agendamento. `UNSUCCESSFULLY_COMPLETED` - Será retornado `UNSUCCESSFULLY_COMPLETED` quando houver falha no pagamento imediato, impossibilitando a criação da recorrência do agendamento

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": "82621ced-f4c0-4188-9922-37a99ae7732e",
  "companyKey": "AUTOMATED_TESTS",
  "idempotencyKey": "bf66caa3-bdfe-4b4e-a265-dd3f11f01525",
  "context": "Pix",
  "metadata": {},
  "name": "PIX_SCHEDULE_PAYMENT_WAS_FAILED",
  "timestamp": "2025-08-15T13:13:04.7486251Z",
  "correlationId": "cff39660-c365-4e6c-aed3-224ab2bd466f",
  "data": {
    "code": "9910",
    "isPixOpenBanking": false,
    "reason": "Recorrência não criada",
    "recurrence": {
      "frequency": "MONTHLY",
      "initialDateSchedule": "2024-09-05",
      "finalDateSchedule": "2024-10-10",
      "repetition": 12,
      "interbankSettlementAmount": 1.99,
      "description": "Recorrencia 1",
      "requestIdentifier": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a",
      "status": "ERROR"
    },
    "payment": {
      "initiationForm": "DICT",
      "interbankSettlementAmount": 1.99,
      "description": "teste de recorrencia",
      "creditor": {
        "name": "RECEBEDOR",
        "agentMemberIdentification": "99999010",
        "privateIdentification": "12312312312",
        "accountProxy": "[email protected]"
      },
      "debtor": {
        "name": "PAGADOR",
        "agentMemberIdentification": "99999010",
        "privateIdentification": "45645645645"
      }
    },
    "immediatePayment": {
      "endToEndIdentification": "E5958811120240117124513393PQE019",
      "status": "COMPLETED"
    }
  },
  "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_SCHEDULE_PAYMENT_WAS_FAILED pode receber os seguintes códigos no campo code, referentes ao cancelamento:

Código	Descrição	Observação
9910	Recorrência não criada	—

PIX_SCHEDULE_PAYMENT_WAS_FAILED

Este evento sinaliza os possíveis motivos para insucesso na liquidação do pagamento para o agendamento único e/ou recorrente.

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
`schedule`	`object`	Objeto que contem os dados do agendamento
`schedule.liquidationCodeSubType`	`string`	Subtipo do código de liquidação
`schedule.dateSchedule`	`date`	Data de liquidação do agendamento.
`schedule.requestIdentifier`	`date`	Identificador da solicitação de agendamento.
`schedule.schedulingUniqueKey`	`string`	Identificador do agendamento interno no sistema de gestão de agendamento
`schedule.status`	`string`	Status do agendamento
`recurrence`	`object`	Objeto que contém os dados referentes à recorrência.
`recurrence.frequency`	`Enum`	Frequência da recorrência de pagamento.
`recurrence.initialDateSchedule`	`string`	Data inicial da recorrência.
`recurrence.finalDateSchedule`	`string`	Data final da recorrência
`recurrence.repetition`	`string`	Repetição da recorrência
`recurrence.interbankSettlementAmount`	`string`	Valor de liquidação interbancária
`recurrence.description`	`string`	Descrição da recorrência.
`recurrence.requestIdentifier`	`string`	Identificador da solicitação de recorrência
`recurrence.status`	`string`	Status da recorrência
`payment`	`object`	Objeto que contém os dados do pagamento
`payment.initiationForm`	`string`	Forma de iniciação do pagamento `DICT` - pagamento por chave Pix `MANU` - pagamento por inserção manual dos dados da conta transacional do usuário recebedor `QRDN` - pagamento por QR code dinâmico na modalidade de cobrança com vencimento `QRES` - pagamento por QR code estático `INIC` - pagamento iniciado por open finance `AUTO` - pagamento Pix Automático
`payment.interbankSettlementAmount`	`string`	Valor do agendamento interbancário
`payment.description`	`string`	Descrição do pagamento
`payment.creditor`	`objeto`	Objeto que deve conter os dados do recebedor da recorrência de pagamento.
`payment.creditor.name`	`string`	Nome do recebedor
`payment.creditor.agentMemberIdentification`	`string`	ISPB do banco do recebedor
`payment.creditor.privateIdentification`	`string`	CNPJ do cliente recebedor
`payment.creditor.accountProxy`	`string`	Chave Pix do recebedor
`payment.debtor`	`object`	Objeto que contém os dados da conta do cliente pagador.
`payment.debtor.name`	`string`	Nome do pagador.
`payment.debtor.agentMemberIdentification`	object	ISPB do banco do pagador.
`payment.debtor.privateIdentification`	`string`	CNPJ do cliente pagador.
`payment.debtor.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": "82621ced-f4c0-4188-9922-37a99ae7732e",
  "companyKey": "AUTOMATED_TESTS",
  "idempotencyKey": "bf66caa3-bdfe-4b4e-a265-dd3f11f01525",
  "context": "Pix",
  "metadata": {},
  "name": "PIX_SCHEDULE_PAYMENT_WAS_FAILED",
  "timestamp": "2025-08-15T13:13:04.7486251Z",
  "correlationId": "cff39660-c365-4e6c-aed3-224ab2bd466f",
  "data": {
    "code": "9912",
    "isPixOpenBanking": true,
    "reason": "Falha na pré-validação do canal",
    "schedule": {
      "liquidationCodeSubType": "1",
      "dateSchedule": "2024-09-05",
      "requestIdentifier": "E9999901012341234123412345678900",
      "schedulingUniqueKey": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a",
      "status": "UNSUCCESSFULLY_COMPLETED"
    },
    "payment": {
      "initiationForm": "DICT",
      "interbankSettlementAmount": 1.99,
      "description": "teste de recorrencia",
      "paymentInitiator": "12345678901234",
      "creditor": {
        "name": "RECEBEDOR",
        "agentMemberIdentification": "99999010",
        "privateIdentification": "12312312312",
        "accountProxy": "[email protected]"
      },
      "debtor": {
        "name": "PAGADOR",
        "agentMemberIdentification": "99999010",
        "privateIdentification": "45645645645",
        "companyKey": "TEST_COMPANY"
      }
    }
  },
  "version": "1.0",
  "licenseUuid": "70141cc1-03aa-484e-a3be-ee63c56fb9b7",
  "licenses": [
    {
      "id": "70141cc1-03aa-484e-a3be-ee63c56fb9b7",
      "provider": "BCO BV S.A.",
      "types": ["Banking"]
    }
  ]
}

{
  "entityId": "82621ced-f4c0-4188-9922-37a99ae7732e",
  "companyKey": "AUTOMATED_TESTS",
  "idempotencyKey": "bf66caa3-bdfe-4b4e-a265-dd3f11f01525",
  "context": "Pix",
  "metadata": {},
  "name": "PIX_SCHEDULE_PAYMENT_WAS_FAILED",
  "timestamp": "2025-08-15T13:13:04.7486251Z",
  "correlationId": "cff39660-c365-4e6c-aed3-224ab2bd466f",
  "data": {
    "code": "9912",
    "isPixOpenBanking": false,
    "reason": "dsMotivoInsucesso enviado pelo canal",
    "schedule": {
      "liquidationCodeSubType": "1",
      "dateSchedule": "2024-09-05",
      "requestIdentifier": "E9999901012341234123412345678900",
      "schedulingUniqueKey": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a",
      "status": "UNSUCCESSFULLY_COMPLETED"
    },
    "recurrence": {
      "frequency": "MONTLHY",
      "initialDateSchedule": "2024-09-05",
      "finalDateSchedule": "2024-10-10",
      "repetition": 12,
      "interbankSettlementAmount": 1.99,
      "description": "Recorrencia 1",
      "requestIdentifier": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a",
      "status": "PROCESSING"
    },
    "payment": {
      "initiationForm": "DICT",
      "interbankSettlementAmount": 1.99,
      "description": "teste de recorrencia",
      "creditor": {
        "name": "RECEBEDOR",
        "agentMemberIdentification": "99999010",
        "privateIdentification": "12312312312",
        "accountProxy": "[email protected]"
      },
      "debtor": {
        "name": "PAGADOR",
        "agentMemberIdentification": "99999010",
        "privateIdentification": "45645645645",
        "companyKey": "TEST_COMPANY"
      }
    }
  },
  "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_SCHEDULE_PAYMENT_WAS_FAILED pode receber os seguintes códigos no campo code, referentes ao cancelamento:

Código	Descrição	Observação
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
9913	`RECIPIENT_ACCOUNT_DOES_NOT_MATCH_THE_DOCUMENT`	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
9920	`INVALID_QR_CODE_PARAMETERS`	Conforme página de erros