Financeiro › Faturas

Gravar código PIX da fatura

Grava na fatura o código PIX (payload EMV "copia e cola") gerado pelo banco para o boleto, permitindo que a tela pública de pagamento, o PDF, o e-mail e o WhatsApp ofereçam o pagamento por PIX em boleto de qualquer banco, e não apenas no ApBank.

O código é validado antes de ser gravado: estrutura EMV do arranjo PIX, chave estática ou URL de cobrança dinâmica, campos obrigatórios do BR Code (moeda, país, recebedor e cidade) e dígito verificador CRC16. O payload não pode passar de 512 caracteres, e o dígito verificador é gravado em maiúsculo, como manda a especificação do BR Code. Payload recusado não grava nada.

A fatura precisa ter um método de cobrança vinculado: em cobrança manual não há boleto em canal nenhum, e o código nunca chegaria ao pagador. Fatura paga, cancelada, renegociada, reembolsada ou incobrável também não recebe código.

A origem fica registrada no histórico da fatura, e alterar o valor ou o vencimento da fatura descarta o código.

<aside>🔒 Requer a permissão <b>FINANCEIRO_LANCAMENTO_EDITAR</b></aside>
post/invoices/{invoice_id}/pixCode

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/invoices/{invoice_id}/pixCode
  • Auth: HTTP bearer

Request body

pixCodestring required

Payload EMV do PIX (copia e cola) da fatura.

Example request

{
  "pixCode": "00020101021226590014br.gov.bcb.pix2537qrcodepix.banco.com.br/qr/v2/9f1a2b3c52040000530398654071234.565802BR5913IMOBILIARIA X6009SAO PAULO62070503***63040606"
}

Changes

No recorded changes to this operation across all 1 revision of this API.