Explore everything

DEVELOPER DOCUMENTATION

Integrate refunds and reconciliation

Keep order value, payment outcome, refund and settlement distinct. This guide connects the merchant workflow to source-listed routes; it does not execute payment requests or assert provider-wide behaviour.

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

The commercial purchase and its item-level quantities.

Refund action

The requested reversal in the configured payment workflow.

Reporting scope

The definition and period used to interpret financial totals.

Identify the original transaction

Read the order and identify the payment and refund relationship using the actual environment response. Keep the purchased quantities and any partial fulfillment in the picture.

Choose the applicable refund path

The source lists order and return refund routes. Confirm which action is appropriate for your configured business process and payment provider. A return request is not automatically a completed refund.

Inspect the action result before retrying

Do not assume a timeout means a financial action failed. Establish the recorded outcome and the provider result using the actual contract and operational tools.

Reconcile equivalent measures

Compare the same period, currency and financial definition. Review processing fees, partial refunds and settlement timing before interpreting a difference as missing funds.

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.

POST /v1/admin/orders/{id}/refund

POST /admin/orders/{id}/refund

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

POST /v1/admin/returns/{id}/refund

POST /admin/returns/{id}/refund

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

GET /v1/admin/analytics/commerce/refunds

GET /admin/analytics/commerce/refunds

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.

The supplied routes do not establish universal signature rules, retry guarantees or provider availability. Obtain the exact callback, authentication and action contract for the deployed provider before building the live integration.

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