API Docs Início Documentação Referência de API Copiar para LLM
POST/api/v1/BankSlip/TransferBatch
Cobrança · Boletos

Método utilizado para transferir um ou mais boletos entre carteiras/convenios

Cria um novo registro de api.

Visão geral

Método utilizado para transferir um ou mais boletos entre carteiras/convenios

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

Nenhum parâmetro de rota, query ou header.

Corpo da requisição

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

Campos

CampoTipoObrigatórioDescriçãoValoresExemplo
barCodesarray de stringopcional[ … ]
toWalletCodeinteger (int64)opcional0

Exemplo de corpo

{
  "barCodes": [
    "texto"
  ],
  "toWalletCode": 0
}

Response

Resposta 200.

Sem campos estruturados no contrato (tipo primitivo ou livre).

Exemplo de resposta

"texto"

Códigos de retorno

CódigoSignificadoDetalhe do contrato
200Requisição bem-sucedida.
401Não autenticado — token ausente, inválido ou expirado.

Exemplos

curl -X POST "{{baseUrl}}/api/v1/BankSlip/TransferBatch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "barCodes": [
    "texto"
  ],
  "toWalletCode": 0
}'
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/BankSlip/TransferBatch";

var corpo = new StringContent(
    """
    {
      "barCodes": [
        "texto"
      ],
      "toWalletCode": 0
    }
    """,
    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 = {
  "barCodes": [
    "texto"
  ],
  "toWalletCode": 0
};

const resp = await fetch(`${baseUrl}/api/v1/BankSlip/TransferBatch`, {
  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.

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