Skip to main content
curl -X POST 'https://api.pagou.ai/pix/v1/payment' \
  -H 'Content-Type: application/json' \
  -H 'apiKey: sk_live_1234' \
  -d '{
    "type": "PIX",
    "transaction": {
      "value": 123.45,
      "description": "Pagamento de serviço",
      "expirationTime": 3600,
      "externalId": "pedido-001"
    },
    "payer": {
      "fullName": "João da Silva",
      "document": "12345678909",
      "contact": {
        "phone": "+5511999999999",
        "mail": "joao@email.com"
      },
      "address": {
        "zipCode": "01001-000",
        "street": "Av. Paulista",
        "neighboor": "Bela Vista",
        "number": "1000",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR"
      }
    }
  }'
{
  "transactionId": "3713c2e7-9145-45ab-a9e7-75035c7abc34",
  "status": "WAITING_PAYMENT",
  "pixQrCode": "iVBORw0KGgoAAAANSUhEUgAABbQAAAW0CAYAAAAeooXXAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAIABJREFUeJzs2kGu5DqSRNFmI/a/ZfbwVw7+Q2XLM2UWfs4CBKdIKQIXOvfe+z8AAAAAABDuf98eAAAAAAAA...",
  "pixCode": "00020101021226880014br.gov.bcb.pix2566qrcode-h.pagou.ai/QR/cob/EEA7B851BBAFFB546073CE80810F56AA0F95204000053039865802BR5925RECEBEDOR NOME6009Sao Paulo610905726-10062070503***630498E0",
  "generateTime": "2024-04-14T02:58:04.997Z",
  "expirationDate": "2024-04-15T02:58:04.997Z",
  "paymentLink": null
}
Use este endpoint para criar uma cobrança PIX na API Pagou.ai.
Este endpoint está disponível apenas em produção.

Endpoint

POST https://api.pagou.ai/pix/v1/payment

Parâmetros da requisição

Headers

Content-Type
string
required
Sempre envie como application/json.
apiKey
string
required
Sua chave de API. Exemplo: sk_live_1234

Body

type
string
required
Por padrão, envie PIX.
transaction.value
number
required
Valor da transação. Aceita valores decimais usando ponto, como 123.45 (R$123,45).
transaction.description
string
Descrição da cobrança.
transaction.expirationTime
number
Tempo de vida da cobrança em segundos. Padrão: 86400 (24 horas).
transaction.dueDate
string
Data de vencimento no formato YYYY-MM-DD (opcional).
transaction.externalId
string
Identificador único para rastreio e Webhook.
Identificadores repetidos impedem a geração do QR Code.
payer.fullName
string
required
Nome do cliente/pagador.
payer.document
string
required
CPF ou CNPJ do cliente/pagador.
payer.contact.phone
string
Telefone do cliente/pagador.
payer.contact.mail
string
E-mail do cliente/pagador.
payer.address
object
Endereço do cliente/pagador.
Sempre valide os dados enviados e trate possíveis erros de resposta para garantir a melhor experiência ao usuário.
curl -X POST 'https://api.pagou.ai/pix/v1/payment' \
  -H 'Content-Type: application/json' \
  -H 'apiKey: sk_live_1234' \
  -d '{
    "type": "PIX",
    "transaction": {
      "value": 123.45,
      "description": "Pagamento de serviço",
      "expirationTime": 3600,
      "externalId": "pedido-001"
    },
    "payer": {
      "fullName": "João da Silva",
      "document": "12345678909",
      "contact": {
        "phone": "+5511999999999",
        "mail": "joao@email.com"
      },
      "address": {
        "zipCode": "01001-000",
        "street": "Av. Paulista",
        "neighboor": "Bela Vista",
        "number": "1000",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR"
      }
    }
  }'
Adapte os valores conforme sua necessidade. Não use dados reais em ambiente de testes.

Exemplo de corpo completo da requisição

{
  "type": "PIX",
  "payer": {
    "fullName": "John Marvin",
    "document": "12312312387",
    "contact": {
      "phone": "+5537988996655",
      "mail": "your@email.com"
    },
    "address": {
      "zipCode": "60000000",
      "street": "Street Name",
      "neighboor": "Neighboor Name",
      "number": "123",
      "city": "City Name",
      "state": "State Name",
      "country": "Country Name"
    }
  },
  "transaction": {
    "value": 100,
    "description": "Description",
    "dueDate": "2025-07-07",
    "externalId": "c41a609e-9fad-4341-98e2-67259ba27d05"
  }
}

Respostas da API

{
  "transactionId": "3713c2e7-9145-45ab-a9e7-75035c7abc34",
  "status": "WAITING_PAYMENT",
  "pixQrCode": "iVBORw0KGgoAAAANSUhEUgAABbQAAAW0CAYAAAAeooXXAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAIABJREFUeJzs2kGu5DqSRNFmI/a/ZfbwVw7+Q2XLM2UWfs4CBKdIKQIXOvfe+z8AAAAAABDuf98eAAAAAAAA...",
  "pixCode": "00020101021226880014br.gov.bcb.pix2566qrcode-h.pagou.ai/QR/cob/EEA7B851BBAFFB546073CE80810F56AA0F95204000053039865802BR5925RECEBEDOR NOME6009Sao Paulo610905726-10062070503***630498E0",
  "generateTime": "2024-04-14T02:58:04.997Z",
  "expirationDate": "2024-04-15T02:58:04.997Z",
  "paymentLink": null
}
transactionId
string
required
Identificador único gerado para cobrança/transação.
status
string
required
Status da cobrança/transação.
pixQrCode
string
required
Imagem QRCode codificado em Base64 (data:image/png;base64)
pixCode
string
required
Código PIX Copia e Cola
generateTime
string
Data/momento da geração do pagamento
expirationDate
string | null
Data/momento da expiração do pagamento
URL para link de pagamento
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Forbidden resource"
}
statusCode
integer
Código HTTP retornado.
error
string
Mensagem de erro descritiva.
message
string
Detalhe do erro.
Se você receber um transactionId e um status, o pagamento foi criado com sucesso.
I