Consulta transações STR

Envios de transações via o SPB, pelas mensagens do STR.

IMPORTANTE informar que nem todos os dados podem aparecer como nas mensagens de exemplo, por questões de segurança dos dados dos úsuarios do Sistema Financeira Brasileiro e LGPD.

A consulta de transação é uma funcionalidade essencial para os clientes da GlobalSCM que desejam acompanhar as transações financeiras realizadas em suas contas por via de STR. Os clientes podem consultar detalhes específicos sobre uma transação financeira, incluindo informações como o status atual, data e hora da transação, valores envolvidos e qualquer mensagem relevante associada à transação.

Exemplo de envio:

Listar Transações STR

get

Query parameters

pageinteger · min: 1Optional

Número da página para paginação (padrão 1).

Default: 1Example: 1

limitinteger · min: 1 · max: 100Optional

Número máximo de itens por página (padrão 10, máximo 100).

Default: 10Example: 20

searchstringOptional

Termo de busca para filtrar transações.

Example: Nome do Cliente

clientNamestringOptional

Nome do cliente para filtrar transações.

Example: João Silva

cpfCnpjstringOptional

cpfCnpj do cliente para filtrar transações.

Example: 12345678910

typestringOptional

Tipo de transação para filtrar.

Example: STR0008

initialDatestring · dateOptional

Data inicial para filtrar transações (formato YYYY-MM-DD).

Example: 2025-04-01

finalDatestring · dateOptional

Data final para filtrar transações (formato YYYY-MM-DD).

Example: 2025-04-09

endToEndstringOptional

Identificador único de ponta a ponta para filtrar transações.

Example: E2E-ABC-123

numCtrlSTRstringOptional

Número de controle STR para filtrar transações.

Example: CTRL-XYZ-456

Responses

200

Lista de transações STR paginada

application/json

get

HTTPcURLJavaScriptPython

GET /internal/api/v1/spb/str/transactions HTTP/1.1
Host: sandbox.globalscm.app.br
Accept: */*

200

Lista de transações STR paginada

{
  "total_current": 10,
  "current_page": 1,
  "total_pages": 5,
  "total_per_pages": 10,
  "list": [
    {
      "id": 123,
      "codigoMensagem": "STR0008",
      "numCtrlSTR": "STR00081234123654413",
      "numeroControleIF": "IFCTRL987",
      "ispbIFDebitada": "12345678",
      "tipoContaDebitada": "CORRENTE",
      "contaDebitada": "1234567890123",
      "tipoPessoaDebitada": "FISISCA",
      "cnpjOuCpfClienteDebitado": "12345678901",
      "nomeClienteDebitado": "Fulano de Tal",
      "ispbIfCreditada": "98765432",
      "agenciaCreditada": "0001",
      "tipoContaCreditada": "CORRENTE",
      "contaCreditada": "9876543210123",
      "tipoPessoaCreditada": "FISISCA",
      "cnpjOuCPFClienteCreditado": "98765432109",
      "nomeClienteCreditado": "Sicrano da Silva",
      "situacao": "PROCESSADO",
      "valorLancamento": 100.5,
      "finalidadeCliente": "PAGAMENTO_DE_SALARIOS",
      "codigoIdentificadorTransferencia": "TRANSF-ABC-123",
      "historico": "Pagamento de salário",
      "dataAgendamento": "2025-04-10",
      "horaAgendamento": "10:30:00",
      "nivelPreferencia": "MAXIMA",
      "dataMovimento": "2025-04-09",
      "createdAt": "2025-04-09T16:30:00Z",
      "updatedAt": "2025-04-09T16:30:00Z",
      "descricao": "Detalhes adicionais"
    }
  ],
  "totalItems": 50
}

Atualmente temos esses tipos de STR disponiveis: STR0008