Criar cobrança com cartão de crédito

Endpoint responsável por criar uma cobrança com forma de pagamento em cartão de crédito.

Essa chamada pode ser utilizada de duas formas:

  • criando a cobrança e redirecionando o pagador para a invoiceUrl, onde ele informará os dados do cartão na interface do Asaas
  • criando a cobrança com os dados do cartão e do titular já enviados na requisição, permitindo tentativa imediata de processamento

Formas de uso do endpoint

A integração pode optar por um fluxo com redirecionamento para a fatura ou por um fluxo de captura direta dos dados do cartão.

Quando a aplicação envia os objetos creditCard e creditCardHolderInfo, a tentativa de autorização é feita no momento da criação da cobrança.

Quando esses dados não são enviados, o pagamento poderá ser concluído posteriormente na interface da fatura.


Parâmetros principais da requisição

Além dos atributos gerais de cobrança, esse endpoint aceita campos específicos de cartão:

  • creditCard — Objeto com os dados do cartão
  • creditCardHolderInfo — Objeto com os dados do titular do cartão
  • creditCardToken — Token de cartão gerado anteriormente para reutilização segura do meio de pagamento
  • authorizeOnly — Quando enviado como true, realiza apenas a pré-autorização do valor
  • remoteIp — IP de origem do comprador. Deve ser informado o IP do cliente final, e não o IP do servidor da aplicação

Processamento imediato da transação

Quando os dados do cartão e do titular são enviados na requisição, a tentativa de processamento é feita imediatamente.

  • Se a transação for autorizada, a cobrança será criada e a API retornará HTTP 200
  • Se a transação não for autorizada, a cobrança não será persistida e a API retornará HTTP 400

Validação dos dados do titular

Os dados informados em creditCardHolderInfo devem corresponder aos dados registrados no emissor do cartão.

Quando houver divergência relevante, a transação poderá ser negada por suspeita de fraude. Esse cuidado é especialmente importante em integrações com checkout transparente.


Regra importante sobre data de vencimento

Independentemente da data informada em dueDate, a captura da cobrança no cartão ocorre no momento da criação, quando a integração envia os dados do cartão para processamento imediato.

Ou seja, o campo de vencimento não posterga a cobrança no cartão nesse tipo de fluxo.


Tokenização de cartão

Após uma primeira transação com cartão aprovada, a resposta do Asaas pode retornar o atributo creditCardToken.

Esse token pode ser armazenado e reutilizado em transações futuras, substituindo os objetos creditCard e creditCardHolderInfo. Isso reduz a necessidade de trafegar novamente dados sensíveis do cartão e simplifica os fluxos seguintes.

O token é armazenado por cliente e não pode ser utilizado em transações de outros clientes.


Requisitos de segurança

Caso a aplicação capture os dados do cartão na própria interface, o uso de HTTPS é obrigatório.


❗️

Atenção

Sem SSL, a conta pode ser bloqueada para transações com cartão de crédito.

Esse requisito deve ser observado em qualquer checkout próprio que manipule dados sensíveis do pagador.


Timeout recomendado

Para reduzir risco de timeout e evitar tentativas duplicadas de captura, a recomendação é configurar timeout mínimo de 60 segundos nessa requisição.


Parcelamento no cartão

É permitido criar parcelamentos no cartão de crédito com limites diferentes conforme a bandeira:

  • cartões Visa e Master: até 21 parcelas
  • demais bandeiras: até 12 parcelas

Esse comportamento deve ser considerado pela integração ao montar as opções de parcelamento disponíveis ao usuário final.


Pré-autorização

Quando o campo authorizeOnly é enviado como true, a cobrança é criada em modo de pré-autorização.

Nesse fluxo, o valor não é capturado imediatamente. Em vez disso, é feita uma reserva no limite do cartão do cliente, que poderá ser capturada posteriormente.

A cobrança criada com pré-autorização fica com status AUTHORIZED após criação bem-sucedida.


Prazo de pré-autorização

O prazo da pré-autorização define por quanto tempo o valor permanecerá reservado no limite do cartão.

O prazo padrão é de 3 dias. Para contas elegíveis, esse prazo pode ser configurado para até 25 dias, conforme regras das bandeiras e enquadramento da conta em MCCs específicos.

Se a captura não ocorrer dentro do prazo configurado, a reserva será revertida automaticamente.

A configuração do prazo é aplicada apenas a novas pré-autorizações e não altera cobranças já criadas.


Sandbox

No sandbox, as transações são aprovadas automaticamente.

Para simular erro, devem ser utilizados os números de cartão de teste informados na documentação.

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