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": "[email protected]",
    "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": "<unknown>"
}

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": "[email protected]",
    "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": "<unknown>"
}

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 string 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.

Show child attributes

customer.name

string

required

Nome completo do seu cliente

Example:

"Daniel Lima"

customer.cellphone

string

required

Celular do cliente

Example:

"(11) 4002-8922"

customer.email

string

required

E-mail do cliente

Example:

"[email protected]"

customer.taxId

string

required

CPF ou CNPJ do cliente.

Example:

"123.456.789-01"

metadata

object

Metadados opcionais para a cobrança

Response

QRCode Pix criado com sucesso

data

object

Show child attributes

data.id

string

Identificador único do QRCode Pix.

Example:

"pix_char_123456"

data.amount

number

Valor a ser pago.

Example:

100

data.status

enum<string>

Informação sobre o andamento do QRCode Pix.

Available options:

PENDING,

EXPIRED,

CANCELLED,

PAID,

REFUNDED

Example:

"PENDING"

data.devMode

boolean

Ambiente no qual o QRCode Pix foi criado.

Example:

true

data.brCode

string

Código copia-e-cola do QRCode Pix.

Example:

"00020101021226950014br.gov.bcb.pix"

data.brCodeBase64

string

Imagem em Base64 do QRCode Pix.

Example:

"data:image/png;base64,iVBORw0KGgoAAA"

data.platformFee

number

Taxas da plataforma

Example:

80

data.createdAt

string

Data de criação do QRCode Pix.

Example:

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

data.updatedAt

string

Data de atualização do QRCode Pix.

Example:

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

data.expiresAt

string

Data de expiração do QRCode Pix

Example:

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

error

null

Referência Simular Pagamento

⌘I

Introdução

Cliente

Cobrança

Pix QRCode

Cupom

Saque

Loja

Trust MRR

Criar QRCode PIX

Authorizations

Body

Response