Pular para o conteúdo principal
Realiza uma transferência via Pix.
Por meio deste endpoint, o parceiro pode efetuar transferências de valores através de uma chave Pix, dados bancários ou por QrCode.
Em produção a utilização de HandShake e HMAC é obrigatória.
Transferência via Chave PIX: Neste modelo para que o cliente obtenha sucesso na requisição é necessário realizar a consulta da chave no endpoint /api/Chave/Consultar para obter o “ticket” nesse caso é obrigatória a informação da chave que receberá a transferência do recurso.Transferência via Dados Bancários: Neste modelo para que o cliente obtenha sucesso na requisição é necessário informar os dados da conta destino, incluindo agencia, conta, tipo de conta, modelo de conta, ISPB do destino, nome e documento federal beneficiário.Transferência via QrCode: Neste modelo para que o cliente obtenha sucesso na requisição é necessário realizar a consulta da chave no endpoint /api/QRCode/Ler para obter o “codigoLeituraQRCode

Autorizações

Authorization
string
header
obrigatório

Copie 'Bearer ' + token

Cabeçalhos

IdempotencyKey
string
obrigatório
IgnoraHandshake
boolean
padrão:true
obrigatório

(somente em homologação)

Corpo

dadosEnvioPorChave
object | null

Objeto detalhando os dados da chave Pix para transação.

Observação:

  • Obrigatório para transações através de chave.
dadosEnvioPorConta
object | null

Objeto detalhando os dados da Conta para transação.

Observação:

  • Obrigatório para transações através de dados da conta.
valor
number<double>

Valor da Transação.*

codigoOperacaoCliente
string | null

Identificador fornecido pelo remetente para facilitar a conciliação e o rastreamento da transação.

descricaoCliente
string | null

Descrição opcional fornecida pelo Remetente.

prioridade
enum<integer> | null

Prioridade do PIX.

Valores: 0 - URGENTE 1 - NORMAL

Opções disponíveis:
0,
1
contaOrigem
object | null

Objeto detalhado da conta bancária do remetente.*

informacoesAdicionais
string | null

Detalhes adicionais relacionados à transação Pix.*

idConciliacaoRecebedor
string | null

Identificador de conciliação do recebedor da transação (TXID).

tpQRCode
enum<integer> | null

Tipo de QRCODE.

Valores: 1 - Estático 2 - Dinâmico 3 - Composto

Opções disponíveis:
1,
2,
3
codigoLeituraQRCode
string<uuid>

Indentificador UUID de leitura do QR Code.

Resposta

Success

sucesso
boolean
mensagem
string | null
codigoTransacao
string<uuid>