Quando usar o link de pagamento
Use o link quando o mesmo valor vai ser pago por muitas pessoas: inscrições, doações, uma venda divulgada no WhatsApp ou no Instagram. Para cobrar um pedido específico, uma vez, use o checkout. No dashboard, os dois ficam em telas diferentes: o link em Sua Loja → Links de pagamento e o checkout em Sua Loja → Cobranças.Como funciona o link de pagamento
O link nasce Ativo (ACTIVE) e aceita pagamentos até você desativá-lo. Cada pagamento aparece dentro do link no dashboard e gera um webhook checkout.completed.
Desativado (CANCELLED), o link para de abrir e não aceita novos pagamentos. Os pagamentos que já entraram continuam no dashboard.
Regras
- Mesmas regras do checkout. Valor mínimo, itens, cupons, idempotência por
externalId, URLs de finalização e de retorno e as flagsskip_customereskip_addressfuncionam como no checkout. - Sem cliente fixo. Cada cliente preenche os próprios dados na página. Mandar
customerIddá erro:You cannot pass a customer for a checkout with multiple payments frequency. - Sem Apple Pay e Google Pay. As carteiras só valem no checkout. Mandar
APPLE_PAYouGOOGLE_PAYemmethodsdá erro:Apple Pay and Google Pay are only available for one-time checkouts. - Sem upsell. A oferta de upsell depois da compra só existe no checkout.
- Parcelamento e repasse de taxa. O link aceita
card.maxInstallmentsecard.passFeesToCustomer, como o checkout. Veja Parcelamento no cartão e Repasse de taxa. - Boleto.
dueDate,interestefineexigemBOLETOemmethods. Veja Boleto. - Sem prazo de validade. O link não expira. Ele fica ativo até você desativá-lo.
paidAmountficanull. O link não acumula o total recebido. Para acompanhar os pagamentos, use o dashboard ou os webhooks.- Cupom de 100%. Quando um cliente fecha a compra com um cupom que zera o valor, o link continua
ACTIVEpara os próximos.
Como criar um link de pagamento pelo dashboard
1
Abra os links de pagamento
No menu, vá em Sua Loja → Links de pagamento e clique em Criar link de pagamento.
2
Preencha o link
- Produtos: os produtos avulsos da loja. Cada produto entra com quantidade 1.
- Métodos de pagamento: Pix, cartão ou boleto, conforme o que a sua conta tem liberado.
- Parcelas no cartão e Repassar a taxa do cartão ao cliente: aparecem quando a sua conta tem esses recursos.
- Cupons (opcional).
- URL de finalização (opcional): para onde o cliente vai depois de pagar.
- URL de retorno (opcional): para onde ele volta se desistir.
3
Compartilhe o link
Abra o link na lista e copie a URL. Ela tem o formato
https://app.abacatepay.com/pay/bill_....4
Acompanhe os pagamentos
Na tela do link, você vê Total arrecadado (bruto), Total de compradores e a lista de pagamentos. Ali também dá para editar os métodos de pagamento e os cupons, e desativar ou ativar o link pelo botão ao lado do status.
Como criar um link de pagamento pela API
1
Crie uma chave de API
Em Integração → API, crie uma chave com a permissão
CHECKOUT:CREATE. Veja Chaves de API.2
Crie o link
customerId e sem upSellProductId. A rota já cria o link: não mande frequency. A resposta traz status: "ACTIVE", frequency: "MULTIPLE_PAYMENTS" e a url para compartilhar.3
Receba os pagamentos
Cada pagamento gera um
checkout.completed. Grave o id de cada evento para não processar o mesmo pagamento duas vezes.
As rotas de checkout (
/checkouts/get e /checkouts/list) não trazem links de pagamento.
Notificações
Cada pagamento do link gera umcheckout.completed, com checkout.frequency: "MULTIPLE_PAYMENTS" e checkout.status: "ACTIVE". O checkout.amount do evento é o valor daquele pagamento: para saber quanto o link arrecadou, some os eventos.
Reembolsos e disputas dos pagamentos do link chegam pelos mesmos eventos do checkout. Veja Eventos de checkout e Webhooks.
Testar no Modo Teste
Crie o link com o Modo Teste ligado ou com uma chaveabc_dev_. Abra o link e clique em Simular Pagamento, o botão final da página. Repita quantas vezes quiser: cada simulação conta como um pagamento novo do link.
Perguntas frequentes
O link de pagamento expira?
O link de pagamento expira?
Não. Ele aceita pagamentos até você desativá-lo em Sua Loja → Links de pagamento.
Qual a diferença entre link de pagamento e checkout?
Qual a diferença entre link de pagamento e checkout?
O link aceita vários pagamentos, de clientes diferentes. O checkout aceita um pagamento só e pode ter o cliente definido na criação. No dashboard, o link fica em Links de pagamento e o checkout em Cobranças.
Dá para parcelar no cartão pelo link?
Dá para parcelar no cartão pelo link?
Sim. Escolha o número máximo de parcelas em Parcelas no cartão, no dashboard, ou mande
card.maxInstallments na API. Veja Parcelamento no cartão.Como sei quanto o link já recebeu?
Como sei quanto o link já recebeu?
Na tela do link, em Total arrecadado (bruto). Pela API, some o
checkout.amount de cada checkout.completed. O campo paidAmount do link fica null.Posso definir o cliente que vai pagar?
Posso definir o cliente que vai pagar?
Não. Para cobrar um cliente específico, crie um checkout com
customerId.Dá para mudar o link depois de criado?
Dá para mudar o link depois de criado?
No dashboard, você edita os métodos de pagamento e os cupons, e desativa ou ativa o link. Para mudar os produtos, crie um link novo.