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 /validateXML を生成せずにスキーマに対して支払いデータを検証する
POST /generateXML を同期的に生成してファイルを返す
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: