Descrição das propriedades do response do endpoint Criar um Carnê — POST v1/payment_booklets
Notas de Atualização
Atualizado em 18/07/2024
- Adição de todas as propriedades.
Propriedade | Descrição |
---|---|
id | Identificador único do carnê. |
external_reference | Referência externa (pode ser null ). |
custom_instruction | Instrução personalizada (pode ser null ). |
description | Descrição do carnê. |
price_cents | Valor total do carnê em centavos (ex: 100 representa R$ 1,00). |
started_at | Data e hora em que o carnê foi iniciado. |
finish_at | Data e hora em que o carnê foi finalizado. |
status | Status atual do carnê (ex: pending ). |
invoices | Lista de faturas associadas ao carnê. |
customer | Informações do cliente associado ao carnê. |
payment_booklet_installments | Número de parcelas no carnê. |
secure_url | URL segura para visualizar o carnê. |
Propriedade invoices
invoices
Subpropriedade | Descrição |
---|---|
id | Identificador único da fatura. |
due_date | Data de vencimento da fatura. |
currency | Moeda utilizada para a fatura (ex: BRL). |
discount_cents | Valor do desconto (quando aplicado) em centavos. |
email | E-mail do destinatário da fatura. |
items_total_cents | Total de todos os itens da fatura em centavos. |
notification_url | URL para notificações relacionadas à fatura (pode ser null ). |
return_url | URL de retorno após pagamento (pode ser null ). |
status | Status atual da fatura (ex: pending). |
total_cents | Valor total da fatura em centavos. |
total_paid_cents | Total pago até o momento em centavos. |
payer_name | Nome do pagador. |
payer_email | E-mail do pagador. |
payer_cpf_cnpj | CPF ou CNPJ do pagador. |
bank_slip | Informações específicas para pagamento via boleto bancário. |
pix | Informações específicas para pagamento via Pix. |
items | Lista de itens associados à fatura. |
Propriedade customer
customer
Propriedade | Descrição |
---|---|
id | Identificador único do cliente. |
email | E-mail do cliente. |
created_at | Data e hora em que o cliente foi criado. |
updated_at | Data e hora da última atualização das informações do cliente. |
name | Nome do cliente. |
cpf_cnpj | CPF ou CNPJ do cliente. |