Body
6 camposamountnumberObrigató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_methodstringOpcional
Forma de pagamento. Nesta referência, somente Pix está disponível.
Valor fixo: pix
Padrão: pix
due_datestringOpcional
Data de vencimento. O Swagger atual não declara um formato adicional.
payer_namestringOpcional
Nome do pagador.
payer_documentstringOpcional
CPF ou CNPJ do pagador.
JSON · Exemplo de payload
{ "amount": 500, "description": "Cobrança Pix", "payment_method": "pix", "due_date": "2026-07-10", "payer_name": "João da Silva", "payer_document": "12345678909"}{ "amount": 500, "description": "Cobrança Pix", "payment_method": "pix", "due_date": "2026-07-10", "payer_name": "João da Silva", "payer_document": "12345678909"}Resposta
200
Não publicadoO Swagger de staging declara sucesso HTTP 200, mas não publica um response_model para esta operação.
Os campos da resposta de sucesso serão documentados quando o contrato for publicado no Swagger ou validado com credenciais de staging.
Status HTTP
200Cobrança criada com sucesso.
400Payload inválido para a operação.
401Credenciais ausentes, inválidas ou revogadas.
403A credencial não possui permissão para acessar o recurso.
422Erro de validação nos dados enviados.
429Limite de requisições excedido.
5xxErro interno da plataforma.