Como realizar o upsert de uma cobrança
Não há rate limit.
Atenção
Evite usar valores dinâmicos (como timestamps) como seus Integration Identifiers.
Atributos do objeto Billing
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| address_city | String - Obrigatório - Não vazio | Cidade do endereço do cliente. | "São Paulo" |
| address_complement | String - Obrigatório - Não vazio | Complemento do endereço do cliente. | "Second Floor" |
| address_neighborhood | String - Obrigatório - Não vazio | Bairro do endereço do cliente. | "Brooklyn" |
| address_number | String - Obrigatório - Não vazio | Número do endereço do cliente. | "356" |
| address_state | AddressStateEnum - Obrigatório - Não vazio | Sigla do estado onde o cliente está localizado. | "SP" |
| address_street | String - Obrigatório - Não vazio | Nome da rua do endereço do cliente. | "Avenida Paulista" |
| address_zip_code | String - Obrigatório - Não vazio | CEP do endereço do cliente. | "01405-001" |
| amount | Number - Obrigatório - Não vazio | Valor total da cobrança em centavos de real (BRL), sem vírgulas. | 10050 |
| type | BillingTypeStrEnum - Obrigatório - Não vazio | Tipo de método de pagamento. | "pix" |
| boleto_pdf | String - Opcional - Não vazio | URL para download do arquivo PDF do boleto. | "https://yourdomain.com.br/path_to_file/boleto.pdf" |
| boleto_base64 | String - Opcional - Não vazio | Conteúdo em base64 que gera um arquivo PDF de boleto. | - |
| boleto | Boleto - Opcional - Não vazio | Detalhes para geração de boleto PDF quando o tipo for "generic". | See field descriptions |
| customer_document | String - Obrigatório - Não vazio | CPF (11 dígitos) ou CNPJ (14 dígitos) do cliente. | "75730786000100" |
| code | String - Opcional - Não vazio | Linha digitável do boleto gerado quando o método de pagamento for "generic". | "45454 45454656465 5454564656 61 46445456465465" |
| hash | String - Opcional - Não vazio | Código “Pix Copia e Cola” gerado quando o método de pagamento for "generic". | "45454 45454656465 5454564656 61 46445456465465" |
| customer_mail | String - Obrigatório - Não vazio | E-mail principal do cliente que receberá a cobrança. | "customer@gmail.com" |
| customer_name | String - Obrigatório - Não vazio | Nome do cliente. | "Maria Quinteros" |
| customer_phone | String - Obrigatório - Não vazio | Telefone do cliente com DDI. | "+5511987654321" |
| customer_secondary_phone | String - Opcional - Empty | Telefone secundário do cliente. | "+5511987654321" |
| discount_before_payment | Number - Obrigatório - Não vazio | Porcentagem de desconto se pago antes do vencimento. | 5 |
| discount_before_payment_due_date | Number - Obrigatório - Não vazio | Dias antes do vencimento em que o desconto se aplica. | 5 |
| due_date | Number - Obrigatório - Não vazio | Data de vencimento no formato Unix Timestamp. | 1678316400 |
| fees | Number - Obrigatório - Não vazio | Percentual de multa mensal em caso de não pagamento. | 1 |
| fine | Number - Obrigatório - Não vazio | Percentual de multa por atraso. | 2 |
| installment_type | InstallmentTypeStrEnum - Obrigatório - Não vazio | Tipo de parcelamento para cálculo da data de vencimento. | "custom" |
| installments | Number - Obrigatório - Não vazio | Número de parcelas. | 2 |
| installments_data | List [InstallmentDataEnum] - Opcional, mas obrigatório caso installment_type for "custom" - Não vazio | Objeto contendo detalhes das parcelas. | Ver o exemplo abaixo |
| integration_identifier | String - Opcional - Não vazio | Identificador customizado da cobrança. | "Neofin-103923" |
| nfe_number | String - Opcional - Não vazio | Identificador da nota fiscal ou recibo. | "123123123" |
| recipients | List[String] - Opcional - Não vazio | E-mails para receber cópia da cobrança (CC). | ["email1@company.com", "email2@company.com"] |
| description | String - Opcional - Não vazio | Comentário ou descrição da cobrança. | "Thanks for paying." |
| ignore_existing_customer_upsert | Boolean - Opcional | Quando valor for verdadeiro, a atualização dos dados do cliente não será realizada na Neofin se ele já estiver cadastrado. | true |
AddressStateEnum
{{$location.state(abbreviated=true,locale='pt_BR')}}
InstallmentTypeStrEnum
InstallmentTypeEnum
enum<string>
InstallmentTypeEnum
Allowed values:
weeklybiweeklymonthlycustom
BillingTypeStrEnum
BillingType
enum<string>
BillingType
Allowed values:
genericbolepixboletopix
InstallmentData
Campos
| Campo | Tipo | Descrição |
|---|---|---|
| amount | Number | Valor da parcela em centavos BRL. |
| due_date | Number | Data de vencimento formatada como Unix Timestamp. |
| installment_number | Number | Número da parcela. |
Boleto
Campos
| Campo | Tipo | Descrição |
|---|---|---|
| barcode_number | String | Código necessário para gerar o código de barras. |
| discount_value | Number | Valor nominal de desconto antes do vencimento. |
| discount_value_2 | Number | Valor nominal de abatimentos. |
| document_due_date | String | Data de vencimento no padrão ISO 8601. |
| document_issue_date | String | Data da última atualização do documento, no padrão ISO 8601. |
| document_number | String | Número do documento informado pelo banco ao gerar o boleto. |
| document_processing_date | String | Data de criação do documento no padrão ISO 8601. |
| document_value | Number | Valor da cobrança em decimal. |
| drawee_name | String | Nome do beneficiário. |
| drawee_tax_number | String | Documento do beneficiário (CPF ou CNPJ). |
| fillable_code | String | Linha digitável do boleto. |
| fine_rate | Number | Percentual de multa. |
| interest_rate | Number | Percentual de juros. |
| recipient_bank_code | String | Código do banco onde o boleto foi gerado. |
| recipient_bank_digit | String | Dígito do código do banco. |
| recipient_bank_internal_number | String | Número gerado pelo banco ao criar o boleto (normalmente o "nosso número"). |
| branch | String | Número da agência bancária. |
| account_number | String | Número da conta bancária do beneficiário. |
| account_number_digit | String | Dígito da conta bancária. |
| charging_category | String | Categoria da cobrança para fins de classificação. |
Exemplo de Boleto
{
"barcode_number": "123456789012",
"discount_value": 50,
"discount_value_2": 10,
"document_due_date": "2025-04-01T12:00:00Z",
"document_issue_date": "2025-03-28T12:00:00Z",
"document_number": "4545454545",
"document_processing_date": "2025-03-28T12:00:00Z",
"document_value": 150.75,
"drawee_name": "Maria Quinteros",
"drawee_tax_number": "75730786000100",
"fillable_code": "1234567890",
"fine_rate": 2,
"interest_rate": 1,
"recipient_bank_code": "033",
"recipient_bank_digit": "6",
"recipient_bank_internal_number": "12345678",
"branch": "1234",
"account_number": "567890",
"account_number_digit": "1",
"charging_category": "standard"
}Casos de uso
Parcelamento Automático
Exemplo: Hoje é 01/01/2024 e você quer cobrar R$1.000,00 de um cliente que irá pagar em 10 parcelas de R$100,00. A primeira data de vencimento desejada é 01/02/2024.
Parcelamento Personalizado
Exemplo: Hoje é 01/01/2024 e você quer cobrar R$1.000,00 de um cliente que irá pagar em 3 parcelas:
R$100,00 com vencimento em 01/02/2024
R$200,00 com vencimento em 10/02/2024
R$700,00 com vencimento em 20/02/2024
Métodos de Pagamento
Exemplo de requisição cURL
{
"message": "Billings successfully queued.",
"errors": {}
}