pacs008 API 레퍼런스

Het project biedt zowel een REST API als een CLI voor operationele processen rond betalingsberichten.

Implementatienotities

• Gebruik synchrone generatie voor operatorgestuurde controles en kleine batches wanneer de aanroeper direct XML verwacht.
• Gebruik asynchrone generatie wanneer invoerbestanden groot zijn, jobs opnieuw moeten worden geprobeerd of generatie deel uitmaakt van een breder orkestratieproces.
• Sla zowel de bronpayload als het validatierapport op zodat supportteams XML-uitvoer tijdens incidenten kunnen reproduceren.
• Vergrendel XML-sjabloon- en XSD-paden in de implementatieconfiguratie om stille upgrades te voorkomen.

Installatie

Installeer het pakket via PyPI. Python 3.10 of hoger is vereist.

python -m pip install pacs008
 

---

REST API

Start de ingebouwde FastAPI-server om HTTP-eindpunten voor validatie en generatie beschikbaar te stellen.

Start de server

uvicorn pacs008.api.app:app --reload --host 0.0.0.0 --port 8000
 

Eindpunten

• pacs.002.001.12 — FI-naar-FI-betalingsstatusrapport
• pacs.003.001.09 — FI-naar-FI-klantincasso
• pacs.004.001.11 — Betalingsretour
• pacs.007.001.11 — FI-naar-FI-betalingsstornering
• pacs.008.001.13 — FI-naar-FI-klantkredietoverboeking
• pacs.009.001.10 — Kredietoverboeking tussen financiële instellingen
• pacs.010.001.05 — Incasso tussen financiële instellingen
• pacs.028.001.05 — FI-naar-FI-aanvraag betalingsstatus

Validatievoorbeeld

Dien betalingsgegevens in voor validatie voordat XML wordt gegenereerd.

curl -X POST http://localhost:8000/api/validate \
  -H "Content-Type: application/json" \
  -d '{
    "message_type": "pacs.008.001.13",
    "data": [{
      "msg_id": "MSG-2026-001",
      "creation_date_time": "2026-01-15T10:30:00",
      "nb_of_txs": "1",
      "settlement_method": "CLRG",
      "interbank_settlement_date": "2026-01-15",
      "end_to_end_id": "E2E-INV-2026-001",
      "interbank_settlement_amount": "25000.00",
      "interbank_settlement_currency": "EUR",
      "charge_bearer": "SHAR",
      "debtor_name": "Acme Corp GmbH",
      "debtor_agent_bic": "DEUTDEFF",
      "creditor_agent_bic": "COBADEFF",
      "creditor_name": "Widget Industries SA"
    }]
  }'
 

{
  "valid": true,
  "message_type": "pacs.008.001.13",
  "errors": [],
  "warnings": []
}
 

Synchroon generatievoorbeeld

Genereer een pacs.008.001.13 XML-bestand vanuit een JSON-payload.

curl -X POST http://localhost:8000/api/generate \
  -H "Content-Type: application/json" \
  -d '{
    "message_type": "pacs.008.001.13",
    "template": "pacs008/templates/pacs.008.001.13/template.xml",
    "schema": "pacs008/templates/pacs.008.001.13/pacs.008.001.13.xsd",
    "data": [{
      "msg_id": "MSG-2026-001",
      "creation_date_time": "2026-01-15T10:30:00",
      "nb_of_txs": "1",
      "settlement_method": "CLRG",
      "interbank_settlement_date": "2026-01-15",
      "end_to_end_id": "E2E-INV-2026-001",
      "tx_id": "TX-001",
      "interbank_settlement_amount": "25000.00",
      "interbank_settlement_currency": "EUR",
      "charge_bearer": "SHAR",
      "debtor_name": "Acme Corp GmbH",
      "debtor_agent_bic": "DEUTDEFF",
      "creditor_agent_bic": "COBADEFF",
      "creditor_name": "Widget Industries SA"
    }]
  }' --output pacs008_output.xml
 

Asynchrone generatie

Voor grotere bestanden of pipelinegebruik dient u een asynchrone taak in en peilt u op voltooiing.

# Submit the job
JOB=$(curl -s -X POST http://localhost:8000/api/generate/async \
  -H "Content-Type: application/json" \
  -d '{"message_type":"pacs.008.001.13","data":[...]}')

JOB_ID=$(echo $JOB | jq -r '.job_id')

# Poll for completion
curl http://localhost:8000/api/status/$JOB_ID

# Download the result
curl http://localhost:8000/api/download/$JOB_ID --output result.xml
 

{
  "job_id": "8f7f0d4b-7df9-4d1a-8d47-19f4f28b6d38",
  "status": "completed",
  "message_type": "pacs.008.001.13",
  "download_url": "/api/download/8f7f0d4b-7df9-4d1a-8d47-19f4f28b6d38"
}
 

---

CLI

De opdrachtregelinterface accepteert een gegevensbestand, een berichtversie, een sjabloon en een schema. Het valideert de invoer en schrijft de gegenereerde XML naar de uitvoermap.

Basisgebruik

pacs008 -t  \
  -m  \
  -s  \
  -d 
 

Voorbeeld

pacs008 -t pacs.008.001.13 \
  -m pacs008/templates/pacs.008.001.13/template.xml \
  -s pacs008/templates/pacs.008.001.13/pacs.008.001.13.xsd \
  -d payments.csv
 

Dry-run modus

Gebruik --dry-run om invoergegevens te valideren zonder XML te genereren. De afsluitcode geeft aan of de validatie geslaagd (0) of mislukt (1) is.

pacs008 -t pacs.008.001.13 \
  -m pacs008/templates/pacs.008.001.13/template.xml \
  -s pacs008/templates/pacs.008.001.13/pacs.008.001.13.xsd \
  -d payments.csv \
  --dry-run
 

Voeg --verbose toe voor gedetailleerde uitvoer tijdens de generatie.

---

Python API

Gebruik de bibliotheek rechtstreeks in Python-scripts of -services.

Genereer XML vanuit een lijst met betalingsrecords

from pacs008 import generate_xml_string

payments = [{
    "msg_id": "MSG-2026-001",
    "creation_date_time": "2026-01-15T10:30:00",
    "nb_of_txs": "1",
    "settlement_method": "CLRG",
    "interbank_settlement_date": "2026-01-15",
    "end_to_end_id": "E2E-INV-2026-001",
    "tx_id": "TX-001",
    "interbank_settlement_amount": "25000.00",
    "interbank_settlement_currency": "EUR",
    "charge_bearer": "SHAR",
    "debtor_name": "Acme Corp GmbH",
    "debtor_agent_bic": "DEUTDEFF",
    "creditor_agent_bic": "COBADEFF",
    "creditor_name": "Widget Industries SA",
}]

xml = generate_xml_string(
    payments,
    "pacs.008.001.13",
    "pacs008/templates/pacs.008.001.13/template.xml",
    "pacs008/templates/pacs.008.001.13/pacs.008.001.13.xsd",
)
print(xml)
 

SWIFT-compliancecontrole

Valideer en reinig gegevens op basis van de SWIFT-tekenset en veldlengteregels voorafgaand aan de generatie.

from pacs008.compliance import cleanse_data_with_report

raw = [{"debtor_name": "Müller & Söhne™", "msg_id": "X" * 50}]
clean, report = cleanse_data_with_report(raw)
print(report.summary())
 

---

Docker

Voer de API uit in een container met behulp van het meegeleverde Dockerfile.

docker build -t pacs008:latest .
docker run -p 8000:8000 pacs008:latest
 

docker run --rm   -e PACS008_LOG_LEVEL=INFO   -v $PWD/examples:/data   -p 8000:8000 pacs008:latest
 

---

IBAN- en BIC-validatie

Valideer financiële identificaties onafhankelijk van XML-generatie.

from pacs008.validation import validate_iban, validate_bic

is_valid, error = validate_iban("DE89370400440532013000", strict=False)
is_valid, error = validate_bic("DEUTDEFF", strict=False)
 

---

Streaming

Laad grote datasets in configureerbare blokken om het geheugengebruik te beperken.

from pacs008.data.loader import load_payment_data_streaming

for chunk in load_payment_data_streaming("large_payments.csv", chunk_size=500):
    print(f"Processing {len(chunk)} records")
 

from pacs008.validation import validate_batch

for chunk in load_payment_data_streaming("large_payments.csv", chunk_size=500):
    report = validate_batch(chunk, "pacs.008.001.13")
    print(report.summary())
 

---

Validatiedienst

Voer de volledige pre-generatie validatiepipeline programmatisch uit.

from pacs008.validation import ValidationService, ValidationConfig

service = ValidationService()
report = service.validate_all(ValidationConfig(
    xml_message_type="pacs.008.001.13",
    xml_template_file_path="pacs008/templates/pacs.008.001.13/template.xml",
    xsd_schema_file_path="pacs008/templates/pacs.008.001.13/pacs.008.001.13.xsd",
    data_file_path="payments.csv",
))
print(report.is_valid, report.errors)
 

---

Verplichte gegevensvelden

Elk betalingsrecord moet de volgende velden bevatten. Versiespecifieke velden zijn aangegeven waar van toepassing.

Versiespecifieke velden