Leia o código SwissQR
Código de barras → Leia o código SwissQR
O Leia o código SwissQR API extratos suíços QR-dados de fatura de um PDFVocê envia o PDF como Base64 (docContent), docNamee opcionalmente IsAsync. O API retornos JSON com dados de pagamento estruturados: valor, moeda, IBAN, nome do credor, referência do pagamento, data de vencimento, finalidade e campos relacionados. Use o testador abaixo para experimentar; mais detalhes estão nas seções a seguir.
Experimente a opção Ler Código SwissQR API
:::nota Referência rápida
Ponto final: POST /api/v2/ReadSwissQRBill · Obrigatório: api-key, docContent, docName, IsAsync
:::
Use o formulário abaixo para enviar sua API chave e uma PDF (Base64) que contém um suíço QR-conta. A resposta é JSON com informações de pagamento extraídas (ou uma pesquisa) URL quando asyncNão é necessário nenhum código, preencha os campos e clique. Enviar solicitação.
Visão geral, parâmetros e casos de uso
- Overview
- Parameters
- Use cases
O que é o Read SwissQR Code?
Este ponto final indica Suíça QR-códigos de fatura de um PDF e retorna dados de pagamento estruturados. Você envia o PDF (Base64) e opcionalmente habilitar async; o API retornos JSON com valor, moeda, IBAN, nome do credor, referência do pagamento, data de vencimento, finalidade e campos relacionados, prontos para automação ou conciliação de pagamentos.
Principais características
- dados de pagamento estruturadosValor, moeda, IBAN, nome do credor, referência, data de vencimento, finalidade.
- Solteiro PDF entrada: docContent (Base64) e docName; nenhuma configuração adicional.
- Assíncrono: IsAsync retorna um URL Para consultar os resultados quando o processamento for assíncrono.
:::dica Ideal para Usar após Criar fatura SwissQR para verificar faturas ou extrair dados de pagamento de sistemas suíços existentes. QR Faturas para fluxos de trabalho bancários ou contábeis. :::
API parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| api-key | corda | Sim | Seu PDF4me API chave, Base64 codificado. Obtenha-o do painel. |
| docContent | base64 | Sim | PDF conteúdo do arquivo (Base64) contendo um suíço QR-conta. |
| docName | corda | Sim | PDF Nome do arquivo com extensão .pdf. |
| IsAsync | booleano | Sim | Ativar o processamento assíncrono. |
Quando usar a leitura do código SwissQR
- Processamento de faturas e contasExtrair informações de pagamento da Suíça QR Faturas para pagamento automatizado ou conciliação.
- Sistemas bancários e de pagamentoIntegrar a Suíça QR-Leitura de faturas em aplicativos bancários ou de pagamento.
- Automação de pagamentosReduzir a entrada manual de dados através da leitura da quantidade, IBAN, referência e credor de PDFs.
- VerificaçãoConfirme que a Suíça QR-contas criadas com Criar fatura SwissQR são legíveis e corretas.
Para esquemas de requisição/resposta e exemplos de código, consulte Leia o código SwissQR no PDF4me API documentos.
Pré-requisitos
Antes de usar este endpoint, certifique-se de que você possui:
- Um válido PDF4me API chave (Adquira o seu API Chave)
- A PDF documento contendo códigos SwissQR
- O PDF arquivo codificado em Base64 formato
Formato de resposta
O API retornos JSON com swissQrCodeData (quantia, moeda, iban, creditorName, paymentReference, dueDate, propósito, etc.). Status 200 retorna os dados imediatamente; Status 202 significa que o processamento é assíncrono, consulte o Location cabeçalho URL até que o resultado esteja pronto.