Realizar Pagamento via PIX

Efetua uma transferência PIX a partir de uma conta bancária para a chave de destino previamente consultada.

Este endpoint é utilizado para realizar o envio de um PIX, debitando o valor da conta do usuário autenticado e transferindo-o para o destinatário informado.

A operação requer o identificador da chave PIX (keyInfoId) obtido previamente no endpoint Consultar Informações de uma Chave PIX.

É necessário informar:

  • keyInfoId: ID da chave PIX de destino;

  • amount: valor do PIX (em reais, com até duas casas decimais);

  • pin: código PIN do usuário para autenticação da transação.

O retorno contém o objeto transaction, que representa o PIX iniciado e seus respectivos status.

Endpoint para Realizar Pix

POST /accounts/{accountId}/pix/payment

Este endpoint é protegido e requer o uso do cabeçalho Authorization: Bearer <token> e x-tenant-id.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

x-tenant-id

Tenant ID

Body

Name
Type
Description

keyInfoId

string

Identificador da chave PIX

amount

number

Valor

pin

string

PIN transacional

Response