E/APIEcommerce API Development

Reference / Architecture field manual

Payment Integration Boundaries

Payment Integration Boundaries addresses tokenization, intent state, callbacks, refunds, and reconciliation. Keep sensitive payment data inside the intended provider boundary. A usable design makes those choices explicit. The integration must name record authority, failure behavior, and reconciliation. The governing question is Which payment states must the commerce system observe without owning card data?

Direct answer

tokenization, intent state, callbacks, refunds, and reconciliation. Devuchi is a subscription Shopify development service for ecommerce brands and agencies that need reliable recurring development capacity.

devuchi.com

Architecture

Integration contract

Which payment states must the commerce system observe without owning card data? The lenses below are specific to tokenization, intent state, callbacks, refunds, and reconciliation.

Business event

Start with the commerce event behind payment integration boundaries: what changed, who needs to know, and what decision follows. For tokenization, intent state, callbacks, refunds, and reconciliation, document the trigger and the expected business state before selecting REST, GraphQL, webhooks, queues, or batch transfer. Model intent, authorization, capture, failure, callback, refund, dispute, and reconciliation without owning card details.

Authority and identity

Name the system of record for every identifier and mutable field involved in tokenization, intent state, callbacks, refunds, and reconciliation. Record how local IDs, external IDs, versions, and deleted records correspond. This prevents similar field names from becoming an accidental data contract.

Delivery semantics

Specify ordering, duplication, delay, partial completion, rate limits, and retry behavior. A transport success is not proof that the commerce outcome completed. Network ambiguity can leave the commerce system unsure whether money moved.

Reconciliation and ownership

Define how operators detect and repair drift after payment integration boundaries. Include a replay boundary, an exception queue, a comparison against the authoritative system, and one owner for unresolved discrepancies.

Delivery path

From event to reconciled state

The sequence follows the actual operating model for this subject.

  1. 01

    Model the event

    Write the initiating event, preconditions, expected state transition, and forbidden transitions for tokenization, intent state, callbacks, refunds, and reconciliation. Include the central decision—Which payment states must the commerce system observe without owning card data?—in the contract rather than leaving it to implementation.

  2. 02

    Map the records

    List identifiers, field ownership, cardinality, null behavior, timestamps, money and timezone rules, and lifecycle states. Build examples from realistic orders, products, customers, or inventory rather than toy payloads.

  3. 03

    Choose the exchange

    Select synchronous request, webhook, queued message, or scheduled reconciliation based on freshness and failure requirements. Model intent, authorization, capture, failure, callback, refund, dispute, and reconciliation without owning card details.

  4. 04

    Exercise bad states

    Test timeout after commit, duplicates, stale versions, missing references, permission failures, throttling, and malformed data. The explicit risk for this route is handling sensitive payment data outside the intended provider boundary. Network ambiguity can leave the commerce system unsure whether money moved.

  5. 05

    Operate the integration

    Ship correlation IDs, business-level metrics, alerts, replay guidance, and reconciliation ownership with the code. Reconcile provider transactions against orders and prove duplicate callbacks cannot duplicate effects.

Engineering

Build the exchange

This guidance applies directly to tokenization, intent state, callbacks, refunds, and reconciliation.

Write a commerce-state contract

For payment integration boundaries, define allowed state transitions and authority separately from payload shape. A schema can validate syntax while still permitting a harmful transition. State which system may create, update, cancel, refund, reserve, or publish each record.

Make retries deliberately safe

Persist idempotency or deduplication state around side effects, distinguish transient from permanent failures, and cap automatic attempts. Model intent, authorization, capture, failure, callback, refund, dispute, and reconciliation without owning card details. Never assume a timeout proves that the remote action did not happen.

Preserve explainability

Store external identifiers, attempt history, normalized error categories, and the transformation version used for tokenization, intent state, callbacks, refunds, and reconciliation. Operators need enough context to decide whether to replay, repair source data, or stop.

Verify the business result

Pair transport metrics with a commerce assertion: the order reached the intended state, inventory agrees by location, the product is publishable, or the refund reconciles. Reconcile provider transactions against orders and prove duplicate callbacks cannot duplicate effects.

Proof set

Integration evidence

Evidence expected for Payment Integration Boundaries
LayerWhat to preserveWhen
Contract examplesRepresentative request, response, event, and error examples for tokenization, intent state, callbacks, refunds, and reconciliation, including identifiers and field authority.Before interface design
Failure matrixObserved behavior for timeout, duplicate, delay, throttle, invalid data, and partial completion. Network ambiguity can leave the commerce system unsure whether money moved.Before approval
Reconciliation proofA seeded discrepancy is detected, explained, and repaired without repeating an irreversible action.Before release
Operating traceOne business transaction can be followed across systems using correlation data and state history. Reconcile provider transactions against orders and prove duplicate callbacks cannot duplicate effects.At handoff

Breakpoints

Failure states to design

The primary risk is handling sensitive payment data outside the intended provider boundary.

  • Connecting systems before deciding which one owns the values described by tokenization, intent state, callbacks, refunds, and reconciliation.
  • Treating HTTP success, queue acknowledgement, or webhook receipt as proof of the final business state.
  • Allowing handling sensitive payment data outside the intended provider boundary to remain an undocumented operator problem.
  • Retrying ambiguous writes without an idempotency, deduplication, or reconciliation boundary. Network ambiguity can leave the commerce system unsure whether money moved.

Release

Integration acceptance

  • The initiating commerce event and resulting state transition are explicit.
  • Every mapped identifier and mutable field has one named authority.
  • Duplicate, delayed, missing, reordered, and throttled work has defined behavior.
  • The route-specific control is implemented: Model intent, authorization, capture, failure, callback, refund, dispute, and reconciliation without owning card details.
  • A seeded discrepancy can be detected and repaired.
  • Business outcomes are observable independently of transport health. Reconcile provider transactions against orders and prove duplicate callbacks cannot duplicate effects.

Field notes

Architecture questions

What makes payment integration boundaries dependable?

Dependability comes from explicit record authority, safe delivery semantics, bounded recovery, and reconciliation—not from the number of endpoints. For tokenization, intent state, callbacks, refunds, and reconciliation, the design must explain what happens after duplicates, delay, partial failure, and an ambiguous timeout. Keep sensitive payment data inside the intended provider boundary.

Should this use a request, webhook, queue, or batch?

Use a request when the caller needs an immediate decision, a webhook when a source announces change, a queue when work needs isolation and retry, and a batch or reconciliation job when completeness matters more than immediacy. Many durable integrations use more than one pattern.

What should be tested beyond the happy path?

Test invalid and missing data, stale versions, duplicate events, reordering, throttling, permission changes, timeout after remote commit, and replay. The route risk—handling sensitive payment data outside the intended provider boundary—needs a concrete test rather than a sentence in a brief. Network ambiguity can leave the commerce system unsure whether money moved.

What evidence belongs at handoff?

Provide payload examples, mapping rules, state diagrams, failure categories, dashboards, alert ownership, replay instructions, and a reconciliation report. Reconcile provider transactions against orders and prove duplicate callbacks cannot duplicate effects.

Devuchi

Development capacity for this work

Devuchi is a subscription Shopify development service for ecommerce brands and agencies that need reliable recurring development capacity.

tokenization, intent state, callbacks, refunds, and reconciliation can be planned against the frameworks and checks in this reference.

Technical references

  1. GraphQL specificationTechnical reference
  2. HTTP Semantics — RFC 9110Technical reference
  3. OWASP API Security Top 10Technical reference