Buscar agendamentos de PIX

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

O Sistema Cliente deve utilizar esta API para buscar agendamentos. Antes de fazer uso desta API, é importante garantir que:

• Seja o Titular da Conta Transacional ou tenha autoridade legal para operá-la.

• Possua autorização para solicitar essa ação.

Este endpoint permite consultar os Pix agendados na plataforma GlobalSCM. Você pode filtrar a consulta por CPF/CNPJ do cliente, período de criação do pagamento, e período de agendamento..

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo de abertura de conta.

Requisição de exemplo

Consultar pix agendados

get

Path parameters

clientstringOptional

Identificador único do cliente a ser consultado. CpfCnpj

Example: 12345678901

createdDateInitialstringOptional

Inicio do periodo de registro dos pagamentos.

Example: 2025-03-20

scheduledDateInitialstringOptional

Inicio do periodo que os pagamentos devem ser efetuados.

Example: 2025-04-20

createdDateFinalstringOptional

Inicio do periodo de registro dos pagamentos.

Example: 2025-03-25

scheduledDateFinalstringOptional

Fim do periodo que os pagamentos devem ser efetuados.

Example: 2025-04-30

pagestringOptional

Número da página

Example: 1

limitstringOptional

Número de registros na página. Máximo de 100

Example: 10

Responses

get

HTTPcURLJavaScriptPython

GET /internal/api/v1/schedule-pix HTTP/1.1
Host: sandbox.globalscm.app.br
Accept: */*

{
  "current_page": 1,
  "total_page": 5,
  "total_per_page": 10,
  "list": [
    {
      "payload": {
        "initializationType": "DICT",
        "urgency": "LOW",
        "transactionType": "TRANSFER",
        "payer": {
          "ispb": 64661297,
          "personType": "JURIDICA",
          "cpfCnpj": 64661297000119,
          "name": "Integração GlobalSCM",
          "agencyNumber": "22",
          "accountType": "CONTA_CORRENTE",
          "accountNumber": "32423"
        },
        "receiver": {
          "ispb": 18813652,
          "personType": "JURIDICA",
          "cpfCnpj": 18813652399,
          "name": "teste",
          "agencyNumber": "1",
          "accountType": "CONTA_CORRENTE",
          "accountNumber": "1"
        },
        "amount": 10,
        "message": ""
      },
      "idempotencyKey": "eb0631f0-2197-40b6-8a45-6618525bf6ec",
      "scheduleDate": "20/03/2025"
    }
  ],
  "total_items": 110
}