Gerar cobrança Pix

POST/api/v1/baas/charge

Gera uma cobrança Pix e o respectivo QR Code.

Autenticação Basic

Base64

Basic:

A execução usa o ambiente de produção e pode criar uma cobrança real.

cURL

Exemplo gerado

1curl --request POST \2  --url 'https://api.elixbank.com.br/api/v1/baas/charge' \3  --header 'accept: application/json' \4  --header 'Authorization: Basic BASE64(SUA_API_KEY:SEU_SECRET)' \5  --header 'content-type: application/json' \6  --data '{7  "amount": 500,8  "description": "Cobrança Pix",9  "payment_method": "pix",10  "due_date": "2026-07-10",11  "payer_name": "João da Silva",12  "payer_document": "12345678909"13}'

Resposta

Clique em Executar para executar a requisição e visualizar a resposta aqui.

application/json

200 · Resultado422 · Resultado

Parâmetros do body

6 campos

amountnumberObrigatório

Valor da cobrança em centavos. O mínimo é R$ 5,00, portanto envie pelo menos 500.

descriptionstringOpcional

Descrição da cobrança.

payment_methodstringObrigatório

Forma de pagamento. Nesta referência, somente Pix está disponível.

Valor fixo: pix

Padrão: pix

due_datestringOpcional

Data de vencimento da cobrança.

payer_namestringOpcional

Nome do pagador.

payer_documentstringOpcional

CPF ou CNPJ do pagador.

Resposta

200Cobrança Pix

Dados da cobrança criada, incluindo as informações necessárias para o pagamento.

Status HTTP

200

Cobrança criada com sucesso.

400

Payload inválido para a operação.

401

Credenciais ausentes, inválidas ou revogadas.

403

A credencial não possui permissão para acessar o recurso.

422

Erro de validação nos dados enviados.

429

Limite de requisições excedido.

5xx

Erro interno da plataforma.