Skip to main content
POST
/
charge
/
pix
Criar cobrança PIX avulsa
curl --request POST \
  --url https://api.clickpay.app.br/charge/pix \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "amount": 10000,
  "customer": {
    "taxId": "12345678901",
    "name": "João Silva",
    "email": "joao@example.com",
    "phone": "11999999999",
    "postalCode": "01234000",
    "address": "Rua ABC",
    "district": "Centro",
    "number": "123",
    "line1": "Apto 101"
  },
  "expiresIn": 3600,
  "externalId": "ext_charge_123",
  "devMode": false
}
'
{
  "id": "charge_123456",
  "status": "PROCESSING",
  "amount": 10000,
  "brCode": "00020101021226950014br.gov.bcb.pix...",
  "brCodeBase64": "data:image/png;base64,iVBORw0KGgoAAA...",
  "url": "https://pay.clickpay.app.br/c/charge_123456",
  "createdAt": "2025-03-24T21:50:20.772Z",
  "expiresAt": "2025-03-25T21:50:20.772Z",
  "externalId": "ext_charge_123",
  "devMode": false
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
Idempotency-Key
string

Chave de Idempotência.

Body

application/json
​
amount
number
required

Valor em centavos. Mínimo: R$ 5,00 (500 centavos)

Example:

10000

​
customer
object
required

Dados do cliente

​
expiresIn
number

Tempo de expiração em segundos (padrão: 1800 - 30 minutos)

Example:

3600

​
externalId
string

ID externo para idempotência

Example:

"ext_charge_123"

​
devMode
boolean

Modo de desenvolvimento

Example:

false

Response

Cobrança PIX criada com sucesso

​
id
string
required

ID da charge

Example:

"charge_123456"

​
status
string
required

Status do pagamento

Example:

"PROCESSING"

​
amount
number
required

Valor em centavos

Example:

10000

​
brCode
string
required

Código QR PIX

Example:

"00020101021226950014br.gov.bcb.pix..."

​
brCodeBase64
string
required

QR Code em base64

Example:

"data:image/png;base64,iVBORw0KGgoAAA..."

​
url
string
required

URL do link de pagamento

Example:

"https://pay.clickpay.app.br/c/charge_123456"

​
createdAt
string<date-time>
required

Data de criação

Example:

"2025-03-24T21:50:20.772Z"

​
expiresAt
string<date-time>
required

Data de expiração

Example:

"2025-03-25T21:50:20.772Z"

​
externalId
string

ID externo

Example:

"ext_charge_123"

​
devMode
boolean

Modo de desenvolvimento

Example:

false