Busca conta pelo trio (bankIspb, agency, accountNumber) e retorna beneficiários

Visão geral

Busca conta pelo trio (bankIspb, agency, accountNumber) e retorna beneficiários
ativos com status Approved. Bloqueia contas do tipo PaymentAccount.

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 beneficiaries

Exemplo de resposta

{
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankCode": 0,
  "agency": 0,
  "accountNumber": 0,
  "accountType": "PaymentAccount",
  "accountTypeDescription": "texto",
  "beneficiaries": [
    {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankDisplay": "texto",
      "bank": 0,
      "agency": 0,
      "accountNumber": "texto",
      "pixKeyTypeValue": "texto",
      "pixKeyTypeValueDisplay": "texto",
      "keyPix": "texto",
      "beneficiaryIdPIX": "texto",
      "beneficiaryIdTED": "texto"
    }
  ]
}

Códigos de retorno

Exemplos

curl -X GET "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Escrow/Beneficiaries" \
  -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 = "/v1/BankAccount/AutomaticSplit/Escrow/Beneficiaries";

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}/v1/BankAccount/AutomaticSplit/Escrow/Beneficiaries`, {
  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