Criar um link de pagamentos

Permissão necessária: PAYMENT_LINK:WRITE

Body Params
string
required

Nome do link de pagamentos

string

Descrição do link de pagamentos

string

Data de encerramento

number

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

string
enum
required

Forma de pagamento permitida

Allowed:
string
enum
required

Forma de cobrança

Allowed:
int32

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

string
enum

Periodicidade da cobrança, caso o chargeType seja RECURRENT

Allowed:
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

string

Campo livre para busca

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

boolean

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

Responses

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