Consultar Pix agendado

A funcionalidade de Consulta de Pix Agendado permite que clientes verifiquem o status e os detalhes de uma transação Pix previamente agendada. Com essa API, é possível obter informações como valor, data programada, status atual (pendente, executado, cancelado), além dos dados do destinatário e remetente.

Passos para Integrar

  1. Realizar autenticação na API - [API Reference]
  2. Consultar uma transação Pix - [API Reference]

Fluxo de integração




Consultar um Pix Agendado

cURL da Chamada:

curl --location --request GET 'https://kubernetes.celcoin.dev/dev-celcoin-scheduler-webservice/scheduler/{{schedulerId}}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

👍

Sucesso 200

{
    "version": "1.0.0",
    "status": "SCHEDULED",
    "body": {
        "amount": 0.03,
        "clientCode": "c8d5d424-add6-4392-a65d-fa9e2481c120",
        "initiationType": "MANUAL",
        "transactionType": "TRANSFER",
        "paymentType": "SCHEDULED",
        "urgency": "NORMAL",
        "debitParty": {
            "account": "30053913747534",
            "taxId": "17476020278",
            "name": "Julio dos Santos",
            "branch": "0001",
            "accountType": "CACC",
            "bank": "13935893"
        },
        "creditParty": {
            "bank": "13935893",
            "account": "300539137269",
            "branch": "1",
            "taxId": "17326188106",
            "name": "teste",
            "accountType": "TRAN"
        },
        "schedulerId": "efab7ce4-a4a6-442f-ae46-ae8f6fb385e3",
        "createAt": "2025-04-02T16:15:18.16Z",
        "updateAt": "2025-04-02T16:15:21.819Z",
        "remittanceInformation": "teste",
        "scheduler": {
            "schedulerDate": "2026-01-10",
            "product": "PIX_BAAS"
        }
    }
}

Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "SCH005",
    "message": "Não foi possível processar recuperar o Tenant com os parametros informados"
  }
}

Tabela de errorCode

CodeMessage
SCH005Não foi possível processar recuperar o Tenant com os parametros informados.
SCH041Consulta não pode ser realizada. Verifique os parâmetros informados.
SCH999Ocorreu um erro interno durante o processamento do agendamento.