Ìtọ́kasí API pacs008

Iṣẹ́ náà pèsè REST API àti CLI fún àwọn ọ̀nà iṣẹ́ ìṣàkóso ìfiránṣẹ́ ìsanwó.

Ìgbékalẹ̀

Fi àpò náà sórí ẹ̀rọ láti PyPI. Ó nílò Python 3.10 tàbí tí ó tẹ̀lé e.

python -m pip install pacs008

REST API

Bẹ̀rẹ̀ olùpèsè FastAPI tí a kọ́ sínú fún pípèsè àwọn ọ̀nà HTTP fún ìṣàyẹ̀wò àti ṣíṣẹ̀dá.

Bẹ̀rẹ̀ olùpèsè

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

Àwọn ọ̀nà ìparí

Endpoint	Àlàyé
`GET /api/health`	Health check that returns service status
`POST /api/validate`	Validate payment data without generating XML
`POST /api/generate`	Generate XML now and return the file
`POST /api/generate/async`	Submit an async generation job
`GET /api/status/{job_id}`	Check job status by ID
`GET /api/download/{job_id}`	Download XML after the job completes
`DELETE /api/jobs/{job_id}`	Cancel a pending or running job
`GET /api/docs`	Swagger UI for testing all endpoints

pacs.002.001.12 — Ìròyìn ipò ìsanwó láàárín àwọn ilé-iṣẹ́ ìṣúná
pacs.003.001.09 — Gbígbà owó tààrà fún oníbàárà láàárín àwọn ilé-iṣẹ́ ìṣúná
pacs.004.001.11 — Ìdápadà ìsanwó
pacs.007.001.11 — Ìfàgílé ìsanwó láàárín àwọn ilé-iṣẹ́ ìṣúná
pacs.008.001.13 — Gbígbé owó àṣẹ fún oníbàárà láàárín àwọn ilé-iṣẹ́ ìṣúná
pacs.009.001.10 — Gbígbé owó àṣẹ láàárín àwọn ilé-iṣẹ́ ìṣúná
pacs.010.001.05 — Gbígbà owó tààrà láàárín àwọn ilé-iṣẹ́ ìṣúná
pacs.028.001.05 — Ìbéèrè ipò ìsanwó láàárín àwọn ilé-iṣẹ́ ìṣúná

Àpẹẹrẹ ìṣàyẹ̀wò

Fi dátà ìsanwó sílẹ̀ fún ìṣàyẹ̀wò ṣáájú ṣíṣẹ̀dá 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": []
}

Àpẹẹrẹ ṣíṣẹ̀dá ní àkókò kan náà

Ṣẹ̀dá fáìlì XML pacs.008.001.13 láti dátà JSON.

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

Ṣíṣẹ̀dá aládàáṣe

Fún àwọn fáìlì ńlá tàbí lílo ọ̀nà, fi iṣẹ́ aládàáṣe sílẹ̀ kí o sì ṣàyẹ̀wò tí ó fi parí.

# 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

Ẹnu ọ̀nà ìtọ́sọ́nà laini gba fáìlì dátà, ẹ̀dà ìfiránṣẹ́, àwòṣe, àti ètò.

Ìlò ìpìlẹ̀

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

Àpẹẹrẹ

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

Ìpò ìṣàyẹ̀wò gbígbẹ

Lo --dry-run láti ṣàyẹ̀wò dátà ìwọlé láìṣẹ̀dá XML.

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

Fi --verbose kún fún ìjáde àlàyé nígbà ṣíṣẹ̀dá.

Python API

Lo ilé ìkàwé tààrà nínú àwọn ìwé Python tàbí àwọn iṣẹ́.

Ṣẹ̀dá XML láti àwọn àkọsílẹ̀ ìsanwó

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)

Àyẹ̀wò ìtẹ̀lé SWIFT

Ṣàyẹ̀wò kí o sì fọ́ dátà lòdì sí àwọn ìlànà ohun àmì àti gígùn pápá SWIFT ṣáájú ṣíṣẹ̀dá.

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

Mú API ṣiṣẹ́ nínú àpótí nípa lílo Dockerfile tí a fi sínú.

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

Ìṣàyẹ̀wò IBAN àti BIC

Ṣàyẹ̀wò àwọn àmì ìdánimọ̀ ìṣúná lọ́tọ̀ sí ṣíṣẹ̀dá 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)

Ṣíṣàn dátà

Gbé àwọn àkójọ dátà ńlá sínú àwọn ìpín tí a lè ṣètò láti dín lílo ìrántí kù.

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

Iṣẹ́ ìṣàyẹ̀wò

Mú ọ̀nà ìṣàyẹ̀wò kíkún ṣáájú-ṣíṣẹ̀dá ṣiṣẹ́ nípasẹ̀ ètò.

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)

Àwọn pápá dátà tí a nílò

Àkọsílẹ̀ ìsanwó kọ̀ọ̀kan gbọdọ̀ ní àwọn pápá wọ̀nyí nínú.

Pápá	Àlàyé	Ìdíwọ́n
`msg_id`	Àmì ìdánimọ̀ ìfiránṣẹ́	Ó pọ̀ jù lọ ohun àmì 35
`creation_date_time`	Àmì àkókò ṣíṣẹ̀dá	Ètò ISO 8601
`nb_of_txs`	Iye àwọn ìṣòwò	Odidi rere
`settlement_method`	Ọ̀nà ìsanwó	CLRG, INDA, COVE, tàbí INGA
`end_to_end_id`	Àmì ìdánimọ̀ láti ìbẹ̀rẹ̀ dé òpin	Ó pọ̀ jù lọ ohun àmì 35
`interbank_settlement_amount`	Iye ìsanwó láàárín àwọn ilé ìfowópamọ́	Dẹsímálì, f.à. `25000.00`
`interbank_settlement_currency`	Owó ìsanwó	Àmì ISO 4217
`charge_bearer`	Olùdá ìdíyelé	DEBT, CRED, SHAR, tàbí SLEV
`debtor_name`	Orúkọ onígbèsè	Ó pọ̀ jù lọ ohun àmì 140
`debtor_agent_bic`	BIC aṣojú onígbèsè	Ohun àmì 8 tàbí 11
`creditor_agent_bic`	BIC aṣojú olùgbàmú	Ohun àmì 8 tàbí 11
`creditor_name`	Orúkọ olùgbàmú	Ó pọ̀ jù lọ ohun àmì 140

Àwọn pápá tí ó kan ẹ̀dà kan pàtó

Pápá	Àlàyé	Ìdíwọ́n
`uetr`	Ìtọ́kasí ìṣòwò aláìlẹ́gbẹ́ láti ìbẹ̀rẹ̀ dé òpin	Ètò UUID — ó wà láti v08
`mandate_id`	Àmì ìdánimọ̀ àṣẹ	Ó wà láti v10
`expiry_date_time`	Àmì àkókò ìparí ìfiránṣẹ́	Ó wà ní v13