v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Listar cedentes

Este recurso retorna uma lista com todos os cedentes cadastrados.

get/concessions/assignors

Query parameters

q[statusEq]'pending' | 'active' | 'inactive'

O status do acesso é igual a.

q[documentNumberEq]integer

O CPF ou CNPJ do cedente é igual a.

q[createdAtGt]string date-time

A data de solicitação de acesso a base de cobranças do cedente maior que. Ex. 2023-08-08T11:58:43.575-03:00

q[createdAtLt]string date-time

A data de solicitação de acesso a base de cobranças do cedente menor que. Ex. 2023-08-08T11:58:43.575-03:00

q[expiresAtEq]string date

A data de expiração do acesso do credor é igual a.

p[page]integer

Página que será retornada.

p[per_page]integer

Quantidade de itens para retornar por página.

Response

200

Example response

{
  "data": [
    {
      "id": "cb19b1d7-7825-4e55-a21a-236d320788a8",
      "type": "assignor",
      "attributes": {
        "createdAt": "2024-04-18T16:47:33.198-03:00",
        "updatedAt": "2024-04-18T16:47:33.198-03:00",
        "status": "pending",
        "bankCode": "274",
        "agency": "0001",
        "accountNumber": "08134399-8",
        "documentNumber": "17805727000149",
        "name": "NBS FIDC"
      }
    }
  ],
  "meta": {
    "pagination": {
      "currentPage": 1,
      "perPage": 25,
      "totalPages": 1,
      "totalCount": 12
    }
  }
}