Criar nova cobrança

Cria uma nova cobrança vinculada a um cliente na conta Asaas.

Use esta operação para cobranças avulsas ou parceladas por boleto, Pix ou cartão de crédito. Quando billingType for UNDEFINED, o pagador poderá escolher entre as formas de pagamento habilitadas na conta ao acessar a Fatura.

Para cobranças avulsas, informe value. Para cobranças parceladas, utilize installmentCount com apenas um entre installmentValue e totalValue. Ao utilizar totalValue, o Asaas calcula o valor das parcelas e aplica eventual diferença de arredondamento à última parcela. Nesse cenário, a resposta representa a primeira cobrança gerada e inclui o ID do parcelamento.

Se a conta possui configurações globais de multa e juros e elas devem ser mantidas, não envie interest e fine. O envio desses objetos com valores nulos ou vazios pode sobrescrever a configuração para a cobrança criada.

Para cobranças por boleto, daysAfterDueDateToRegistrationCancellation define por quantos dias após o vencimento o registro continuará disponível para pagamento. O valor 0 cancela o registro quando a cobrança passa para OVERDUE; quando o campo é omitido, aplica-se a configuração padrão da conta. Essa definição não pode ser alterada após a criação da cobrança.

Ao criar cobranças recorrentes de Pix Automático no modo MANUAL, informe pixAutomaticAuthorizationId de uma autorização ACTIVE. A instrução de pagamento deve ser criada entre 2 e 10 dias úteis antes do vencimento. Sem esse campo, a cobrança PIX é criada como Pix convencional.

📘

Acompanhamento do pagamento

A criação da cobrança não representa a confirmação do pagamento. Acompanhe as mudanças de status pelos Webhooks de cobranças.

Em cobranças Pix de contas de pessoa física, CONFIRMED pode ser temporário durante bloqueio cautelar, por até 72 horas. Após a análise, a cobrança pode seguir para RECEIVED ou REFUNDED.

Consulte os eventos de Webhook para cobranças.

Conteúdos relacionados

Guides

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