Skip to main content
POST
Essa rota utiliza os certificados e o Bearer Token de Cash In.

Certificados

Esta rota usa autenticação mútua (mTLS). Envie o certificado de Cash In, a chave e a senha na requisição:
--cert
file
required
Certificado de Cash In do cliente (client.crt).
--key
file
required
Chave privada do cliente (client.key).
--pass
string
required
Senha para descriptografar a chave .key, enviada por e-mail junto com os certificados.

Headers

Content-Type
string
required
Formato do corpo da requisição. Use application/json.
Authorization
string
required
Bearer Token de Cash In. Formato: Bearer {access_token}.

Body

calendario.expiracao
integer
required
Tempo em segundos para a cobrança expirar.
devedor.cpf
string
CPF do cliente.
devedor.nome
string
Nome do cliente.
valor.original
string
required
Valor da cobrança em reais. Exemplo: "50.00".
chave
string
required
Chave Pix cadastrada na conta. É retornada ao gerar as credenciais de Cash In.
solicitacaoPagador
string
Descrição do pagamento. Fica visível para o cliente.
infoAdicionais
array
Informações internas opcionais, no formato { "nome": "...", "valor": "..." }.

Resposta

txid
string
Identificador único da cobrança.
status
string
Status da cobrança. Ao criar, retorna ATIVA.
calendario
object
Datas da cobrança.
loc
object
Dados da location do QR Code (id, location, tipoCob).
location
string
URL da location usada para renderizar o QR Code.
valor
object
Valor da cobrança (original).
chave
string
Chave Pix que recebe o pagamento.
pixCopiaECola
string
Código Pix copia e cola que o cliente usa para pagar.