POST/v{version}/CreditNote/{id}/donePaymentRevision

Crédito · Operação de crédito

Criar Credit Note

Cria um novo registro de Credit Note.

Visão geral

Cria um novo registro de Credit Note.

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 (uuid)`	obrigatório	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`version`	path	`string`	obrigatório	—	`1`

Corpo da requisição

Envie no formato application/json. Corpo opcional.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`bankAccount`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`changeBankAccount`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`

Detalhe de `bankAccount`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`ownerUser`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`id`	`string (uuid)`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`bankCode`	`integer`	opcional	—	—	`0`
`bankIspb`	`integer (int64)`	opcional	Código ISPB do banco	—	`0`
`account`	`string`	opcional	—	—	`"texto"`
`accountDigit`	`string`	opcional	—	—	`"texto"`
`agency`	`string`	opcional	—	—	`"texto"`
`agencyDigit`	`string`	opcional	—	—	`"texto"`
`type`	`string`	opcional	—	`NaturalCheckingAccount`, `NaturalSimpleAccount`, `LegalCheckingAccount`, `PublicEntities`, `FinancialInstitutionsDeposits`, `NaturalSavingsAccount`, `LegalSavingsAccount`, `RealEstateSavingsAccount`, `LotteryDeposits`, `EscrowAccount`	`"NaturalCheckingAccount"`
`jointAccount`	`boolean`	opcional	—	—	`true`
`operationTypeValue`	`string`	obrigatório	—	`Transfer`, `Pix`	`"Transfer"`
`pixKeyTypeValue`	`string`	opcional	—	`NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount`	`"NaturalRegistrationNumber"`
`keyPix`	`string`	opcional	Chave Pix	—	`"texto"`

Detalhe de `ownerUser`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`userId`	`string`	obrigatório	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`tenantName`	`string`	obrigatório	—	—	`"Fulano de Tal"`

Detalhe de `ownerGroup`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`groupId`	`string`	obrigatório	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`tenantName`	`string`	obrigatório	—	—	`"Fulano de Tal"`

Exemplo de corpo

{
  "bankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  },
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
}

Response

Resposta 200 sem corpo (Success).

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	Success

Exemplos

curl -X POST "{{baseUrl}}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/donePaymentRevision" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "bankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  },
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "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/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/donePaymentRevision";

var corpo = new StringContent(
    """
    {
      "bankAccount": {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "bankCode": 0,
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "NaturalCheckingAccount",
        "jointAccount": true,
        "operationTypeValue": "Transfer",
        "pixKeyTypeValue": "NaturalRegistrationNumber",
        "keyPix": "texto"
      },
      "changeBankAccount": {
        "ownerUser": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "ownerGroup": {
          "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "tenantName": "Fulano de Tal"
        },
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "bankCode": 0,
        "bankIspb": 0,
        "account": "texto",
        "accountDigit": "texto",
        "agency": "texto",
        "agencyDigit": "texto",
        "type": "NaturalCheckingAccount",
        "jointAccount": true,
        "operationTypeValue": "Transfer",
        "pixKeyTypeValue": "NaturalRegistrationNumber",
        "keyPix": "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 = {
  "bankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  },
  "changeBankAccount": {
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankCode": 0,
    "bankIspb": 0,
    "account": "texto",
    "accountDigit": "texto",
    "agency": "texto",
    "agencyDigit": "texto",
    "type": "NaturalCheckingAccount",
    "jointAccount": true,
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  }
};

const resp = await fetch(`${baseUrl}/v1/CreditNote/3fa85f64-5717-4562-b3fc-2c963f66afa6/donePaymentRevision`, {
  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 →Collection do Consignado privadoCadastros, operação e consultas do módulo.Baixar →Collection do FGTSCadastros, operação e consultas do módulo.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