v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Todos os beneficiários da conta

Este endpoint retorna todos os beneficiários cadastrados na conta Grafeno.

get/beneficiaries

Query parameters

q[nameEq]string

Filtra beneficiários pelo nome ou razão social especificada.

q[documentNumberEq]string

Filtra beneficiários pelo CPF ou CNPJ especificado.

q[accountEq]string

Filtra beneficiários pelo número da conta especificado.

p[page]string

Define o número da página a ser acessada na consulta.

p[per_page]string

Define a quantidade de itens por página a serem retornados na consulta.

Response

200

Example response

{
  "data": [
    {
      "id": "dc864eb1-84e3-4fb4-9041-0dc60f2b268b",
      "type": "beneficiary",
      "attributes": {
        "name": "Schrute Farms",
        "agency": "0001",
        "account": "08146972-8",
        "documentNumber": "08470974000140",
        "bankCode": "274",
        "createdAt": "2024-06-05T15:33:11.087-03:00",
        "updatedAt": "2024-06-05T15:33:11.087-03:00",
        "releaseAt": "2024-06-05T15:33:11.088-03:00"
      }
    }
  ],
  "meta": {
    "pagination": {
      "currentPage": 1,
      "nextPage": 2,
      "perPage": 3,
      "totalPages": 8,
      "totalCount": 200
    }
  }
}