# Visão Geral da Payment Link API

A Payment Link API permite que estabelecimentos (sellers) criem URLs de pagamento compartilháveis que os compradores (shoppers) podem usar para finalizar uma compra. Em vez de integrar um checkout completo, o seller cria um link, define o que está sendo vendido e como pode ser pago, e compartilha a URL resultante.

## O que um link pode conter

Cada link está vinculado a um catálogo de produtos e a uma configuração de pagamento. Os métodos de pagamento são configuráveis e incluem crédito e débito (disponíveis em todos os países suportados), além de boleto, Pix, Google Pay e Apple Pay (no Brasil). Quais métodos estão disponíveis depende do país do seller — ver [Métodos de pagamento suportados](/pt/payment-link-api/first-step-plk/suported-payments-methods-plk).

## Conceitos principais

* **Payment Link** — a URL compartilhável vinculada a um catálogo de produtos e a uma configuração de pagamento.
* **Custom Link** (`type: custom`) — link com produtos predefinidos e valores fixos. Exige a lista de `products`. É o tipo padrão.
* **Unique Link** (`type: unique`) — link em que o shopper define o valor do pagamento. Neste tipo, `products` e `shipping_amount` não são permitidos.
* **Order (ordem)** — a transação de pagamento criada quando um shopper paga através do link. Uma ordem tem seu próprio ciclo de status (`pending`, `paid`, `approved`, `refunded`, `denied`) e mantém um histórico de transições.
* **Short ID** — identificador compacto e público que aparece na URL do link. É por ele que o frontend de checkout do shopper recupera o link, via endpoint público.
* **Seller** — o estabelecimento que cria e gerencia os links. Sua identidade e configurações são derivadas do token de autenticação.

## Como a API se organiza

A API agrupa suas operações em alguns conjuntos:

- **Payment Links** — criar, listar, consultar, atualizar (PUT/PATCH) e buscar por short ID.
- **Orders e Receipts** — listar e consultar ordens de um link e obter o recibo de uma ordem (apenas leitura).
- **Business Configurations** — salvar e consultar uma configuração base reutilizável (métodos padrão, expiração, moeda) para acelerar a criação de novos links.
- **Sellers** — consultar o perfil do seller, com serviços habilitados e métodos de pagamento.
- **Images** — fazer upload de imagens de produto e recuperá-las pelo identificador.

## Autenticação

O acesso usa OAuth 2.0 Client Credentials. O seller troca `client_id` e `client_secret` por um token, que é enviado no header `Authorization` das requisições. As informações de seller, país e tenant vêm do próprio token, não de headers separados. A única exceção de acesso é a busca de um link pelo short ID, que é pública. Ver [Authentication](/pt/payment-link-api/first-step-plk/authentication-token-plk).

## Próximos passos

- [Como criar um payment link](/pt/payment-link-api/payment-guides-plk/howto-create-payment-link-plk)
- [Configure o payment link](/pt/payment-link-api/first-step-plk/configure-link-plk)