Criar cobrança com cartão de crédito com dados resumidos na resposta

Endpoint responsável por criar uma cobrança com cartão de crédito retornando uma resposta resumida.

Essa chamada deve ser utilizada quando a forma de pagamento da cobrança for cartão de crédito e sua integração precisar informar os dados do cartão, o token do cartão ou realizar uma pré-autorização.

Parâmetros principais da requisição

Além dos campos comuns da criação de cobrança, este endpoint possui parâmetros específicos para cartão:

  • customer: Identificador único do cliente no Asaas.

  • billingType: Forma de pagamento da cobrança. Para este fluxo, a cobrança deve ser criada com cartão de crédito.

  • value: Valor da cobrança.

  • dueDate: Data de vencimento da cobrança.

  • creditCard: Objeto com os dados do cartão de crédito.

  • creditCardHolderInfo: Objeto com os dados do titular do cartão.

  • creditCardToken: Token do cartão para uso da funcionalidade de tokenização, quando aplicável.

  • authorizeOnly: Define se a operação será apenas uma pré-autorização, sem captura imediata.

  • remoteIp: IP de onde o cliente está realizando a compra. Deve ser informado o IP do comprador, e não o IP do servidor da integração.

  • split: Configurações de split da cobrança.

  • discount, interest, fine: Objetos com regras financeiras complementares da cobrança.


Regra importante sobre pré-autorização

Quando authorizeOnly for informado como true, a cobrança será criada apenas com a autorização da transação no cartão, sem captura imediata do valor.

Nesse cenário, a integração deverá utilizar posteriormente o endpoint de captura para concluir a cobrança.


Quando utilizar

Utilize este endpoint quando for necessário:

  • criar cobranças com cartão de crédito
  • utilizar tokenização de cartão
  • implementar fluxos com pré-autorização e captura posterior
  • obter resposta resumida em vez da resposta completa da rota tradicional

Próximo passo no fluxo

Dependendo do cenário, após a criação sua aplicação pode:

  • capturar a cobrança, em casos de pré-autorização
  • consultar a cobrança criada
  • acompanhar o status do pagamento
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

creditCard
object

Informações do cartão de crédito

creditCardHolderInfo
object

Informações do titular do cartão de crédito

string

Token do cartão de crédito para uso da funcionalidade de tokenização de cartão de crédito

boolean

Realizar apenas a Pré-Autorização da cobrança

string
required

IP de onde o cliente está fazendo a compra. Não deve ser informado o IP do seu servidor.

Responses

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