Skip to main content
POST
Criar um link de pagamento
Cria um link de pagamento que pode ser pago por múltiplos clientes — ideal para vendas em massa, rifas ou formulários de inscrição sem criar um checkout por cliente.

Obrigatório

Envie "frequency": "MULTIPLE_PAYMENTS" junto com items. O restante dos parâmetros é idêntico ao Checkout.
Exemplo:
Exemplo com multa e juros (apenas BOLETO):
Compartilhe data.url — cada cliente que acessar o link pode pagar de forma independente.
Use dueDate (YYYY-MM-DD) para definir a data de vencimento. Se omitido, o padrão é 3 dias úteis. Só se aplica a methods: ["BOLETO"] — veja a referência completa.
Use interest e fine para configurar juros por atraso e multa caso o pagamento ocorra depois do vencimento. Os campos só se aplicam a methods: ["BOLETO"] e seguem o mesmo formato do checkout — veja a referência completa.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json
items
object[]
required

Lista de itens incluídos na cobrança. Este é o único campo obrigatório — o valor total é calculado a partir destes itens.

Minimum array length: 1
methods
enum<string>[]

Métodos de pagamento disponíveis. Padrão ["PIX", "CARD"].

Minimum array length: 1
Available options:
PIX,
CARD,
BOLETO
returnUrl
string<uri>

URL para onde o cliente será redirecionado ao clicar em "Voltar" no checkout.

completionUrl
string<uri>

URL para onde o cliente será redirecionado após o pagamento ser concluído.

customerId
string

ID de um cliente já cadastrado na sua loja. Se informado, o checkout será pré-preenchido com os dados deste cliente.

Exemplo: "cust_abcdefghij"

coupons
string[]

Lista de cupons que podem ser utilizados nesta cobrança.

Exemplo: ["ABKT10", "ABKT5", "PROMO10"]

Maximum array length: 50
externalId
string

ID da cobrança no seu sistema, caso queira manter uma referência própria.

Exemplo: "seu_id_123"

upSellProductId
string

ID de um produto avulso (sem cycle) a ser ofertado como upsell após a conclusão do pagamento.

O produto deve estar com status: ACTIVE e não pode ter cycle — apenas produtos de pagamento único são aceitos.

Exemplo: "prod_bump456xyz"

dueDate
string<date>

Data de vencimento do boleto no formato YYYY-MM-DD (ex: "2026-08-15"). Opcional. Só é válido quando methods inclui BOLETO; ignorado nos demais métodos.

Se omitido, o vencimento padrão é de 3 dias úteis. Não pode ser data no passado. Máximo de 365 dias no futuro.

Example:

"2026-08-15"

interest
object

Juros por atraso, aplicados apenas quando methods inclui BOLETO. Ignorado para PIX/CARD.

fine
object

Multa por atraso, aplicada apenas quando methods inclui BOLETO. Ignorado para PIX/CARD.

metadata
object

Metadados adicionais da cobrança. Campo livre para a sua aplicação.

Exemplo:

card
object

Configuração do pagamento por cartão. Só tem efeito quando methods inclui CARD.

Response

Link de pagamento criado com sucesso.

data
object
error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true