Pular para o conteúdo principal
POST
/
pix
Criar uma cobrança PIX
curl --request POST \
  --url https://api.pague.dev/v1/pix \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "amount": 150.75,
  "description": "Pagamento do pedido #12345",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "name": "João da Silva",
    "document": "12345678909",
    "email": "[email protected]",
    "phone": "+5511999998888"
  },
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expiresIn": 3600,
  "externalReference": "pedido-12345",
  "metadata": {
    "orderId": "12345",
    "source": "website"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "amount": 150.75,
  "currency": "BRL",
  "pixCopyPaste": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "expiresAt": "2023-11-07T05:31:56Z",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "externalReference": "pedido-12345"
}

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
​
amount
number
obrigatório

Valor em BRL (ex: 100.50 para R$ 100,50)

Intervalo obrigatório: x >= 1
Exemplo:

150.75

​
description
string
obrigatório

Descrição da cobrança

Maximum string length: 255
Exemplo:

"Pagamento do pedido #12345"

​
customerId
string<uuid>

ID de um cliente existente. Informe customerId ou customer, não ambos.

​
customer
object

Informações do cliente. Informe customerId ou customer, não ambos.

​
projectId
string<uuid>

ID do projeto para associar a transação

​
expiresIn
integer

Segundos até expiração (padrão: 86400 = 24h)

Intervalo obrigatório: 300 <= x <= 604800
Exemplo:

3600

​
externalReference
string

Seu ID de referência externa

Maximum string length: 255
Exemplo:

"pedido-12345"

​
metadata
object

Metadados customizados (pares chave-valor)

Exemplo:
{ "orderId": "12345", "source": "website" }

Resposta

Cobrança PIX criada com sucesso

​
id
string<uuid>
obrigatório

ID da cobrança (ID da transação)

​
status
enum<string>
obrigatório

Status da cobrança

Opções disponíveis:
pending,
completed,
failed,
cancelled
​
amount
number
obrigatório

Valor em BRL

Exemplo:

150.75

​
currency
string
obrigatório

Código da moeda

Exemplo:

"BRL"

​
pixCopyPaste
string
obrigatório

Código PIX copia e cola

Exemplo:

"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
expiresAt
string<date-time>
obrigatório

Data de expiração

​
customerId
string<uuid>
obrigatório

ID do cliente

​
createdAt
string<date-time>
obrigatório

Data de criação

​
externalReference
string

Seu ID de referência externa

Exemplo:

"pedido-12345"