Nesta seção você encontrará a explicação completa de todas as rotas disponíveis para trabalhar com extrato bancário na API de Pagamentos da TecnoSpeed.

1. Enviar extrato bancário

Esta rota permite o envio de um arquivo de extrato para processamento pela API. O arquivo pode estar nos formatos .ofx, .ret ou .ext.

POST
/api/v1/statement/parser

Headers obrigatórios

Body

Exemplo de retorno (sucesso)

{
  "uniqueId": "string"
}

Códigos de retorno

• 200: Sucesso

• 401: Unauthorized

• 422: Parâmetros inválidos

2. Consultar extrato bancário (por ID)

Utilize esta rota para consultar o conteúdo do extrato previamente enviado.

GET
/api/v1/statement/parser/{uniqueId}

Path Parameter

Headers obrigatórios

Exemplo de retorno (sucesso)

{
  "bankStatement": {
    "bankCode": "string",
    "bank": "string",
    "currency": "string",
    "balance": 0,
    "date": "2019-08-24",
    "type": "string",
    "totalTransactions": 0,
    "accountHash": "string",
    "dateStart": "string",
    "dateEnd": "string"
  },
  "transactions": {
    "credit": [],
    "debit": [],
    "balance": {}
  }
}

3. Consultar extrato bancário por período

Permite consultar os extratos disponíveis dentro de um intervalo de datas específico.

GET
/api/v1/statement

Query Parameters

Headers obrigatórios

Exemplo de retorno (sucesso)

{
  "data": [
    {
      "uniqueId": "string",
      "date": "2025-03-01",
      "type": "ofx",
      "balance": "1234.56",
      "dateStart": "2025-02-01",
      "dateEnd": "2025-02-28"
    }
  ],
  "meta": {
    "count": 1,
    "page": 1,
    "totalPages": 1
  }
}

4. Baixar arquivo de extrato

Após o envio e processamento do extrato, você pode baixá-lo novamente usando essa rota.

GET
/api/v1/statement/download/{uniqueId}

Path Parameter

Headers obrigatórios

Retorno esperado

• Conteúdo binário do arquivo OFX/RET/EXT.

• Tipo de retorno: application/octet-stream ou application/json em caso de erro.