ABabacatepay

Criar um link de pagamento

Changed on

Cria um link de pagamento (checkout com frequency MULTIPLE_PAYMENTS). Vários clientes podem pagar o mesmo link; não suporta customerId.

post/payment-links/create

Request

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

Request body

methodsstring[]

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

returnUrlstring uri

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

completionUrlstring uri

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

couponsstring[]

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

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

externalIdstring

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

Exemplo: "seu_id_123"

dueDatestring 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.

metadataobject

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

Exemplo:

{
  "source": "landing-page-black-friday",
  "campaign": "BF-2025"
}
customerIdstring

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

Exemplo: "cust_abcdefghij"

upSellProductIdstring

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"

Example request

{
  "items": [
    {
      "id": "prod-1234",
      "quantity": 2
    }
  ],
  "methods": [
    "PIX",
    "CARD"
  ]
}

Response

Link de pagamento criado com sucesso.

errorstring nullable
successboolean

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

Example response

{
  "data": {
    "id": "bill_abc123xyz",
    "externalId": "pedido-123",
    "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
    "amount": 10000,
    "items": [
      {
        "id": "prod_456",
        "quantity": 2
      }
    ],
    "status": "PENDING",
    "coupons": [],
    "upSellProductId": "prod_bump456xyz",
    "installmentsCount": 3,
    "card": {
      "maxInstallments": 12
    },
    "dueDate": "2026-08-15",
    "interest": {
      "value": 100
    },
    "fine": {
      "value": 200,
      "type": "PERCENTAGE"
    },
    "metadata": {},
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "success": true
}

Changes

  • 319122d4f5fcRevision changes
    • warning

      added the new REDEEMED enum value to the / response property for the response status

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • ea8a72b04f2aRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property