Skip to content

Payment Reconciliation — Proposed Guide

Planned API — Reference Only

Payment Reconciliation: Payment reconciliation would compare approved reimbursement records with independently obtained provider outcomes. Matching a…

Overview

Payment reconciliation would compare approved reimbursement records with independently obtained provider outcomes. Matching a reference does not automatically resolve amount, currency or timing differences.

Key concepts

Compare source amount, settled amount, fees and currency independently. Keep unresolved exceptions visible.

Implementation considerations

No provider data is read here. A future reconciliation process should preserve evidence and require authorized review before recording a reconciled state.

Illustrative data model

This local fixture shows a possible representation for the concepts above. It is not an endpoint response, production configuration or a claim that the described capability is implemented.

JSON fixture
Fictional concept fixture
{
  "reference_only": true,
  "topic": "Payment Reconciliation",
  "reimbursement_id": "reimb_example_123",
  "transaction_id": "txn_example_123",
  "amount_minor": 12550,
  "currency": "USD",
  "reconciliation_status": "review_required"
}

Design review checklist

  • Document which organization owns the payment reconciliation representation and which actor may view or change it.
  • Test the boundaries of reimbursement id, transaction id, amount minor, currency, reconciliation status using synthetic values, including missing or inconsistent references.
  • Before future implementation, obtain an approved contract and review failure behavior. This documentation does not authorize production activation.

Proposed data types

Illustrative field dictionary
NameTypeDescription
reimbursement_idstringStable fictional reimbursement reference; not a secret and not evidence that a resource exists.
transaction_idstringStable fictional transaction reference; not a secret and not evidence that a resource exists.
amount_minorintegerMonetary amount in the documented currency minor unit; 12550 represents USD 125.50, not USD 12,550.
currencystringUppercase ISO 4217 currency code. Determine its minor-unit exponent before monetary conversion.
reconciliation_statusstringMatching/review state; it does not mean posted, paid or fully reconciled.