O Pix pode ser criado de duas formas: por chave ou por dados bancários.

Criar pagamento Pix via chave

POST /v1/pagamentos/pix/chave, escopo multipag.pix.pagar.

Campos do body:

Campo	Tipo	Obrigatório	Observações
chavePix	texto (máx. 77)	Sim	Ver formatos por tipo de chave abaixo
conta	texto	Sim	Conta com DV, sem traço
cooperativa	texto	Sim	4 dígitos, zeros à esquerda
dataPagamento	data	Sim	AAAA-MM-DD
documento	texto	Sim	CPF/CNPJ do associado (só números)
documentoBeneficiario	texto (máx. 20)	Sim	Documento do favorecido
identificadorPagamentoAssociado	texto (máx. 100)	Sim	Identificador do associado
idTransacao	texto (máx. 100)	Sim	ID da transação
mensagemPix	texto (140)	Não	Descrição do pagamento
valorPagamento	decimal	Sim	Mín. 0, 2 casas decimais
nomeBeneficiario	texto (máx. 100)	Não	Exibido na tela de aprovação (ver Aprovação)

Formatos de chavePix:

Telefone: inicia com +, código do país (55), DDD e número de 9 dígitos.
E-mail: contém @, máx. 77 caracteres, sempre minúsculo.
Chave aleatória: hexadecimal de 32 posições, dividido em 5 blocos separados por - (36 posições totais, com os traços).
CPF/CNPJ: somente números.

Exemplo de request:

{
  "conta": "000001",
  "cooperativa": "0100",
  "documento": "11111111000111",
  "chavePix": "+5511999999999",
  "documentoBeneficiario": "11111111111",
  "dataPagamento": "2026-08-14",
  "valorPagamento": 20.1,
  "identificadorPagamentoAssociado": "EMP:001",
  "mensagemPix": "Pagamento ordem 001",
  "idTransacao": "0910F3HT1"
}

Exemplo de response (200 OK):

{
  "idPagamentoPix": "9a0dd426-5e88-4113-bc4d-5b753ca4ee88",
  "agenciaBeneficiario": "0101",
  "ispbBeneficiario": "91586982",
  "contaBeneficiario": "011119",
  "tipoContaBeneficiario": "CORRENTE",
  "nomeBeneficiario": "Anderson Silva",
  "documentoBeneficiario": "11111111111",
  "mensagemPix": "Pagamento ordem 001",
  "dataPagamento": "2026-08-14",
  "identificadorPagamentoAssociado": "EMP:001",
  "valorPagamento": 20.1,
  "idTransacao": "0910F3HT1",
  "chavePix": "+5511999999999",
  "status": "RECEBIDO"
}

Criar pagamento Pix via dados bancários

POST /v1/pagamentos/pix/dados-bancarios, escopo multipag.pix.pagar.

Campos adicionais/específicos do body: agenciaBeneficiario (máx. 4), contaBeneficiario (máx. 20), ispbBeneficiario (8 dígitos, zeros à esquerda), nomeBeneficiario (máx. 100), tipoContaBeneficiario (CORRENTE, PAGAMENTO, SALARIO, POUPANCA), além de conta, cooperativa, documento, documentoBeneficiario, dataPagamento, identificadorPagamentoAssociado, idTransacao, mensagemPix, valorPagamento.

Exemplo de request:

{
  "conta": "000001",
  "cooperativa": "0100",
  "documento": "11111111000111",
  "idTransacao": "0810AA1HJ1",
  "dataPagamento": "2026-08-14",
  "agenciaBeneficiario": "0101",
  "ispbBeneficiario": "91586982",
  "contaBeneficiario": "011119",
  "valorPagamento": 51.22,
  "tipoContaBeneficiario": "CORRENTE",
  "identificadorPagamentoAssociado": "EMP:006",
  "nomeBeneficiario": "Anderson Silva",
  "documentoBeneficiario": "11111111111",
  "mensagemPix": "Pagamento disponivel"
}

Cancelar pagamento agendado

PATCH /v1/pagamentos/pix/cancelamentos escopo multipag.pix.pagar. Body: conta, cooperativa, documento, idTransacao. Retorno 200 OK com body vazio.

Buscar pagamento

GET /v1/pagamentos/pix/{idTransacao}, escopo multipag.pix.consultar. Headers: Authorization, x-conta, x-cooperativa, x-documento. Na consulta, o response inclui nomeInstituicaoDestino e o endToEnd (identificador da transação Pix no SPI).

Buscar comprovante

GET /v1/pagamentos/pix/{idTransacao}/comprovantes escopo multipag.pix.consultar. Disponível apenas para status SUCESSO. Retorna PDF binário, ver Comprovantes.