Pular para o conteúdo principal
API PDF4meIntegraçõesBase de conhecimentoExtensõesTestador de APIBlog

Leia o código SwissQR - Extrator de dados de pagamento API

PDF4me Leia o código SwissQR Permite extrair e ler códigos SwissQR de PDF documentos usando recursos avançados OCR e tecnologia de reconhecimento de código de barras. Isto API processos de serviço PDF arquiva e extrai informações de pagamento estruturadas, incluindo valores, moeda, IBAN, detalhes do credor e referências de pagamento para um processamento de pagamentos digitais perfeito. API recebe PDF conteúdo através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Esta solução é ideal para processamento de faturas, integração bancária, automação de pagamentos e relatórios financeiros.

Artigos relacionados no blogue
Ainda não há nenhuma publicação no blogue sobre esta funcionalidade — em breve.
Entretanto, explore o blogue da PDF4me para encontrar tutoriais e fluxos de trabalho para todas as plataformas.
Visite o blogue →

Autenticando seu API Solicitar​

Para acessar o PDF4me REST APIPara que uma solicitação seja aceita, é necessário incluir as credenciais de autenticação adequadas. A autenticação garante a segurança da comunicação e valida sua identidade como usuário autorizado do sistema. REST API.

Get your api Key

Principais características​

  • Reconhecimento de código QR suíçoExtrair e ler códigos SwissQR de PDF documentos usando recursos avançados OCR e tecnologia de reconhecimento de código de barras
  • Dados de Pagamento EstruturadosExtrair informações estruturadas de pagamento, incluindo valores, moeda, IBAN, detalhes do credor e referências de pagamento
  • Padrão de Pagamento SuíçoApoio à Suíça QR- Padrão de pagamento digital de faturas (junho de 2020)
  • Processamento assíncronoSuporte para async Processamento com sondagem para operações de longa duração

Suporte para código QR suíço​

O API Suporta a leitura de códigos SwissQR de PDF documentos. Os códigos SwissQR contêm informações de pagamento estruturadas, incluindo valor, moeda, IBAN, detalhes do credor e referências de pagamento. Os dados extraídos são retornados em um formato padronizado para integração com sistemas de processamento de pagamentos.

Endpoint da API REST​

O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de leitura de código SwissQR são realizadas por meio de um único ponto de extremidade:

  • Método: POST
  • Ponto final: /api/v2/ReadSwissQRBill

Parâmetros da API REST​

Lista completa de parâmetros para a leitura do código SwissQR. REST APIOs parâmetros estão organizados por categoria para melhor compreensão e implementação.

Importante: Os parâmetros marcados com um asterisco (*) são obrigatórios e devem ser fornecidos para o API para funcionar corretamente.

Parâmetros obrigatórios​

ParâmetroTipoDescriçãoExemplo
docContent*Base64PDF conteúdo do arquivo codificado em Base64 contendo códigos SwissQRJVBERi...
docName*StringPDF nome do arquivo com extensão .pdfinvoice.pdf
async*BooleanAtive o processamento assíncrono. Quando true, o API retorna o status 202 e fornece uma opção de sondagem. URL no Location cabeçalhotrue

Saída​

O PDF4me Leia o código SwissQR REST API Retorna respostas diferentes dependendo do modo de processamento. API retorna estruturado JSON Dados com informações do código SwissQR.

Processamento síncrono (padrão)

Quando async não está definido ou está definido como false, o API processa a solicitação imediatamente:

Código de status: 200 OK

Content-Type: application/json

Corpo da resposta:

{
  "fileName": "invoice.pdf",
  "mimeType": "application/pdf",
  "fileSize": 2456789,
  "success": true,
  "swissQrCodeData": {
    "amount": "100.00",
    "currency": "CHF",
    "iban": "CH9300762011623852957",
    "creditorName": "Swiss Company AG",
    "paymentReference": "INV-2024-001",
    "dueDate": "2024-12-31",
    "purpose": "Invoice payment"
  }
}

Campos de resposta:

  • nome_do_arquivo (string): O PDF nome do arquivo
  • tipo mime (corda): MIME tipo de arquivo (aplicativo/pdf)
  • tamanho do arquivo (número): Tamanho do PDF arquivo em bytes
  • sucesso (booleano): Indica se o código SwissQR foi lido com sucesso.
  • dados de código QR suíço (objeto): Informações de pagamento do código SwissQR extraídas
    • quantia (string): Valor do pagamento
    • moeda (string): Código da moeda (CHF, EUR, USD)
    • eles iam (corda): IBAN do credor
    • nome do credor (string): Nome ou empresa credora
    • Referência de pagamento (string): Número de referência do pagamento
    • data de vencimento (string): Data de vencimento do pagamento (se disponível)
    • propósito (string): Finalidade ou descrição do pagamento

Exemplo (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
if (data.success) {
  console.log(`Amount: ${data.swissQrCodeData.amount} ${data.swissQrCodeData.currency}`);
  console.log(`IBAN: ${data.swissQrCodeData.iban}`);
}

Exemplo de solicitação​

Cabeçalho​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Observação:

  • Adquira o seu API chave do PDF4me Painel
  • O API a chave deve ser Base64 codificado e prefixado com "Básico" no Authorization cabeçalho
  • Exemplo: Se o seu API chave é abc123, codifique-o para Base64 e usar Authorization: Basic YWJjMTIz

Carga útil​

Exemplo:

{
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "docName": "invoice.pdf",
  "async": true
}

Exemplos de código​

O PDF4me Leia o código SwissQR REST API Fornece exemplos de código em várias linguagens de programação. Escolha a linguagem que melhor se adapta ao seu ambiente de desenvolvimento:

C# (CSharp) Amostra

Completo C# Implementação para leitura de códigos SwissQR a partir de PDF documentos:

Casos de uso e aplicações industriais​

Casos de uso em finanças e bancos

  • Processamento de faturasExtrair informações de pagamento da Suíça QR faturas para processamento de pagamentos automatizado
  • Integração bancáriaIntegrar a leitura de códigos SwissQR em aplicações bancárias e sistemas de pagamento.
  • Automação de PagamentosSimplifique os fluxos de trabalho de pagamento e reduza a entrada manual de dados.
  • Processamento de faturas: Automatize a Suíça QR processamento de faturas e verificação de pagamentos
  • Conciliação de PagamentosAutomatizar os processos de correspondência e conciliação de pagamentos
  • Relatórios financeirosExtrair dados de pagamento da Suíça QR códigos para relatórios e análises financeiras

Obtenha ajuda​

Get Your API KeyAPI SamplesGetting Started