Your order, receivable, reservation or other durable commercial reference.
Developer guide
A payment is a lifecycle, not a single API call.
Keep the business reference, payment decision, provider execution and financial outcome connected as one traceable operation — from initial context through authentication, status changes, cancellation or refund.
01Prepare
02Simulate
03Execute
04Authenticate
05Observe
06Adjust
Integration boundary
Stable identity across the lifecycle
The integration starts from a business-owned reference and produces a durable transaction identity that can remain connected to provider execution and later financial state. This separates the commercial obligation from any single provider request.
A platform-level identity used to follow the operation as provider and channel state changes.
Authorization, authentication and execution results remain attached to the transaction context.
Later cancellation, refund, settlement or reconciliation activity can continue from the same lifecycle.
Proven pattern
Preview before execution
A decision step can evaluate transaction context before money moves. The proven pattern is to separate eligibility and route selection from execution, making it possible to reason about the path and expected economics before committing the transaction.
- Use amount, currency, customer or account context and commercial rules to shape eligibility.
- Evaluate an eligible provider or execution path before the final payment call.
- Keep expected economics and provider choice explainable as part of the decision context.
- Execute only after the application has the decision it needs.
Conceptual object model — not a current API schema
{
"reference": "your-business-reference",
"payment_context": {
"amount": "...",
"currency": "...",
"channel": "..."
},
"transaction": {
"id": "durable-transaction-id",
"state": "..."
},
"decision": {
"eligible_path": "...",
"expected_economics": "..."
}
}Implementation model
Lifecycle operations
These patterns describe integration behavior proven in production systems. They define the technical model, not a promise that the current Zopio API will expose any specific endpoint name, field name or contract shape.
Prepare
Collect the commercial and payment context needed to shape an eligible experience.
Simulate
Evaluate the eligible path and expected economics before execution.
Execute
Initiate the payment through the selected connected path.
Authenticate
Complete provider-required customer authentication when the flow requires it.
Observe
Use status changes, events and state queries to understand the current outcome.
Adjust
Continue the lifecycle through completion, cancellation, refund or another permitted follow-up action.
Continue exploring
Discuss your integration