Criar um Carnê — Propriedades do response

Descrição das propriedades do response do endpoint Criar um Carnê — POST v1/payment_booklets

Notas de Atualização

Atualizado em 18/07/2024

  1. Adição de todas as propriedades.
PropriedadeDescrição
idIdentificador único do carnê.
external_referenceReferência externa (pode ser null).
custom_instructionInstrução personalizada (pode ser null).
descriptionDescrição do carnê.
price_centsValor total do carnê em centavos (ex: 100 representa R$ 1,00).
started_atData e hora em que o carnê foi iniciado.
finish_atData e hora em que o carnê foi finalizado.
statusStatus atual do carnê (ex: pending).
invoicesLista de faturas associadas ao carnê.
customerInformações do cliente associado ao carnê.
payment_booklet_installmentsNúmero de parcelas no carnê.
secure_urlURL segura para visualizar o carnê.

Propriedade invoices

SubpropriedadeDescrição
idIdentificador único da fatura.
due_dateData de vencimento da fatura.
currencyMoeda utilizada para a fatura (ex: BRL).
discount_centsValor do desconto (quando aplicado) em centavos.
emailE-mail do destinatário da fatura.
items_total_centsTotal de todos os itens da fatura em centavos.
notification_urlURL para notificações relacionadas à fatura (pode ser null).
return_urlURL de retorno após pagamento (pode ser null).
statusStatus atual da fatura (ex: pending).
total_centsValor total da fatura em centavos.
total_paid_centsTotal pago até o momento em centavos.
payer_nameNome do pagador.
payer_emailE-mail do pagador.
payer_cpf_cnpjCPF ou CNPJ do pagador.
bank_slipInformações específicas para pagamento via boleto bancário.
pixInformações específicas para pagamento via Pix.
itemsLista de itens associados à fatura.

Propriedade customer

PropriedadeDescrição
idIdentificador único do cliente.
emailE-mail do cliente.
created_atData e hora em que o cliente foi criado.
updated_atData e hora da última atualização das informações do cliente.
nameNome do cliente.
cpf_cnpjCPF ou CNPJ do cliente.