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 o pix agendado por id

get

Path parameters

idintegerRequired

ID do Pix agendado.

Responses

200

Successful

application/json

ResponseobjectExample: {"id":1,"payload":{"initializationType":"DICT","urgency":"LOW","transactionType":"TRANSFER","payer":{"ispb":64661297,"personType":"JURIDICA","cpfCnpj":64661297000119,"name":"Integração GlobalSCM","agencyNumber":"22","accountType":"CORRENTE","accountNumber":"32423"},"receiver":{"ispb":18813652,"personType":"JURIDICA","cpfCnpj":"***.136.523-**","name":"teste","accountType":"CORRENTE"},"amount":10,"message":""}}

get

/internal/api/v1/schedule-pix/{id}

HTTPcURLJavaScriptPython

GET /internal/api/v1/schedule-pix/{id} HTTP/1.1
Host: 
Accept: */*

200

Successful

{
  "id": 1,
  "payload": {
    "initializationType": "DICT",
    "urgency": "LOW",
    "transactionType": "TRANSFER",
    "payer": {
      "ispb": 64661297,
      "personType": "JURIDICA",
      "cpfCnpj": 64661297000119,
      "name": "Integração GlobalSCM",
      "agencyNumber": "22",
      "accountType": "CORRENTE",
      "accountNumber": "32423"
    },
    "receiver": {
      "ispb": 18813652,
      "personType": "JURIDICA",
      "cpfCnpj": "***.136.523-**",
      "name": "teste",
      "accountType": "CORRENTE"
    },
    "amount": 10,
    "message": ""
  }
}