Explore everything

DEVELOPER DOCUMENTATION

Integrate seller responsibility and settlement

Use the same customer purchase to reason about item ownership, seller work and commercial balances. Inspect the supplied settlement contracts without treating a route listing as permission to trigger a payout.

Source-derived implementation guide

Supplied contract: OpenAPI 0.1.0. No live API call or financial action has been performed. Generic responses and incomplete payloads are identified as contract dependencies.

Order item

The purchased product, variant and assigned responsibility.

Seller context

The authorised operational scope of each participating seller.

Settlement

The commercial balance and recorded settlement action.

Start from the complete purchase

Read the order and inspect its items. Map each seller responsibility from actual returned identifiers. Do not invent seller fields or assume that every tenant exposes the same marketplace configuration.

Separate seller and operator access

Design the seller integration around its assigned work and the operator integration around the whole purchase. Verify the actual permission model for customer and financial information.

Reconcile the commercial balance

Keep the agreement, commission, refunds and adjustments with the applicable order basis. A gross sales figure does not prove a seller balance is ready for settlement.

Treat settlement as a consequential action

The source names a settle operation. Its request and response contracts are sparse. Obtain the complete deployed action contract, permissions and completion evidence before implementation or testing.

Inspect the matching contracts.

GET /v1/orders/{id}

Get order with items

Declared parameters: id (path). Inspect the downloaded source contract for the exact schema.

GET /v1/settlements

GET /settlements

Declared parameters: No explicit parameters declared in this operation.. Inspect the downloaded source contract for the exact schema.

GET /v1/admin/financial/settlements/status

GET /admin/financial/settlements/status

Declared parameters: No explicit parameters declared in this operation.. Inspect the downloaded source contract for the exact schema.

POST /v1/settlements/orders/{orderId}/settle

POST /settlements/orders/{orderId}/settle

Declared parameters: No explicit parameters declared in this operation.. Inspect the downloaded source contract for the exact schema.

Download the selected source-derived OpenAPI reference ↗

Open the filterable API reference ↗

Define failure before implementation.

A partially specified write is an implementation dependency. Do not infer idempotency, reversal behaviour, payout timing or recipient scope from an operation name.

Explore Agora

Press Esc to close · Every result opens a dedicated page.

The Agora story

Founder recording with animated product sequences. View the pitch summary and further walkthroughs ↗

Supplied Agora workspace