Skip to main content
POST
/
links
curl --request POST \
  --url https://api.pagozz.com/v1/links \
  --header 'Content-Type: application/json' \
  --header 'Pagozz-Token: <api-key>' \
  --data '
{
  "name": "Consultoria 1h",
  "description": "Sessão de consultoria individual",
  "value_mode": "fixed",
  "amount": 15000,
  "payment_methods": [
    "pix"
  ]
}
'
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Consultoria 1h",
    "description": "Sessão de consultoria individual",
    "value_mode": "fixed",
    "amount": 15000,
    "min_amount": null,
    "currency": "BRL",
    "status": "active",
    "payment_methods": [
      "pix"
    ],
    "environment": "test",
    "created_at": "2026-02-27T14:00:00Z",
    "updated_at": "2026-02-27T14:00:00Z"
  }
}

Authorizations

​
Pagozz-Token
string
header
required

Chave de API no formato pgz_test_* (test mode) ou pgz_live_* (live mode). O ambiente é determinado automaticamente pelo prefixo da chave.

Body

application/json
​
name
string
required

Obrigatório. Nome do link de pagamento.

Required string length: 1 - 100
​
description
string | null

Opcional. Descrição exibida no checkout.

Maximum string length: 500
​
value_mode
enum<string>
default:fixed

Opcional. Modo de valor. Padrão: fixed.

Available options:
fixed,
free,
minimum
​
amount
integer

Valor em centavos. Obrigatório quando value_mode é fixed.

Required range: x >= 100
​
min_amount
integer

Valor mínimo em centavos. Obrigatório quando value_mode é minimum.

Required range: x >= 100
​
payment_methods
enum<string>[]

Opcional. Métodos aceitos. Padrão: ["pix"].

Minimum array length: 1
Available options:
pix,
credit_card
​
expires_in
integer
default:900

Opcional. Tempo de expiração do pagamento em segundos (60 a 86400). Padrão: 900 (15 min).

Required range: 60 <= x <= 86400
​
due_date
string | null

Opcional. Data de vencimento no formato YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
​
checkout_field_full_name
enum<string>
default:optional

Opcional. Campo nome completo no checkout. Padrão: optional.

Available options:
disabled,
optional,
required
​
checkout_field_cpf
enum<string>
default:disabled

Opcional. Campo CPF no checkout. Padrão: disabled.

Available options:
disabled,
optional,
required
​
checkout_field_cnpj
enum<string>
default:disabled

Opcional. Campo CNPJ no checkout. Padrão: disabled.

Available options:
disabled,
optional,
required
​
checkout_field_company_name
enum<string>
default:disabled

Opcional. Campo razão social no checkout. Padrão: disabled.

Available options:
disabled,
optional,
required
​
checkout_field_phone
enum<string>
default:optional

Opcional. Campo telefone no checkout. Padrão: optional.

Available options:
disabled,
optional,
required
​
checkout_field_address
enum<string>
default:disabled

Opcional. Campo endereço no checkout. Padrão: disabled.

Available options:
disabled,
optional,
required
​
success_redirect_url
string<uri> | null

Opcional. URL HTTPS para redirecionar o pagador após o pagamento.

​
callback_url
string<uri> | null

Opcional. URL HTTPS para receber notificações de eventos do pagamento (webhook).

​
success_message
string | null

Opcional. Mensagem exibida ao pagador após o pagamento.

Maximum string length: 500

Response

Link criado com sucesso.

​
data
object

Representa um link de pagamento.