POST
/
pixQrCode
/
create
Criar QRCode PIX
curl --request POST \
  --url https://api.abacatepay.com/v1/pixQrCode/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "expiresIn": 123,
  "description": "<string>",
  "customer": {
    "name": "Daniel Lima",
    "cellphone": "(11) 4002-8922",
    "email": "daniel_lima@abacatepay.com",
    "taxId": "123.456.789-01"
  },
  "metadata": {
    "externalId": "123"
  }
}'
{
  "data": {
    "id": "pix_char_123456",
    "amount": 100,
    "status": "PENDING",
    "devMode": true,
    "brCode": "00020101021226950014br.gov.bcb.pix",
    "brCodeBase64": "data:image/png;base64,iVBORw0KGgoAAA",
    "platformFee": 80,
    "createdAt": "2025-03-24T21:50:20.772Z",
    "updatedAt": "2025-03-24T21:50:20.772Z",
    "expiresAt": "2025-03-25T21:50:20.772Z"
  },
  "error": null
}

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <abacatepay-api-key> onde <abacatepay-api-key> é a sua chave de API.

Body

application/json
amount
number
required

Valor da cobrança em centavos.

expiresIn
number

Tempo de expiração da cobrança em segundos.

description
string

Mensagem que aparecerá na hora do pagamento do PIX.

Maximum length: 140
customer
object

Os dados do seu cliente para criá-lo. O objeto de customer não é obrigatório, mas ao informar qualquer informação do customer todos os campos name, cellphone, email e taxId são obrigatórios.

metadata
object

Metadados opcionais para a cobrança

Response

QRCode Pix criado com sucesso

data
object
error
null