Dokumentacja API pacs008

O projeto fornece tanto uma API REST quanto uma CLI para processos operacionais de mensagens de pagamento.

Notas de implementação

• Use geração síncrona para verificações operacionais e lotes pequenos quando o chamador espera XML imediatamente.
• Use geração assíncrona quando os arquivos de entrada forem grandes, quando os jobs precisarem de nova tentativa ou quando a geração fizer parte de um processo de orquestração mais amplo.
• Armazene tanto a carga útil de origem quanto o relatório de validação para que equipes de suporte consigam reproduzir a saída XML durante incidentes.
• Fixe os caminhos dos modelos XML e dos arquivos XSD na configuração de implantação para evitar atualizações silenciosas.

Instalação

Instale o pacote a partir do PyPI. É necessário Python 3.10 ou superior.

python -m pip install pacs008
 

---

REST API

Inicie o servidor FastAPI integrado para expor endpoints HTTP de validação e geração.

Iniciar o servidor

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

Endpoints

• pacs.002.001.12 — Relatório de status de pagamento FI a FI
• pacs.003.001.09 — Débito direto de cliente FI a FI
• pacs.004.001.11 — Retorno de pagamento
• pacs.007.001.11 — Reversão de pagamento FI a FI
• pacs.008.001.13 — Transferência de crédito de cliente FI a FI
• pacs.009.001.10 — Transferência de crédito entre instituições financeiras
• pacs.010.001.05 — Débito direto entre instituições financeiras
• pacs.028.001.05 — Solicitação de status de pagamento FI a FI

Exemplo de validação

Envie dados de pagamento para validação antes de gerar 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": []
}
 

Exemplo de geração síncrona

Gera um arquivo XML pacs.008.001.13 a partir de um payload 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
 

Geração assíncrona

Para arquivos maiores ou uso em pipelines, envie um job assíncrono e consulte a conclusão.

# 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

A interface de linha de comando aceita um arquivo de dados, uma versão de mensagem, um modelo XML e um esquema. Valida a entrada e grava o XML gerado no diretório de saída.

Uso básico

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

Exemplo

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
 

Modo dry-run

Use --dry-run para validar dados de entrada sem gerar XML. O código de saída indica se a validação passou (0) ou falhou (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
 

Adicione --verbose para saída detalhada durante a geração.

---

Python API

Use a biblioteca diretamente em scripts ou serviços Python.

Gerar XML a partir de uma lista de registros de pagamento

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)
 

Verificação de conformidade SWIFT

Valide e higienize os dados de acordo com as regras de conjunto de caracteres e comprimento de campo do SWIFT antes da geração.

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

Execute a API em um contêiner utilizando o Dockerfile incluído.

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
 

---

Validação IBAN e BIC

Valide identificadores financeiros independentemente da geração 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)
 

---

Streaming

Carregue grandes conjuntos de dados em lotes configuráveis para limitar o uso de memória.

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

---

Serviço de validação

Execute o pipeline completo de validação pré-geração de forma programática.

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)
 

---

Campos de dados obrigatórios

Cada registro de pagamento deve incluir os seguintes campos. Campos específicos de versão são indicados onde aplicável.

Campos específicos de versão