https://api.goatpay.com.br/v1/payment-links/*
Links permitem que seu site ou app crie cobranças pela API, redirecione o cliente para pay.goatpay.com.br ou use checkout direto de cartão (Stripe Connect).
Rotas
| Método | Rota | Permissão |
|---|---|---|
| POST | /v1/payment-links/create | payment-links/create |
| GET | /v1/payment-links/get/:id | payment-links/get |
| GET | /v1/payment-links/list | payment-links/list |
| PATCH | /v1/payment-links/update/:id | payment-links/update |
| PATCH | /v1/payment-links/status/:id | payment-links/update |
| DELETE | /v1/payment-links/delete/:id | payment-links/delete |
| POST | /v1/payment-links/checkout | payment-links/checkout |
| GET | /v1/payment-links/sessions/get/:sessionId | payment-links/sessions/get |
Pré-requisitos
| Método | Requisito |
|---|---|
| PIX / boleto / cripto | Conta verificada; métodos no trilho PADRÃO da API key. |
Cartão (CARD) | PJ com Stripe Connect (charges_enabled + payouts_enabled). Onboarding. |
Fluxo recomendado
1. Criar o link
POST /v1/payment-links/create com
allowedMethods, valor fixo (fixedAmount) ou aberto.2. Iniciar checkout
POST /v1/payment-links/checkout com
linkId, method e dados do pagador.3. Pagar
Cartão: redirecione para
Outros: use
stripeCheckoutUrl.Outros: use
payCheckoutUrl ou a página payPageUrl do link.4. Confirmar
Idempotência
EnvieIdempotency-Key em POST /v1/payment-links/checkout para evitar cobranças duplicadas em retentativas.
Referência externa
externalReference no checkout correlaciona com seu pedido. Aparece na transação e no webhook payment_link.paid.
Cartão avulso (sem link)
Cobrança direta Stripe viaPOST /v1/card/checkout.
Visão geral: Loja.