Criar um link de pagamentos

post

https://api-sandbox.asaas.com/v3/paymentLinks

Guia de Link de pagamentos

Confira o guia de link de pagamentos para mais informações.

Caso o seu cliente possa pagar via boleto bancário, será necessário informar o campo dueDateLimitDays, que determina a quantidade de dias úteis para a realização do pagamento após a geração do boleto.

Se a forma de cobrança for Parcelamento, informe o campo maxInstallmentCount para determinar o limite máximo de parcelas que seu cliente poderá escolher para realizar o pagamento parcelado.

Já se a forma de cobrança ser Assinatura, será necessário o envio do campo subscriptionCycle para determinar a periodicidade da geração das cobranças.

Você poderá adicionar imagens ao seu link de pagamentos por meio deste endpoint

Body Params

name

string

required

Nome do link de pagamentos

description

string

Descrição do link de pagamentos

endDate

string

Data de encerramento

value

number

Valor do link de pagamentos, caso não informado o pagador poderá informar o quanto deseja pagar

billingType

string

enum

required

Forma de pagamento permitida

Allowed:

chargeType

string

enum

required

Forma de cobrança

Allowed:

dueDateLimitDays

int32

Quantidade de dias úteis que o seu cliente poderá pagar após o boleto ser gerado (Para forma de pagamento como Boleto)

subscriptionCycle

string

enum

Periodicidade da cobrança, caso o chargeType seja RECURRENT

Allowed:

maxInstallmentCount

int32

Defaults to 1

Quantidade máxima de parcelas que seu cliente poderá parcelar o valor do link de pagamentos caso a forma de cobrança selecionado seja Parcelamento. Caso não informado o valor padrão será de 1 parcela

externalReference

string

Campo livre para busca

notificationEnabled

boolean

Defaults to true

Define se os clientes cadastrados pelo link de pagamentos terão as notificações habilitadas. Caso não seja informado o valor padrão será true

callback

object

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

isAddressRequired

boolean

True para tornar obrigatório o preenchimento de dados de endereço no checkout.

Responses

Guia de Link de pagamentos

200Ok

400Bad Request

401Unauthorized