Cobrança PIX Estática
Este endpoint permite gerar uma cobrança PIX estática, retornando um QR Code EMV e um código de transação que podem ser utilizados para receber pagamentos via PIX.
Endpoint
POST https://api.intrapay.io/api/financial/v1/pix-cash-in/static
Exemplo JSON de Request
{
"pixKeyId": "123e4567-e89b-12d3-a456-426614174000",
"amount": 150.5,
"additionalInformation": "Pagamento de serviços."
}
Parâmetros
- pixKeyId: (Obrigatório) ID da chave PIX cadastrada que será utilizada para gerar a cobrança.
- amount: (Opcional) Valor da cobrança estática. Se não informado, o pagador poderá definir o valor no momento do pagamento.
- additionalInformation: (Opcional) Mensagem adicional exibida ao pagador, como uma descrição ou referência do pagamento.
Exemplo JSON de Resposta
{
"id": "d9c8f73c-1e2b-47a0-99e4-58a1a928b512",
"amount": 150.5,
"status": "PENDING",
"pixKey": "[email protected]",
"pixKeyId": "123e4567-e89b-12d3-a456-426614174000",
"type": "STATIC",
"emvqrcps": "00020126360014BR.GOV.BCB.PIX0115jhondoe@intrapay.io5204000053039865406150.505802BR5910JHONDOE6009AUCKLAND62070503***6304A13B",
"transactionId": 87452,
"transactionIdentification": "E87452H20251024001",
"description": "Pagamento de serviços.",
"createdAt": "2025-10-24T13:00: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,CONFIRMED,CANCELED). - pixKey: Chave PIX utilizada para receber o pagamento.
- pixKeyId: ID da chave PIX no sistema.
- type: Tipo da cobrança (
STATIC_QRCODE). - emvqrcps: Código EMV (QR Code) gerado para pagamento.
- transactionId: ID interno da transação associada.
- transactionIdentification: Identificação única no sistema do PSP.
- description: Descrição adicional da cobrança, se informada.
- createdAt: Data e hora de criação da cobrança.
- qrCodeDataUrl: Imagem do QR Code em formato Data URL (base64) para facilitar a exibição.
Tabela de Erros
| Código | Erro |
|---|---|
| 400 | Requisição inválida |
| 401 | Token inválido ou expirado |
| 403 | IP não autorizado |
| 404 | Chave PIX não encontrada |
| 422 | Valor da cobrança inválido |
| 500 | Erro interno do servidor |