v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Baixar arquivos de retorno - CNAB400

Este recurso retorna uma lista com os arquivos de retorno no formato CNAB400 disponíveis.

get/cnab

Query parameters

q[accountNumberEq]=string

Número da conta Grafeno.

q[documentNumberEq]=integer

CNPJ do participante titular da conta Grafeno.

q[accountTypeEq]='company' | 'linked' | 'linked_flex'

Tipo da conta Grafeno.

q[dateEq]string date

Data de geração do arquivo de retorno igual a.

q[createdAtGt]=string date

Data de geração do arquivo de retorno maior que.

q[createdAtLt]=string date

Data de geração do arquivo de retorno menor que.

p[page]integer

Número da página que será retornada.

p[per_page]integer

Quantidade de itens por página que serão retornados.

Response

200

successboolean
messagestring

Example response

{
  "data": [
    {
      "fileId": 1608,
      "file": "https://grafeno-pagamentos.s3.amazonaws.com/uploads/cnab/record/1608/file/cnab_charge20210209-3977-25q8dv.ret?X-Amz-Expires=259200&X-Amz-Date=20210408T214154Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6GUDBFRJDLS2JG7S%2F20210408%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=df774fa7d3ab28613b167fc7a741a65c2971eb8f88600952663adfb602851ffd",
      "date": "2021-02-09",
      "accountNumber": "00002935-5",
      "documentNumber": "159.283.550/001-12",
      "accountName": "TESTES DE BOLETO",
      "accountType": "company"
    }
  ],
  "pagination": {
    "total_pages": 1,
    "current_page": 1,
    "items_per_page": 50,
    "count": 2,
    "total_count": 2
  },
  "success": true,
  "message": "OK",
  "searched": {
    "createdAtGtEq": "2021-02-09 00:00:00 -0300",
    "createdAtLtEq": "2021-02-09 23:59:59 -0300"
  }
}