Criar agendamento 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.

---

Como Criar um Agendamento de Pix na GlobalSCM

Antes de utilizar a API para criar um agendamento de Pix, verifique se o Cliente final que está solicitando o agendamento:

• É o Titular da Conta Transacional ou possui autoridade legal para operá-la.

• Possui autorização para agendar o Pix.

---

Como Utilizar a API de Agendamento de Pix?

Para agendar um Pix na GlobalSCM, siga os passos descritos abaixo. O agendamento de Pix é simples e permite configurar a transação para uma data e hora específica.

Requisição de exemplo

Agendar um PIX

post

Header parameters

Chave-IdempotenciastringRequired

Identificador único em formato uuidV4. para garantir que a requisição seja idêntica em múltiplas tentativas.

Example: 123e4567-e89b-12d3-a456-426614174000

Body

idempotencyKeystringOptionalExample: eb0631f0-2197-40b6-8a45-6618525bf6ec

scheduleDatestringRequiredExample: 20/03/2025

Responses

201

Created

application/json

ResponseobjectExample: {"id":"1","scheduleDate":"20/03/2025","status":"SCHEDULE"}

404

Not found

500

Unknown server error

post

HTTPcURLJavaScriptPython

POST /internal/api/v1/schedule-pix HTTP/1.1
Host: sandbox.globalscm.app.br
Chave-Idempotencia: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 537

{
  "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"
}

{
  "id": "1",
  "scheduleDate": "20/03/2025",
  "status": "SCHEDULE"
}