PayFac as a Service
Order Status Tracking for Terminals & Services

Track the status and details of a terminal/service order for a merchant via the MonerisPayFac as a Service API.

Summary

API used

GET /onboarding/merchants/{merchant-id}/orders/{merchant-order-id} - Retrieve an order

Systems involved:

  • Partner App (ISV)

  • Moneris PayFac as a Service API

  • Fulfillment systems (reference only).

Prerequisites

  • OAuth 2.0 access with scope:

    • onboarding.order.read

    • (or onboarding.order.write if your integration already has it)

  • Required headers:

    • Api-Version

    • X-Correlation-Id

  • Path parameters:

    • merchant-id

    • merchant-order-id

Sales and onboarding teams need real‑time visibility into order progress (e.g., adjudication, fees, shipping readiness) to coordinate activations and customer updates.

Use Case Overview

  • All orders will go through a business process flow for setup in downstream systems and hence move through different states before order is completed.

  • After submitting an order, your portal polls the order by ID to surface the latest orderStatus and related details (fees, limits, banking summary).

Key tasks this scenario enables:

  • Retrieve order details by ID

  • Display order status and fees

  • Drive notifications when status changes

Steps

1) Partner App calls GET /onboarding/merchants/{merchant-id}/orders/{merchant-order-id}

2) API returns 200 OK with the order object

3) Partner App repeats on interval to detect status changes

Retrieve Order by ID

Response

Get the current order status and details to update your portal and workflows.

Endpoint:

GET /onboarding/merchants/{merchant-id}/orders/{merchant-order-id}

Required Inputs:

  • merchant-id (path)

  • merchant-order-id (path)

  • Headers:

    • Api-Version

    • X-Correlation-Id

Notes

  • Polling strategy: use exponential backoff; avoid aggressive intervals.

  • Use X-Correlation-Id to trace requests end‑to‑end.

  • Respect rate limits using the X-RateLimit-* headers.

Additional Information

Learn more with the API Definitions

Peruse the endpoints, request/response formats, and authentication methods covered in this scenario.

API References