Cobrança PIX com Vencimento (Dinâmica)

Este endpoint permite gerar uma cobrança PIX com data de vencimento, também conhecida como cobrança dinâmica com vencimento. É ideal para configurar descontos, abatimentos, juros e multas.

---

Endpoint

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

---

Exemplo JSON de Request

{
  "pixKeyId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 150.75,
  "duedate": "2025-12-31",
  "expirationAfterPayment": 5,
  "debtor": {
    "name": "João da Silva",
    "cpf": "12345678910",
    "city": "São Paulo",
    "publicArea": "Avenida Paulista, 1000",
    "state": "SP",
    "postalCode": "01310-000",
    "email": "[email protected]"
  },
  "payerQuestion": "Cobrança referente ao pagamento de serviços.",
  "amountDiscount": {
    "modality": "PERCENTAGE_DATE_REPORTED",
    "discountDateFixed": [
      { "date": "2025-12-25", "amountPerc": 5.0 },
      { "date": "2025-12-28", "amountPerc": 2.5 }
    ]
  },
  "amountAbatement": {
    "modality": "FIXED_VALUE",
    "amountPerc": 4.5
  },
  "amountFine": {
    "modality": "FIXED_VALUE",
    "amountPerc": 2.0
  },
  "amountInterest": {
    "modality": "PERCENTAGE_PER_MONTH_WORKING_DAYS",
    "amountPerc": 5.25
  },
  "additionalInformation": [
    {
      "name": "Serviço",
      "value": "Consultoria agrícola"
    }
  ]
}

---

Parâmetros

Campo	Tipo	Obrigatório	Descrição
pixKeyId	string (UUID)	✅	ID da chave PIX cadastrada.
amount	number	✅	Valor da cobrança (mínimo R$ 5,00).
duedate	string (YYYY-MM-DD)	✅	Data de vencimento da cobrança.
expirationAfterPayment	number	❌	Dias para expiração após o vencimento
debtor	object	✅	Dados do devedor.
payerQuestion	string	❌	Mensagem ao pagador (máx. 140 caracteres).
amountDiscount	object	❌	Descontos aplicados antes do vencimento.
amountAbatement	object	❌	Valor fixo ou percentual de abatimento.
amountFine	object	❌	Multa aplicada após o vencimento.
amountInterest	object	❌	Juros aplicados após o vencimento.
additionalInformation	array	❌	Informações adicionais para exibição ao pagador.

---

Exemplo JSON de Resposta

{
  "id": "5c46d8af-91de-4a3f-9d5a-87e51b46c11e",
  "amount": 150.75,
  "status": "PENDING",
  "pixKey": "[email protected]",
  "pixKeyId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "DUEDATE_QRCODE",
  "emvqrcps": "00020126360014BR.GOV.BCB.PIX0115jhondoe@intrapay.io5204000053039865406150.755802BR5910AUCKLAND6009VITORIA62070503***6304B28C",
  "transactionId": 87454,
  "transactionIdentification": "E87454H20251024003",
  "description": "Cobrança com vencimento.",
  "createdAt": "2025-10-24T14:15:00.000Z",
  "dueDate": "2025-12-31",
  "expiresAt": "2026-01-05T00: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 (PENDING, CONFIRMED, EXPIRED).
• pixKey: Chave PIX utilizada.
• pixKeyId: ID da chave cadastrada.
• type: Tipo de cobrança (DUE_DATE).
• emvqrcps: Código EMV (QR Code) gerado para pagamento.
• transactionId: Identificador interno da transação.
• transactionIdentification: Identificação única da cobrança.
• description: Descrição informada.
• createdAt: Data de criação.
• dueDate: Data de vencimento.
• expiresAt: Data de expiração após o vencimento.
• qrCodeDataUrl: Imagem do QR Code em formato Data URL (base64) para facilitar a exibição.

---

tip

A cobrança com vencimento pode conter multas e juros após a data de vencimento, além de abatimentos ou descontos aplicáveis antes do vencimento.

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	Dados de cobrança inválidos
500	Erro interno do servidor

---

Observações

• O valor mínimo permitido é de R$ 5,00.
• O campo payerQuestion aceita no máximo 140 caracteres.
• A data de vencimento deve ser hoje ou futura.
• Após o vencimento, a cobrança pode aplicar juros e multa automaticamente.
• Após o prazo definido em expirationAfterPayment, a cobrança expira automaticamente e não pode mais ser paga.