PayFac as a Service
Partner Bank Order Submission

Submit a Partner Bank order (delivery address, banker info, solutions) for a merchant, using the Terminal & Service Orders APIs.

Summary

APIs used

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

Prerequisites

  • OAuth2 scope: onboarding.order.write (and optionally onboarding.order.read for retrieval)

  • Headers required on all calls:

    • Api-Version

    • X-Correlation-ID

  • Path parameter: merchant-id

Partner banks can create orders programmatically with banker‑specific fields and delivery details, reducing manual coordination and speeding time‑to‑ship.

Use Case Overview

  • Submit a Partner Bank order for a merchant via the CreatePartnerBankOrderPayload example.

  • Systems involved:

    • Partner App

    • Moneris PayFac as a Service API

    • Fulfillment/Ops (reference).

  • API area powering this scenario:

    • Terminal & Service Orders
      POST /onboarding/merchants/{merchant-id}/orders.

Key tasks this scenario enables:

  • Create Partner Bank orders with delivery and banker details

  • Receive a 201 Created order payload including fees, promotions, and supplies

  • (Optional) Retrieve the order by ID for status display

1. Create Partner Bank Order (POST)

Create a new order for a merchant using the Partner Bank payload which includes banker branch details, delivery address, and solutions.

Endpoint:

POST /onboarding/merchants/{merchant-id}/orders

Content Type:

application/json

 Required Inputs:

  • merchant-id (path)

  • Request body must match CreatePartnerBankOrderPayload

  • - Headers:

    • Api-Version

    • X-Correlation-Id

Response

Request

2. (Optional): Retrieve Order by ID (GET)

Fetch the order to display current status and details in your portal.

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

Response

Notes

  • All monetary amounts are in cents.

  • Use idempotencyKey on create to prevent duplicate orders (where applicable).

  • Respect rate limits via 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