Saltar al contenido principal
PDF4me APIIntegracionesBase de conocimientosExtensionesProbador de APIBlog

Lee el código SwissQR - Extractor de datos de pago API

PDF4me Lea el código SwissQR le permite extraer y leer códigos SwissQR de PDF documentos que utilizan tecnología avanzada OCR y tecnología de reconocimiento de códigos de barras. API procesos de servicio PDF archivos y extrae información de pago estructurada que incluye importes, moneda, IBAN, detalles del acreedor y referencias de pago para un procesamiento de pagos digitales sin problemas. API recibe PDF contenido a través de REST API llamadas, utilizando Base64 Codificación para una transmisión segura. Esta solución es ideal para el procesamiento de facturas, la integración bancaria, la automatización de pagos y la elaboración de informes financieros.

Entradas de blog relacionadas
Aún no hay ninguna entrada de blog sobre esta función; estará disponible próximamente.
Mientras tanto, echa un vistazo al blog de PDF4me para encontrar tutoriales y flujos de trabajo para todas las plataformas.
Visita el blog →

Autenticando su API Pedido​

Para acceder al PDF4me REST APICada solicitud debe incluir las credenciales de autenticación adecuadas. La autenticación garantiza una comunicación segura y valida su identidad como usuario autorizado del sistema. REST API.

Get your api Key

Características principales​

  • Reconocimiento de códigos SwissQR: Extraer y leer códigos SwissQR de PDF documentos que utilizan tecnología avanzada OCR y tecnología de reconocimiento de códigos de barras
  • Datos de pago estructurados: Extraer información de pago estructurada que incluye importes, moneda, IBAN, datos del acreedor y referencias de pago
  • Estándar de pago suizo: Soporte para Suiza QR-Estándar de pago digital de facturas (junio de 2020)
  • Procesamiento asíncrono: Soporte para async procesamiento con sondeo para operaciones de larga duración

Soporte de códigos QR suizos​

El API admite la lectura de códigos SwissQR desde PDF documentos. Los códigos SwissQR contienen información de pago estructurada que incluye importe, moneda, IBAN, detalles del acreedor y referencias de pago. Los datos extraídos se devuelven en un formato estandarizado para su integración con los sistemas de procesamiento de pagos.

Punto final de la API REST​

El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de lectura de códigos SwissQR se realizan a través de un único punto final:

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

Parámetros de la API REST​

Lista completa de parámetros para la lectura del código SwissQR REST APILos parámetros están organizados por categoría para una mejor comprensión e implementación.

Importante: Los parámetros marcados con un asterisco (*) son obligatorios y deben proporcionarse para la API para que funcione correctamente.

Parámetros requeridos​

ParámetroTipoDescripciónEjemplo
docContent*Base64PDF contenido del archivo codificado en Base64 que contienen códigos SwissQRJVBERi...
docName*StringPDF Nombre del archivo con extensión .pdfinvoice.pdf
async*BooleanHabilitar el procesamiento asíncrono. Cuando true, el API devuelve un estado 202 y proporciona una encuesta URL en el Location encabezadotrue

Producción​

El PDF4me Lea el código SwissQR REST API devuelve diferentes respuestas según el modo de procesamiento. API devoluciones estructuradas JSON Datos con información del código SwissQR.

Procesamiento síncrono (predeterminado)

Cuando async no está configurado o está configurado false, el API procesa la solicitud inmediatamente:

Código de estado: 200 OK

Content-Type: application/json

Cuerpo de la respuesta:

{
  "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 respuesta:

  • Nombre del archivo (cadena): El PDF Nombre del archivo
  • tipo mime (cadena): MIME Tipo de archivo (application/pdf)
  • Tamaño del archivo (número): Tamaño del PDF archivo en bytes
  • éxito (booleano): Indica si el código SwissQR se leyó correctamente.
  • Datos de código QR suizo (objeto): Información de pago con código SwissQR extraída
    • cantidad (cadena): Importe del pago
    • divisa (cadena): Código de moneda (CHF, EUR, USD)
    • iban (cadena): IBAN del acreedor
    • Nombre del acreedor (cadena): Nombre o empresa del acreedor
    • Referencia de pago (cadena): Número de referencia de pago
    • fecha de vencimiento (cadena): Fecha de vencimiento del pago (si está disponible)
    • objetivo (cadena): Finalidad o descripción del pago

Ejemplo (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}`);
}

Ejemplo de solicitud​

Encabezamiento​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Nota:

  • Consigue tu API clave del PDF4me Panel
  • El API La clave debe ser Base64 codificado y prefijado con "Basic" en el Authorization encabezado
  • Ejemplo: Si su API La clave es abc123, codificarlo a Base64 y usar Authorization: Basic YWJjMTIz

Carga útil​

Ejemplo:

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

Ejemplos de código​

El PDF4me Lea el código SwissQR REST API Proporciona ejemplos de código en varios lenguajes de programación. Elija el lenguaje que mejor se adapte a su entorno de desarrollo:

C# (CSharp) Muestra

Completo C# implementación para leer códigos SwissQR desde PDF documentos:

Casos de uso y aplicaciones en la industria​

Casos de uso en finanzas y banca

  • Procesamiento de facturas: Extraer información de pago de Swiss QR facturas para procesamiento de pagos automatizado
  • Integración bancariaIntegrar la lectura de códigos SwissQR en aplicaciones bancarias y sistemas de pago.
  • Automatización de pagosOptimizar los flujos de trabajo de pago y reducir la entrada manual de datos.
  • Procesamiento de facturas: Automatizar suizo QR procesamiento de facturas y verificación de pagos
  • Conciliación de pagos: Automatizar los procesos de comparación y conciliación de pagos
  • Información financiera: Extraer datos de pago de Suiza QR códigos para informes y análisis financieros

Obtén ayuda​

Get Your API KeyAPI SamplesGetting Started