pacs008 API 参考

該專案同時提供 REST API 和 CLI，用於營運支付訊息處理工作流程。

實作說明

• 使用同步生成來處理操作人員檢查與小批次工作，當呼叫端需要立即取得 XML 時尤其適合。
• 當輸入檔案較大、工作需要重試，或生成流程屬於更大型的協調引擎時，請使用非同步生成。
• 保留原始輸入資料與驗證報告，讓支援團隊在事故期間能重現 XML 輸出。
• 在部署設定中固定範本與 XSD 路徑，以避免發行時發生靜默升級。

安裝

從 PyPI 安裝套件。需要 Python 3.10 或更高版本。

python -m pip install pacs008
 

---

REST API

啟動內建 FastAPI 伺服器以提供用於驗證和產生的 HTTP 端點。

啟動伺服器

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

端點

• pacs.002.001.12 — 金融機構間付款狀態報告
• pacs.003.001.09 — 金融機構間客戶直接扣款
• pacs.004.001.11 — 付款退回
• pacs.007.001.11 — 金融機構間付款撤銷
• pacs.008.001.13 — 金融機構間客戶信用轉帳
• pacs.009.001.10 — 金融機構信用轉帳
• pacs.010.001.05 — 金融機構直接扣款
• pacs.028.001.05 — 金融機構間付款狀態請求

驗證範例

在產生 XML 之前提交支付資料進行驗證。

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": []
}
 

同步產生範例

從 JSON 載荷產生 pacs.008.001.13 XML 檔案。

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
 

非同步產生

對於較大的檔案或流水線使用情境，提交非同步任務並輪詢直至完成。

# 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

命令列介面接受資料檔案、訊息版本、範本和結構描述。它驗證輸入並將產生的 XML 寫入輸出目錄。

基本用法

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

範例

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 驗證輸入資料而不產生 XML。結束碼表示驗證是否通過（0）或失敗（1）。

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
 

加入 --verbose 以在產生過程中取得詳細輸出。

---

Python API

直接在 Python 腳本或服務中使用該程式庫。

從支付記錄清單產生 XML

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 合規性檢查

在產生之前根據 SWIFT 字元集和欄位長度規則驗證並清理資料。

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

使用附帶的 Dockerfile 在容器中執行 API。

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 和 BIC 驗證

獨立於 XML 產生驗證金融識別碼。

from pacs008.validation import validate_iban, validate_bic

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

---

串流處理

以可設定的區塊大小載入大型資料集以限制記憶體使用。

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())
 

---

驗證服務

以程式化方式執行完整的產生前驗證管線。

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)
 

---

必填資料欄位

每筆支付記錄必須包含以下欄位。版本特定欄位在適用處有說明。

版本特定欄位