Autorizar recorrência do pix automático via leitura de QRCode

Cria um novo registro de Bank Account.

Visão geral

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 — —

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string`	obrigatório	—	`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"`
`recurrenceId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`journey`	`string`	opcional	—	`JORNADA_1`, `JORNADA_2`, `JORNADA_3`, `JORNADA_4`	`"JORNADA_1"`
`amountValueInCents`	`integer (int64)`	opcional	—	—	`0`
`maxAmountValueInCents`	`integer (int64)`	opcional	—	—	`0`
`receiverName`	`string`	opcional	—	—	`"Fulano de Tal"`
`receiverRegistrationNumber`	`string`	opcional	—	—	`"texto"`
`receiverBankIspb`	`string`	opcional	—	—	`"texto"`
`payerBankRegistrationNumber`	`string`	opcional	—	—	`"texto"`
`firstRecurrenceDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`lastRecurrenceDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`periodicity`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"MIAN"`
`contractNumber`	`string`	opcional	—	—	`"texto"`
`description`	`string`	opcional	—	—	`"texto"`

Exemplo de corpo

{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "journey": "JORNADA_1",
  "amountValueInCents": 0,
  "maxAmountValueInCents": 0,
  "receiverName": "Fulano de Tal",
  "receiverRegistrationNumber": "texto",
  "receiverBankIspb": "texto",
  "payerBankRegistrationNumber": "texto",
  "firstRecurrenceDate": "2025-08-11T13:45:00Z",
  "lastRecurrenceDate": "2025-08-11T13:45:00Z",
  "periodicity": "MIAN",
  "contractNumber": "texto",
  "description": "texto"
}

Response

Resposta 204 sem corpo (—).

Códigos de retorno

Código	Significado	Detalhe do contrato
`204`	Sucesso sem corpo de resposta.	—

Exemplos

curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Automatic/authorize" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "journey": "JORNADA_1",
  "amountValueInCents": 0,
  "maxAmountValueInCents": 0,
  "receiverName": "Fulano de Tal",
  "receiverRegistrationNumber": "texto",
  "receiverBankIspb": "texto",
  "payerBankRegistrationNumber": "texto",
  "firstRecurrenceDate": "2025-08-11T13:45:00Z",
  "lastRecurrenceDate": "2025-08-11T13:45:00Z",
  "periodicity": "MIAN",
  "contractNumber": "texto",
  "description": "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/Automatic/authorize";

var corpo = new StringContent(
    """
    {
      "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "texto",
      "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "journey": "JORNADA_1",
      "amountValueInCents": 0,
      "maxAmountValueInCents": 0,
      "receiverName": "Fulano de Tal",
      "receiverRegistrationNumber": "texto",
      "receiverBankIspb": "texto",
      "payerBankRegistrationNumber": "texto",
      "firstRecurrenceDate": "2025-08-11T13:45:00Z",
      "lastRecurrenceDate": "2025-08-11T13:45:00Z",
      "periodicity": "MIAN",
      "contractNumber": "texto",
      "description": "texto"
    }
    """,
    Encoding.UTF8, "application/json");

var resp = await http.PostAsync(rota, corpo);
resp.EnsureSuccessStatusCode();
// Sem corpo de resposta neste endpoint.

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

const payload = {
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "journey": "JORNADA_1",
  "amountValueInCents": 0,
  "maxAmountValueInCents": 0,
  "receiverName": "Fulano de Tal",
  "receiverRegistrationNumber": "texto",
  "receiverBankIspb": "texto",
  "payerBankRegistrationNumber": "texto",
  "firstRecurrenceDate": "2025-08-11T13:45:00Z",
  "lastRecurrenceDate": "2025-08-11T13:45:00Z",
  "periodicity": "MIAN",
  "contractNumber": "texto",
  "description": "texto"
};

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

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
// Sem corpo de resposta neste endpoint.

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