# Links de pagamento

Um link de pagamento é uma página de cobrança hospedada por nós envie a URL pronta ao seu cliente, sem precisar montar seu próprio checkout.

## Criar

`POST /checkouts`

| Campo | Tipo |  | Descrição |
| --- | --- | --- | --- |
| `title` | string | obrigatório | Título exibido na página, até 160 caracteres. |
| `amount` | integer | obrigatório | Valor em centavos. Mínimo 100. |
| `description` | string | opcional | Texto de apoio na página. |
| `allow_pix` | boolean | opcional | Padrão true. |
| `allow_card` | boolean | opcional | Padrão false. |
| `allow_boleto` | boolean | opcional | Padrão false. |
| `max_installments` | integer | opcional | Parcelamento máximo no cartão. Padrão 1. |
| `single_use` | boolean | opcional | Padrão true o link expira sozinho após o primeiro pagamento. |
| `return_url` | string | opcional | Para onde redirecionar depois do pagamento. |
| `reference` | string | opcional | Rótulo livre seu. |
| `external_ref` | string | opcional | Seu identificador devolvido em "external_ref". |
| `metadata` | object | opcional | Pares chave/valor livres. |

_curl_

```bash
curl -X POST https://stacepay.com.br/api/v1/checkouts \
  -H "Authorization: Bearer nvx_live_..." \
  -H "Content-Type: application/json" \
  -d '{"title": "Consultoria avulsa", "amount": 15000, "allow_pix": true}'
```

_json_

```json
{
  "object": "checkout",
  "id": "8049659bf4e02f366911",
  "external_ref": null,
  "status": "open",
  "url": "https://stacepay.com.br/pagar/8049659bf4e02f366911",
  "amount": 15000,
  "currency": "BRL",
  "title": "Consultoria avulsa",
  "description": null,
  "reference": null,
  "payment_methods": ["pix"],
  "single_use": true,
  "return_url": null,
  "expires_at": null,
  "paid_at": null,
  "created_at": "2026-08-11T22:03:12-03:00",
  "metadata": {},
  "charge": null
}
```

`id` é o token do link o mesmo que aparece na `url`. Abra a `url` diretamente para ver a página de pagamento.

## Listar

`GET /checkouts?limit=20&offset=0`

## Buscar um

`GET /checkouts/{id}`

## Encerrar

`POST /checkouts/{id}/expire`

Impede novos pagamentos por esse link sem excluí-lo quem já pagou continua com o recibo válido.