ABabacatepay

Criar um link do portal do cliente

Changed on

Gera o link do portal do cliente para um cliente e um checkout que ele pagou. Chamar de novo com o mesmo customerId e checkoutId devolve o mesmo link.

O cliente entra no portal com um código de 6 dígitos enviado ao e-mail do cadastro e consegue ver os pagamentos, pedir reembolso, cancelar a assinatura e trocar o cartão.

post/customer-portal/create

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/customer-portal/create
  • Auth
    HTTP bearer

Request body

customerIdstring required

ID do cliente que pagou o checkout

checkoutIdstring required

ID do checkout (avulso ou de assinatura)

Example request

{
  "customerId": "cust_abc123xyz",
  "checkoutId": "bill_abc123xyz"
}

Response

Link do portal criado (ou o existente).

errorstring nullable
successboolean

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

Example response

{
  "data": {
    "id": "cpl_abc123xyz",
    "url": "https://portal.abacatepay.com/k3J9xQ2mP7vL1nR8sT4wY6zA0bC5dE2f",
    "customerId": "cust_abc123xyz",
    "checkoutId": "bill_abc123xyz",
    "createdAt": "2026-10-19T12:00:00.000Z"
  },
  "success": true
}

Changes