Criar um link de pagamento

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

Criar um link de pagamento

cURL

curl --request POST \
  --url https://api.abacatepay.com/v2/payment-links/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "frequency": "MULTIPLE_PAYMENTS",
  "items": [
    {
      "id": "prod-1234",
      "quantity": 2
    }
  ],
  "methods": [
    "PIX",
    "CARD"
  ]
}
'

import requests

url = "https://api.abacatepay.com/v2/payment-links/create"

payload = {
    "frequency": "MULTIPLE_PAYMENTS",
    "items": [
        {
            "id": "prod-1234",
            "quantity": 2
        }
    ],
    "methods": ["PIX", "CARD"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    frequency: 'MULTIPLE_PAYMENTS',
    items: [{id: 'prod-1234', quantity: 2}],
    methods: ['PIX', 'CARD']
  })
};

fetch('https://api.abacatepay.com/v2/payment-links/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.abacatepay.com/v2/payment-links/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'frequency' => 'MULTIPLE_PAYMENTS',
    'items' => [
        [
                'id' => 'prod-1234',
                'quantity' => 2
        ]
    ],
    'methods' => [
        'PIX',
        'CARD'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.abacatepay.com/v2/payment-links/create"

	payload := strings.NewReader("{\n  \"frequency\": \"MULTIPLE_PAYMENTS\",\n  \"items\": [\n    {\n      \"id\": \"prod-1234\",\n      \"quantity\": 2\n    }\n  ],\n  \"methods\": [\n    \"PIX\",\n    \"CARD\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.abacatepay.com/v2/payment-links/create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"frequency\": \"MULTIPLE_PAYMENTS\",\n  \"items\": [\n    {\n      \"id\": \"prod-1234\",\n      \"quantity\": 2\n    }\n  ],\n  \"methods\": [\n    \"PIX\",\n    \"CARD\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.abacatepay.com/v2/payment-links/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"frequency\": \"MULTIPLE_PAYMENTS\",\n  \"items\": [\n    {\n      \"id\": \"prod-1234\",\n      \"quantity\": 2\n    }\n  ],\n  \"methods\": [\n    \"PIX\",\n    \"CARD\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": "bill_abc123xyz",
    "externalId": "pedido-123",
    "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
    "amount": 10000,
    "paidAmount": null,
    "items": [
      {
        "id": "prod_456",
        "quantity": 2
      }
    ],
    "status": "PENDING",
    "coupons": [],
    "devMode": false,
    "customerId": null,
    "returnUrl": null,
    "completionUrl": null,
    "receiptUrl": null,
    "upSellProductId": "prod_bump456xyz",
    "installmentsCount": 3,
    "interest": {
      "value": 100
    },
    "fine": {
      "value": 200,
      "type": "PERCENTAGE"
    },
    "metadata": {},
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "error": null,
  "success": true
}

{
  "error": "Token de autenticação inválido ou ausente."
}

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:

{
  "frequency": "MULTIPLE_PAYMENTS",
  "items": [
    { "id": "prod_abc123xyz", "quantity": 1 }
  ],
  "externalId": "link-campanha-123",
  "completionUrl": "https://seusite.com/obrigado",
  "methods": ["PIX", "CARD"]
}

Exemplo com multa e juros (apenas BOLETO):

{
  "frequency": "MULTIPLE_PAYMENTS",
  "methods": ["BOLETO"],
  "items": [
    { "id": "prod_abc123xyz", "quantity": 1 }
  ],
  "interest": { "value": 100 },
  "fine": { "value": 200, "type": "PERCENTAGE" }
}

Compartilhe data.url — cada cliente que acessar o link pode pagar de forma independente.

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

Show child attributes

frequency · enum<string> · default: MULTIPLE_PAYMENTS

Tipo de cobrança fixo para links de pagamento.

Available options: MULTIPLE_PAYMENTS

Example:

"MULTIPLE_PAYMENTS"

methods · enum<string>[]

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

Minimum array length: 1

Available options: PIX, CARD

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.

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"

interest · object

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

Show child attributes

fine · object

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

Show child attributes

metadata · object

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

Exemplo:

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

Response

200

application/json

Link de pagamento criado com sucesso.

data · object

Show child attributes

error · string | null

Example:

null

success · boolean

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

Example:

true