Método de visualização da lista de beneficiarios/cedentes

Visão geral

Método de visualização da lista de beneficiarios/cedentes.

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Request

Parâmetros

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Detalhe de data

Detalhe de address

Detalhe de wallets

Detalhe de representatives

Detalhe de bankSlipCosts

Exemplo de resposta

{
  "data": [
    {
      "id": "texto",
      "beneficiaryCode": 0,
      "companyName": "Fulano de Tal",
      "businessName": "Fulano de Tal",
      "personTypeValue": "texto",
      "personTypeValueDisplay": "texto",
      "registrationNumber": "12345678909",
      "address": {
        "zipCode": "01310930",
        "addressName": "Fulano de Tal",
        "number": "texto",
        "complement": "texto",
        "district": "texto",
        "city": "texto",
        "uf": "texto"
      },
      "startedAt": "2025-08-11T13:45:00Z",
      "enabled": true,
      "wallets": [
        {}
      ],
      "representatives": [
        {}
      ],
      "walletsManaged": [
        0
      ]
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "isCountTruncated": true
}

Códigos de retorno

Exemplos

curl -X GET "{{baseUrl}}/api/v1/Beneficiary" \
  -H "Authorization: Bearer {{token}}"

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/api/v1/Beneficiary";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/api/v1/Beneficiary`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Guia de importação: Como importar no Postman · Todos os downloads: Downloads