Skip to content

Payment Completion — Proposed Guide

Planned API — Reference Only

Payment Completion: Completion requires a defined evidence source, such as a verified provider settlement notification. It should not be inferred from…

Overview

Completion requires a defined evidence source, such as a verified provider settlement notification. It should not be inferred from queue placement or an HTTP 200 response.

Key concepts

Store completion time, reference and the settlement interpretation used. Preserve later correction or return events.

Implementation considerations

The example status is a fictional fixture. No completion event, settlement guarantee or rail-specific finality is asserted.

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 Completion",
  "transaction_id": "txn_example_123",
  "reimbursement_id": "reimb_example_123",
  "completed_at": "2026-01-15T12:00:00Z",
  "provider_reference": "provider_example_123"
}

Design review checklist

  • Document which organization owns the payment completion representation and which actor may view or change it.
  • Test the boundaries of transaction id, reimbursement id, completed at, provider reference 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
transaction_idstringStable fictional transaction reference; not a secret and not evidence that a resource exists.
reimbursement_idstringStable fictional reimbursement reference; not a secret and not evidence that a resource exists.
completed_atstring (date-time)Synthetic UTC timestamp. Business occurrence time may differ from delivery or processing time.
provider_referencestringFictional provider correlation reference, not settlement evidence.