API ​

该项目同时提供 REST API 和 CLI，用于运营支付报文处理工作流。

安装 ​

从 PyPI 安装软件包。需要 Python 3.9.2 或更高版本。

bash
python -m pip install pacs008

REST API ​

启动内置 FastAPI 服务器以提供用于验证和生成的 HTTP 端点。

启动服务器 ​

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

端点 ​

Endpoint说明
GET /health健康检查 — 返回服务状态
POST /validate根据模式验证支付数据，无需生成 XML
POST /generate同步生成 XML 并返回文件
POST /generate/async提交异步生成任务
GET /status/{job_id}按 ID 轮询任务状态
GET /download/{job_id}任务完成后下载生成的 XML
DELETE /jobs/{job_id}取消待处理或正在运行的作业
GET /docs用于探索和测试所有端点的交互式 Swagger UI

验证示例 ​

在生成 XML 之前提交支付数据进行验证。

bash
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"
    }]
  }'

同步生成示例 ​

从 JSON 载荷生成 pacs.008.001.13 XML 文件。

bash
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

异步生成 ​

对于较大的文件或流水线使用场景，提交异步任务并轮询直至完成。

bash
# 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

CLI ​

命令行界面接受数据文件、报文版本、模板和模式。它验证输入并将生成的 XML 写入输出目录。

基本用法 ​

bash
pacs008 -t <message_type> \
  -m <template_file> \
  -s <schema_file> \
  -d <data_file>

示例 ​

bash
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）。

bash
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 ​

python
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 字符集和字段长度规则验证并清理数据。

python
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。

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

IBAN 和 BIC 验证 ​

独立于 XML 生成验证金融标识符。

python
from pacs008.validation import validate_iban, validate_bic

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

流式处理 ​

以可配置的块大小加载大型数据集以限制内存使用。

python
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")

验证服务 ​

以编程方式运行完整的生成前验证管道。

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

必填数据字段 ​

每条支付记录必须包含以下字段。版本特定字段在适用处有说明。

字段说明约束
msg_id报文标识符最多 35 个字符
creation_date_time创建时间戳ISO 8601 格式
nb_of_txs交易数量正整数
settlement_method清算方式CLRG、INDA、COVE 或 INGA
end_to_end_id端到端标识符最多 35 个字符
interbank_settlement_amount银行间清算金额小数，例如 25000.00
interbank_settlement_currency清算货币ISO 4217 代码
charge_bearer费用承担方DEBT、CRED、SHAR 或 SLEV
debtor_name付款方名称最多 140 个字符
debtor_agent_bic付款方代理 BIC8 或 11 个字符
creditor_agent_bic收款方代理 BIC8 或 11 个字符
creditor_name收款方名称最多 140 个字符

版本特定字段 ​

字段说明约束
uetr唯一端到端交易参考UUID 格式 — 从 v08 起可用
mandate_id授权标识符从 v10 起可用
expiry_date_time报文到期时间戳在 v13 中可用

Last updated: