Pular para o conteúdo principal
POST
/
charges
Criar uma cobrança (link de pagamento)
curl --request POST \
  --url https://api.pague.dev/v1/charges \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Produto Premium",
  "paymentMethods": [
    "pix"
  ],
  "description": "Pagamento referente ao produto premium",
  "amount": 99.9,
  "expiresAt": "2024-12-31T23:59:59Z",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Produto Premium",
  "currency": "BRL",
  "status": "active",
  "slug": "produto-premium-2024",
  "url": "https://pay.pague.dev/produto-premium-2024",
  "paymentMethods": [
    "pix",
    "credit_card"
  ],
  "maxInstallments": 6,
  "notifications": [
    "email"
  ],
  "allowCoupons": true,
  "paymentsCount": 5,
  "totalCollected": 495,
  "createdAt": "2023-11-07T05:31:56Z",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": {},
  "amount": 99.9,
  "expiresAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Cabeçalhos

​
X-API-Key
string
obrigatório

Chave de API de integração (pd_live_* para produção, pd_test_* para sandbox)

Corpo

application/json
​
projectId
string<uuid>
obrigatório

ID do projeto para associar a cobrança

​
name
string
obrigatório

Nome/título da cobrança

Maximum string length: 255
Exemplo:

"Produto Premium"

​
paymentMethods
enum<string>[]
obrigatório

Métodos de pagamento aceitos

Opções disponíveis:
pix
Exemplo:
["pix"]
​
description
string

Descrição da cobrança

Exemplo:

"Pagamento referente ao produto premium"

​
amount
number

Valor em BRL (null para valor aberto/customizado). Exemplo: 99.90 para R$ 99,90

Intervalo obrigatório: x >= 1
Exemplo:

99.9

​
expiresAt
string<date-time>

Data de expiração (formato ISO 8601)

Exemplo:

"2024-12-31T23:59:59Z"

​
customerId
string<uuid>

ID do cliente para pré-associar esta cobrança

Resposta

Cobrança criada com sucesso

​
id
string<uuid>
obrigatório

ID da cobrança

​
projectId
string<uuid>
obrigatório

ID do projeto

​
name
string
obrigatório

Nome da cobrança

Exemplo:

"Produto Premium"

​
currency
string
obrigatório

Código da moeda

Exemplo:

"BRL"

​
status
enum<string>
obrigatório

Status da cobrança

Opções disponíveis:
active,
expired,
disabled,
paid
​
slug
string
obrigatório

Slug da URL

Exemplo:

"produto-premium-2024"

​
url
string
obrigatório

URL completa do link de pagamento

Exemplo:

"https://pay.pague.dev/produto-premium-2024"

​
paymentMethods
string[]
obrigatório

Métodos de pagamento aceitos

Exemplo:
["pix", "credit_card"]
​
maxInstallments
integer
obrigatório

Número máximo de parcelas para cartão de crédito

Exemplo:

6

​
notifications
string[]
obrigatório

Canais de notificação

Exemplo:
["email"]
​
allowCoupons
boolean
obrigatório

Permitir cupons de desconto

​
paymentsCount
integer
obrigatório

Número de pagamentos recebidos

Exemplo:

5

​
totalCollected
number
obrigatório

Valor total arrecadado em BRL

Exemplo:

495

​
createdAt
string<date-time>
obrigatório

Data de criação

​
customerId
string<uuid>

ID do cliente (se pré-atribuído)

​
description
object

Descrição da cobrança

​
amount
number

Valor em BRL (null para valor aberto). Exemplo: 99.90 para R$ 99,90

Exemplo:

99.9

​
expiresAt
string<date-time>

Data de expiração

​
updatedAt
string<date-time>

Data de atualização