Skip to main content

Cobrança PIX Imediata (Dinâmica)

Este endpoint permite gerar uma cobrança PIX imediata, também conhecida como cobrança dinâmica, retornando um QR Code e um payload EMV para o pagador realizar o pagamento instantaneamente. Diferente da cobrança estática, ela é única, tem tempo de expiração e valor fixo definido pelo recebedor.

Endpoint​

POST https://api.intrapay.io/api/financial/v1/pix-cash-in/immediate

Exemplo JSON de Request​

{
  "pixKeyId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 150.5,
  "additionalInformation": [
    {
      "name": "Serviço",
      "value": "Limpeza de piscina"
    }
  ],
  "debtor": {
    "name": "João da Silva",
    "taxId": "12345678900"
  },
  "payerQuestion": "Qual o número do seu pedido?",
  "expiration": {
    "value": 60,
    "unit": "minutes"
  }
}

Parâmetros​

  • pixKeyId: (Obrigatório) ID da chave PIX cadastrada que será usada para gerar a cobrança.
  • amount: (Obrigatório) Valor monetário da cobrança (mínimo R$ 5,00).
  • additionalInformation: (Opcional) Lista de informações extras exibidas ao pagador.
    • name: Nome da informação.
    • value: Valor ou descrição.
  • debtor: (Opcional) Dados do pagador, se houver.
    • name: Nome completo do pagador.
    • taxId: CPF ou CNPJ do pagador.
  • payerQuestion: (Opcional) Mensagem exibida ao pagador como pergunta.
  • expiration: (Opcional) Define o tempo de expiração da cobrança.
    • value: Quantidade numérica do tempo (ex.: 60).
    • unit: Unidade de tempo (minutes, hours, days).

Exemplo JSON de Resposta​

{
  "id": "5c46d8af-91de-4a3f-9d5a-87e51b46c11e",
  "amount": 150.5,
  "status": "PENDING",
  "pixKey": "[email protected]",
  "pixKeyId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "IMMEDIATE_QRCODE",
  "emvqrcps": "00020126360014BR.GOV.BCB.PIX0115jhondoe@intrapay.io5204000053039865406150.505802BR5910JHONDOE6009AUCKLAND62070503***6304A13B",
  "transactionId": 87453,
  "transactionIdentification": "E87453H20251024002",
  "description": "Pagamento de serviços.",
  "createdAt": "2025-10-24T14:10:00.000Z",
  "expiresAt": "2025-10-24T15:10:00.000Z",
  "qrCodeDataUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAYAAAC0..."
}

Campos de Retorno​

  • id: Identificador único da cobrança.
  • amount: Valor da cobrança.
  • status: Status atual da cobrança (ex.: PENDING, COMPLETED, EXPIRED).
  • pixKey: Chave PIX usada na geração.
  • pixKeyId: ID da chave PIX.
  • type: Tipo da cobrança (IMMEDIATE_QRCODE).
  • emvqrcps: Código EMV (QR Code) gerado para o pagamento.
  • transactionId: ID interno da transação associada.
  • transactionIdentification: Identificador único da cobrança no sistema.
  • description: Descrição adicional (se informada).
  • createdAt: Data de criação da cobrança.
  • expiresAt: Data e hora de expiração da cobrança.
  • qrCodeDataUrl: Imagem do QR Code em formato Data URL (base64) para facilitar a exibição.

Tabela de Erros​

CódigoErro
400Requisição inválida
401Token inválido ou expirado
403IP não autorizado
404Chave PIX não encontrada
422Valor da cobrança inválido
500Erro interno do servidor

Observações​

  • O valor mínimo permitido é de R$ 5,00.
  • O campo payerQuestion aceita no máximo 140 caracteres.
  • O campo additionalInformation deve conter um array de objetos com name e value.
  • Uma cobrança imediata expirada não pode ser reutilizada.