Agendar uma transação Pix

Suggest Edits

O Agendador de Transações Pix permite que clientes realizem agendamentos de transações Pix, proporcionando flexibilidade e automação nos processos financeiros. Com essa funcionalidade, é possível programar transferências para datas futuras.

Passos para Integrar

Realizar autenticação na API - [API Reference]
Agendar uma transação Pix - [API Reference]

Fluxo de integração

Realizar agendamento de Pix

Para agendar uma transação, utilize a mesma chamada do pix-out, incluindo o objeto scheduler com a data de execução desejada, diferente da data atual.

 "scheduler": {
         "schedulerDate": "2025-05-22"
    }

JSON Completo de exemplo

{
    "amount": 0.01,
    "clientCode": "{{clientCode}}",
    "initiationType": "MANUAL",
    "paymentType": "IMMEDIATE",
    "urgency": "HIGH",
    "transactionType": "TRANSFER",
    "debitParty": {
        "account": "40002"
    },
    "creditParty": {
        "bank": "08561701",
        "account": "305157919",
        "branch": "1",
        "taxId": "06237998128",
        "name": "Julio",
        "accountType": "CACC"
    },
    "remittanceInformation": "Texto de mensagem",
    "scheduler": {
         "schedulerDate": "2025-05-22"
    }
}

cURL da chamada

curl --location 'https://sandbox.openfinance.celcoin.dev/baas/v2/pix/payment' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "amount": 8.83,
    "clientCode": "d9d81ab3-31c2-40fb-bce2-7cae85f507a9",
    "initiationType": "MANUAL",
    "transactionType": "TRANSFER",
    "paymentType": "IMMEDIATE",
    "urgency": "HIGH",
    "debitParty": {
        "bank": "13935893",
        "account": "30053913747534",
        "branch": "0001",
        "taxId": "17476020278",
        "name": "Julio dos Santos",
        "accountType": "CACC"
    },
   "creditParty": {
        "taxId": "17326188106",
        "bank": "13935893",
        "account": "42689",
        "branch": "1",
        "name": "teste",
        "accountType": "TRAN",  
        "personType": "NATURAL_PERSON"
    },
    "scheduler": {
        "schedulerDate": "2026-01-10"
    },
    "remittanceInformation": "teste"
}'

Sempre que um agendamento for realizado, será retornado o schedulerId, que permitirá que seja consultado o status daquela transação no futuro.
Lembre-se que é obrigatório que na data de execução do agendamento exista saldo em conta para que o agendamento seja realizado com sucesso.
Uma vez que a transação foi agendada, não é necessário nenhuma outra ação, a Celcoin se encarregará 100% do fluxo de execução.

Exemplo de retorno

👍
Sucesso 200

{
    "body": {
        "amount": 0.03,
        "clientCode": "59f844d7-a2c9-4de3-9545-572f574fc928",
        "creditParty": {
            "account": "305157919",
            "accountType": "CACC",
            "bank": "08561701",
            "branch": "1",
            "name": "Julio dos Santos",
            "taxId": "06237998128"
        },
        "debitParty": {
            "account": "300539137269",
            "accountType": "TRAN",
            "bank": "13935893",
            "branch": "0001",
            "name": "Ms. Otis Schimmel",
            "taxId": "82425260609"
        },
        "initiationType": "MANUAL",
        "paymentType": "SCHEDULED",
        "remittanceInformation": "Texto de mensagem",
        "scheduler": {
            "schedulerDate": "2025-05-25",
            "schedulerId": "6d1dbb8f-f4ed-4a52-b893-1ef95d6768be",
            "source": "PIX_BAAS"
        },
        "transactionType": "TRANSFER",
        "urgency": "NORMAL"
    },
    "status": "CREATED",
    "version": "1.0.0"
}

❗
Error 400

{
  "version": "1.0.0",
  "status": "ERROR",
  "error": {
    "errorCode": "SCH085",
    "message": "Agendamento nao autorizado. Existe um agendamento identico para mesma data."
  }
}

Tabela de errorCode

Code	Message
SCH019	amount invalido. Favor verificar a formatação do campo e deve ser a partir de R$ 0,01.
SCH018	amount é obrigatório.
SCH020	ClientCode é obrigatório.
SCH021	ClientCode possui tamanho maximo de 200 caracteres.
SCH006	initiationType invalido.
SCH022	transactionType invalido.
SCH023	paymentType invalido.
SCH024	urgency invalido.
SCH017	debitParty é obrigatório.
SCH012	creditParty é obrigatório.
SCH001	Objeto Scheduler inválido.
SCH025	remittanceInformation é obrigatório.
SCH026	remittanceInformation possui tamanho maximo de 140 caracteres.
SCH027	debitParty.account é obrigatório.
SCH028	debitparty.account possui tamanho maximo de 20 caracteres.
SCH013	creditParty.taxId inválido.
SCH029	creditParty.name é obrigatório e possui tamanho maximo de 120 caracteres.
SCH030	creditParty.branch é obrigatório.
SCH031	creditParty.branch invalido.
SCH032	creditParty.accountType não foi informado ou é invalido.
SCH084	debitParty.bank é obrigatório e deve existir na lista de participantes Pix.
SCH033	creditParty.bank é obrigatório e deve existir na lista de participantes Pix.
SCH039	creditParty.account inválido.
SCH036	schedulerDate é obrigatório.
SCH003	Conta inválida
SCH035	emv é obrigatório.
SCH014	creditParty.key é obrigatório.
SCH085	Agendamento nao autorizado. Existe um agendamento identico para mesma data.

Webhooks de Retorno

Entity	Status	Descrição
scheduled	SCHEDULED	Agendamento concluído com sucesso
scheduled	CONFIRMED	Agendamento confirmado após pagamento
scheduled	ERROR	Falha ao realizar o pagamento
scheduled	CANCELED	Agendamento cancelado com sucesso

{
  "entity": "scheduled",
  "status": "SCHEDULED",
  "createTimeStamp": "2025-02-24T15:23:04.063Z",
  "body": {
    "schedulerId": "d281b7ca-3858-455f-806b-62518c3ea5b4",
    "amount": 0.01,
    "clientCode": "168e504f-1531-4921-ae9c-aa590d8a53b4",
    "initiationType": "MANUAL",
    "paymentType": "IMMEDIATE",
    "urgency": "HIGH",
    "transactionType": "TRANSFER",
    "debitParty": {
      "account": "30023646094074",
      "taxId": "66877376781",
      "name": "Julio dos Santos",
      "branch": "0001",
      "accountType": "CACC"
    },
    "creditParty": {
      "bank": "13935893",
      "account": "42689",
      "branch": "1",
      "taxId": "17326188106",
      "name": "teste",
      "accountType": "TRAN"
    },
    "scheduler": {
      "schedulerDate": "2025-02-25",
      "product": "PIX_BAAS"
    },
    "remittanceInformation": "teste"
  },
  "webhookId": "d281b7ca-3858-455f-806b-62518c3ea5b4"
}

{
   "entity":"scheduled",
   "status":"CONFIRMED",
   "createTimeStamp":"2025-02-24T15:23:04.063Z",
   "body":{
      "schedulerId":"d281b7ca-3858-455f-806b-62518c3ea5b4",
      "amount":0.01,
      "clientCode":"168e504f-1531-4921-ae9c-aa590d8a53b4",
      "initiationType":"MANUAL",
      "paymentType":"IMMEDIATE",
      "urgency":"HIGH",
      "transactionType":"TRANSFER",
      "debitParty":{
         "account":"30023646094074",
         "taxId":"66877376781",
         "name":"Julio dos Santos",
         "branch":"0001",
         "accountType":"CACC"
      },
      "creditParty":{
         "bank":"13935893",
         "account":"42689",
         "branch":"1",
         "taxId":"17326188106",
         "name":"teste",
         "accountType":"TRAN"
      },
      "scheduler":{
         "schedulerDate":"2025-02-25",
         "product":"PIX_BAAS"
      },
      "error":{
         "errorCode":null,
         "message":null
      },
      "remittanceInformation":"teste"
   },
   "webhookId":"d281b7ca-3858-455f-806b-62518c3ea5b4"
}

{
   "entity":"scheduled",
   "status":"ERROR",
   "createTimeStamp":"2025-02-24T15:23:04.063Z",
   "body":{
      "schedulerId":"d281b7ca-3858-455f-806b-62518c3ea5b4",
      "amount":0.01,
      "clientCode":"168e504f-1531-4921-ae9c-aa590d8a53b4",
      "initiationType":"MANUAL",
      "paymentType":"IMMEDIATE",
      "urgency":"HIGH",
      "transactionType":"TRANSFER",
      "debitParty":{
         "account":"30023646094074",
         "taxId":"66877376781",
         "name":"Julio dos Santos",
         "branch":"0001",
         "accountType":"CACC"
      },
      "creditParty":{
         "bank":"13935893",
         "account":"42689",
         "branch":"1",
         "taxId":"17326188106",
         "name":"teste",
         "accountType":"TRAN"
      },
      "scheduler":{
         "schedulerDate":"2025-02-25",
         "product":"PIX_BAAS"
      },
      "error":{
         "errorCode":"ED05",
         "message":"Erro no processamento do pagamento"
      },
      "remittanceInformation":"teste"
   },
   "webhookId":"d281b7ca-3858-455f-806b-62518c3ea5b4"
}

{
   "entity":"scheduled",
   "status":"CANCELED",
   "createTimeStamp":"2025-02-24T15:23:04.063Z",
   "body":{
      "schedulerId":"d281b7ca-3858-455f-806b-62518c3ea5b4",
      "amount":0.01,
      "clientCode":"168e504f-1531-4921-ae9c-aa590d8a53b4",
      "initiationType":"MANUAL",
      "paymentType":"IMMEDIATE",
      "urgency":"HIGH",
      "transactionType":"TRANSFER",
      "debitParty":{
         "account":"30023646094074",
         "taxId":"66877376781",
         "name":"Julio dos Santos",
         "branch":"0001",
         "accountType":"CACC"
      },
      "creditParty":{
         "bank":"13935893",
         "account":"42689",
         "branch":"1",
         "taxId":"17326188106",
         "name":"teste",
         "accountType":"TRAN"
      },
      "scheduler":{
         "schedulerDate":"2025-02-25",
         "product":"PIX_BAAS"
      },
      "remittanceInformation":"teste"
   },
   "webhookId":"d281b7ca-3858-455f-806b-62518c3ea5b4"
}

Updated about 13 hours ago

Agendar uma transação Pix

Passos para Integrar

Fluxo de integração

Realizar agendamento de Pix

👍
Sucesso 200

❗
Error 400

Webhooks de Retorno

Passos para Integrar

Fluxo de integração

Realizar agendamento de Pix

👍Sucesso 200

❗Error 400

Webhooks de Retorno

👍
Sucesso 200

❗
Error 400