Solicitar recuperação de valores (Instauração de MED 2

Cria um novo registro de Bank Account.

Visão geral

Solicitar recuperação de valores (Instauração de MED 2.0)

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.

Pré-requisitos: a rota exige identificador(es) de recurso já existente(s):

id — Id da conta bancária

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string`	obrigatório	Id da conta bancária	`3fa85f64-5717-4562-b3fc-2c963f66afa6`

Corpo da requisição

Envie no formato application/json. Corpo obrigatório.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`sessionId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`code`	`string`	opcional	—	—	`"texto"`
`situationType`	`string`	opcional	—	`NONE`, `SCAM`, `ACCOUNT_TAKEOVER`, `COERCION`, `FRAUDULENT_ACCESS`, `OTHER`, `UNKNOWN`	`"NONE"`
`originalEndToEndId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`analysisDetails`	`string`	opcional	—	—	`"texto"`

Exemplo de corpo

{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "situationType": "NONE",
  "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "analysisDetails": "texto"
}

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`correlationId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`recoveryDetails`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`fraudGraph`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Exemplo de resposta

{
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "recoveryDetails": {
    "uniqueRecoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankIspb": "texto",
    "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "receiverName": "Fulano de Tal",
    "amount": 0,
    "situationType": "NONE",
    "analysisDetails": "texto",
    "status": "NONE",
    "createdAt": "2025-08-11T13:45:00Z",
    "updatedAt": "2025-08-11T13:45:00Z",
    "reporter": {
      "agency": 0,
      "accountNumber": 0,
      "accountType": "PaymentAccount",
      "registrationNumber": "12345678909"
    },
    "contact": {
      "email": "cliente@exemplo.com.br",
      "phoneNumber": "11987654321"
    }
  },
  "fraudGraph": {
    "involvedPeople": [
      {
        "id": 1,
        "type": {},
        "createdAt": "2025-08-11T13:45:00Z"
      }
    ],
    "involvedAccounts": [
      {
        "id": 1,
        "personId": 1,
        "bankIspb": "texto",
        "openedAt": "2025-08-11T13:45:00Z"
      }
    ],
    "transactions": [
      {
        "id": "texto",
        "debitedAccountId": 1,
        "creditedAccountId": 1,
        "amount": 0,
        "availableAmount": 0,
        "settledAt": "2025-08-11T13:45:00Z"
      }
    ]
  }
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	Dados da recuperação criada
`400`	Requisição inválida (validação de campos ou regra de negócio).	—
`404`	Recurso não encontrado.	—

Exemplos

curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "situationType": "NONE",
  "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "analysisDetails": "texto"
}'

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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover";

var corpo = new StringContent(
    """
    {
      "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "texto",
      "situationType": "NONE",
      "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "analysisDetails": "texto"
    }
    """,
    Encoding.UTF8, "application/json");

var resp = await http.PostAsync(rota, corpo);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

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

const payload = {
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "situationType": "NONE",
  "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "analysisDetails": "texto"
};

const resp = await fetch(`${baseUrl}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload),
});

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.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

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