Criar nova cobrança

Endpoint responsável por criar uma nova cobrança no Asaas.

Essa é a principal chamada da jornada de recebimento e pode ser utilizada para gerar cobranças avulsas com boleto, Pix, cartão de crédito ou com forma de pagamento indefinida, permitindo que o pagador escolha como deseja concluir o pagamento.

A cobrança criada por esse endpoint pode ser utilizada em fluxos simples, parcelados, com redirecionamento para a fatura ou vinculados a uma autorização de Pix Automático.


Parâmetros principais da requisição

Alguns campos possuem papel central no comportamento da cobrança:

  • customer — Identificador único do cliente no Asaas ao qual a cobrança será vinculada
  • billingType — Define a forma de pagamento da cobrança. Os valores possíveis são:
    • BOLETO
    • PIX
    • CREDIT_CARD
    • UNDEFINED
  • value — Valor da cobrança. Deve ser utilizado em cobranças avulsas de parcela única
  • dueDate — Data de vencimento da cobrança
  • description — Descrição da cobrança
  • externalReference — Identificador da cobrança no seu sistema. Recomendado para facilitar rastreamento, conciliação e buscas posteriores
  • discount — Objeto com as regras de desconto aplicáveis à cobrança
  • interest — Objeto com as regras de juros para pagamento após o vencimento
  • fine — Objeto com as regras de multa para pagamento após o vencimento
  • split — Objeto com as configurações de divisão do valor recebido entre contas
  • callback — Objeto com as configurações de redirecionamento automático após o pagamento da fatura
  • pixAutomaticAuthorizationId — Identificador da autorização de Pix Automático quando a cobrança estiver vinculada a esse fluxo

Regra sobre a forma de pagamento

Não é possível criar uma única cobrança com dois billingType diferentes ao mesmo tempo, como PIX e CREDIT_CARD.

Quando a integração precisa permitir que o pagador escolha a forma de pagamento, o comportamento correto é utilizar UNDEFINED, desde que os meios desejados estejam habilitados na conta.


Regra importante sobre cobranças avulsas e parceladas

Para cobranças avulsas de uma única parcela, deve ser enviado apenas o campo value.

Os campos abaixo devem ser utilizados somente em cobranças parceladas com duas ou mais parcelas:

  • installmentCount
  • installmentValue
  • totalValue

Essa separação é importante para evitar criação incorreta de parcelamentos em cenários em que a intenção é gerar apenas uma cobrança simples.


Cálculo do parcelamento

Em cobranças parceladas, a integração pode seguir duas abordagens:

  • enviar installmentCount e installmentValue para definir explicitamente a quantidade e o valor das parcelas
  • enviar installmentCount e totalValue para que o Asaas calcule automaticamente o valor de cada parcela

Quando o valor total não permitir divisão exata entre as parcelas, o ajuste será compensado na última parcela.


Cancelamento do registro do boleto após vencimento

O atributo daysAfterDueDateToRegistrationCancellation define por quantos dias após o vencimento o boleto continuará apto para pagamento.

Esse comportamento se aplicará para Boleto, e também para o pagamento Pix que está associado ao boleto original. Para cobranças de cartão de crédito esse atributo não é considerado.

Se o valor enviado for 0, o registro do boleto será cancelado automaticamente quando a cobrança passar para o status OVERDUE, impedindo pagamento após o vencimento.

Se o campo não for informado, será utilizado o prazo padrão de registro da conta.

Esse atributo não pode ser alterado após a criação da cobrança. Caso seja necessário mudar essa regra, será preciso emitir uma nova cobrança.


Multas e juros configurados globalmente

Se a conta possuir configurações globais de multa e juros, o envio dos objetos interest e fine com valores nulos ou vazios poderá sobrescrever essa configuração na cobrança criada.

Se a intenção for manter o comportamento padrão definido na conta, a recomendação é não enviar esses objetos na requisição. Outra possibilidade é padronizar a aplicação para enviar explicitamente os mesmos valores já configurados no Asaas.


Status CONFIRMED em cobranças Pix de pessoas físicas

Em cobranças Pix de contas de pessoa física, o status CONFIRMED pode aparecer temporariamente em casos de bloqueio cautelar para análise da área de prevenção.

Nesses cenários, a análise pode durar até 72 horas. Após esse período, a cobrança poderá evoluir para:

  • RECEIVED, quando o recebimento for confirmado
  • REFUNDED, quando o recebimento for negado

Esse comportamento deve ser considerado pela integração para evitar interpretação incorreta de liquidação definitiva enquanto a análise ainda estiver em andamento.

Body Params
string
required

Identificador único do cliente no Asaas

string
enum
required

Forma de pagamento

Allowed:
number
required

Valor da cobrança

date
required

Data de vencimento da cobrança

string

Descrição da cobrança (máx. 500 caracteres)

int32

Dias após o vencimento para cancelamento do registro (somente para boleto bancário)

string

Campo livre para busca

int32

Número de parcelas (somente no caso de cobrança parcelada)

number

Informe o valor total de uma cobrança que será parcelada (somente no caso de cobrança parcelada). Caso enviado este campo o installmentValue não é necessário, o cálculo por parcela será automático.

number

Valor de cada parcela (somente no caso de cobrança parcelada). Envie este campo em caso de querer definir o valor de cada parcela.

discount
object

Informações de desconto

interest
object

Informações de juros para pagamento após o vencimento

fine
object

Informações de multa para pagamento após o vencimento

boolean

Define se a cobrança será enviada via Correios

split
array of objects

Configurações do split

split
callback
object

Informações de redirecionamento automático após pagamento do link de pagamento

string

Identificador único da autorização do Pix Automático no Asaas

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json