Pix Agendado

O conjunto de endpoints a seguir é responsável pela gestão de Pix Agendados.

Listar Agendamentos Pix

Endpoint para recuperar uma lista de pagamentos Pix agendados criados pelo PSP.

GET /v1/pix/schedules

Requer autorização para o escopo: cobv.read

Requisição

O trecho de código abaixo ilustra o consumo do endpoint em uma requisição com o mínimo de parâmetros possível (o intervalo de datas inicio e fim) e o formato em que esses parâmetros devem ser repassados.

/v1/pix/schedules?inicio=2020-10-22T16:01:35Z&fim=2020-11-30T20:10:00Z

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

{
"responseTime": 48,
"correlationId": "ead5ebbb-2b5e-4cb6-bd7e-3af047d3a330",
"data": [
  {
    "txid": "123456789012345678901234657890",
    "end_user_account": "09089356",
    "receiver_name": "Eu",
    "end_to_end_id": "E59285411202509151356mIj2Z76CO7t",
    "status": "scheduled",
    "value": 10,
    "scheduling_date": "2025-10-01T09:00:00.000Z",
    "error_code": null,
    "error_description": null
  },
  {
    "txid": null,
    "end_user_account": "09089356",
    "receiver_name": "Eu",
    "end_to_end_id": "E59285411202509151356mIj2Z76CO71",
    "status": "scheduled",
    "value": 10,
    "scheduling_date": "2025-10-01T09:00:00.000Z",
    "error_code": null,
    "error_description": null
  },
  {
    "txid": null,
    "end_user_account": "09089356",
    "receiver_name": "Eu",
    "end_to_end_id": "E59285411202509151356mIj2Z76CO72",
    "status": "scheduled",
    "value": 10,
    "scheduling_date": "2025-10-01T09:00:00.000Z",
    "error_code": null,
    "error_description": null
  }
],
"total": 3,
"page": 1,
"limit": 50
}

🔴 400

{
  "correlationId": "a9f13566e19f5ca51329479a5bae60c5",
  "error": {
      "status": 400,
      "title": "Bad Request",
      "detail": "Date range exceeds the limit of 31 days"
  }
}  

🔴 401

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
      "title": "Unauthorized",
      "detail": "Token de acesso inválido ou expirado",
      "status": 401
  }
}

🔴 403

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
      "title": "Forbidden",
      "detail": "Acesso negado",
      "status": 403
  }
}

🔴 500

{
"correlationId": "abcdef01-2345-6789-0123-456789012345",
"error": {
  "title": "InternalServerError",
  "detail": "Erro interno do servidor",
  "status": 500
}
}

🔴 503

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
      "title": "ServiceUnavailable",
      "detail": "Serviço temporariamente indisponível",
      "status": 503
  }
}

Consultar agendamento pix

Endpoint para recuperar informações detalhadas de um pagamento Pix agendado específico através do seu txid.

Casos de Uso:

• Verificar status: Acompanhar execução do agendamento
• Auditoria: Verificar detalhes da execução
• Reconciliação: Validar pagamentos executados

GET /v1/pix/schedules/:txid

Requer autorização para o escopo: cob.read

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

// Agendamento ativo
{
  "responseTime": 48,
  "correlationId": "498ce10e-7f5c-4145-8a9b-775e070b992b",
  "data": [
      {
      "txid": "a7kbetbrd45df4tefdf247ac48384653538",
      "end_user_account": "09089356",
      "receiver_name": "Usuario Portabilidade",
      "end_to_end_id": "E09089356202510291130aaaaaaaaaae",
      "status": "waiting",
      "value": 101,
      "scheduling_date": "2025-10-28T23:08:59.000Z",
      "error_description": null
      }
  ],
  "total": 1 
}

OU

// Agendamento executado
{
  "responseTime": 35,
  "correlationId": "f2d8c9aa-3c6e-4db7-ae8f-4bf158e4b441",
  "data": [
      {
      "txid": "a7kbetbrd45df4tefdf247ac48384653538",
      "end_user_account": "09089356",
      "receiver_name": "Usuario Portabilidade",
      "end_to_end_id": "E09089356202510291130aaaaaaaaaae",
      "status": "finished",
      "value": 101,
      "scheduling_date": "2025-10-28T23:08:59.000Z",
      "error_code": null,
      "error_description": null
      }
  ],
  "total": 1
}

OU

//Agendamento com erro
 {
  "responseTime": 42,
  "correlationId": "a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6",
  "data": [
      {
      "txid": "a7kbetbrd45df4tefdf247ac48384653538",
      "end_user_account": "09089356",
      "receiver_name": "Usuario Portabilidade",
      "end_to_end_id": "E09089356202510291130aaaaaaaaaae",
      "status": "rejected",
      "value": 101,
      "scheduling_date": "2025-10-28T23:08:59.000Z",
      "error_code": "AC03",
      "error_description": "Conta de destino inválida"
      }
  ],
  "total": 1
}

🔴 400

{
  "correlationId": "a9f13566e19f5ca51329479a5bae60c5",
  "error": {
      "status": 400,
      "title": "Bad Request",
      "detail": "TxId deve ter entre 26 e 35 caracteres alfanuméricos"
  }
}

🔴 401

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
      "title": "Unauthorized",
      "detail": "Token de acesso inválido ou expirado",
      "status": 401
  }
}

🔴 403

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
      "title": "Forbidden",
      "detail": "Acesso negado",
      "status": 403
  }
}

🔴 404

{
  "correlationId": "a9f13566e19f5ca51329479a5bae60c5",
  "error": {
      "status": 404,
      "title": "Not Found",
      "detail": "Agendamento com o txid informado não foi encontrado"
  }
}

🔴 500

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
      "title": "InternalServerError",
      "detail": "Erro interno do servidor",
      "status": 500
  }
}

🔴 503

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "error": {
      "title": "ServiceUnavailable",
      "detail": "Serviço temporariamente indisponível",
      "status": 503
  } 
}