Endpoint responsável por criar uma nova cobrança retornando uma resposta resumida.
Essa versão é indicada para integrações que precisam registrar cobranças no Asaas, mas não dependem de todos os detalhes retornados pela rota tradicional de cobranças. É uma alternativa útil para fluxos com foco em performance, simplicidade de resposta ou operações em massa.
A cobrança pode ser criada com diferentes formas de pagamento, como boleto, Pix ou cartão de crédito, de acordo com o valor informado em billingType.
Parâmetros principais da requisição
Alguns campos definem o comportamento da cobrança:
-
customer: Identificador único do cliente no Asaas.
-
billingType: Forma de pagamento da cobrança. Os valores possíveis são:
UNDEFINEDBOLETOCREDIT_CARDPIX
-
value: Valor da cobrança.
-
dueDate: Data de vencimento da cobrança.
-
description: Descrição exibida na cobrança.
-
externalReference: Identificador da cobrança no seu sistema. Pode ser utilizado posteriormente em buscas e conciliações.
-
installmentCount: Número de parcelas, quando a cobrança for parcelada.
-
totalValue: Valor total do parcelamento. Quando informado, o Asaas calcula automaticamente o valor de cada parcela.
-
installmentValue: Valor individual de cada parcela. Deve ser utilizado quando sua aplicação precisar definir manualmente o valor de cada parcela.
-
discount: Objeto com as regras de desconto da cobrança.
-
interest: Objeto com as regras de juros por atraso.
-
fine: Objeto com as regras de multa por atraso.
-
postalService: Define se a cobrança será enviada pelos Correios. Aplicável a boleto.
-
split: Lista de configurações de split para divisão de valores entre contas.
-
callback: Objeto com informações de redirecionamento automático após pagamento do link.
-
pixAutomaticAuthorizationId: Identificador da autorização de Pix Automático vinculada à cobrança, quando aplicável.
Regras importantes
-
Para cobranças parceladas, utilize:
installmentCountem conjunto comtotalValue, para cálculo automático das parcelas
ouinstallmentCountem conjunto cominstallmentValue, para definir manualmente o valor por parcela
-
O campo
daysAfterDueDateToRegistrationCancellationé aplicável apenas a boleto bancário. -
O comportamento final da cobrança depende da forma de pagamento escolhida em
billingType.
Quando utilizar
Utilize este endpoint quando for necessário:
- Criar uma cobrança com resposta mais enxuta
- Registrar cobranças sem depender de todos os dados retornados pela rota completa
- Implementar fluxos mais simples de criação e acompanhamento
Próximo passo no fluxo
Após a criação da cobrança, sua aplicação pode:
- consultar os dados resumidos da cobrança
- atualizar a cobrança, se ainda permitido pelo status
- confirmar recebimento em dinheiro, quando aplicável
- acompanhar a liquidação e eventos subsequentes pelos fluxos da cobrança
