Version: 1.0.0

Order API

Overview

The Order API enables merchants to create, retrieve, exercise (process payments), and delete orders within the Merchant Hub. Orders represent payment requests that can be configured for single or split payments across multiple transactions.

Key Capabilities

• Create orders with specified payment parameters and cart items
• Retrieve order details and validate payment eligibility before presenting a payment form
• Exercise orders to process payments using supported payment instruments
• Delete orders when no longer needed
• Support for multiple payment instruments including PAN, Apple Pay, Google Pay, Click to Pay, and more
• Flexible payment distribution: single payment or split across multiple transactions

API Endpoints

• Create Order — Create a new order with payment parameters and items
• Retrieve Order — Retrieve an order by ID for validation or display
• Exercise Order — Process a payment for an existing order
• Delete Order — Delete an order by ID

Contact

Connected Payments: [email protected]