Order Guard API Documentation
Welcome to the Order Guard API documentation. Our API allows you to seamlessly integrate delivery protection into your system, providing your customers with peace of mind when placing orders.
This documentation covers everything you need to get started, including authentication, available endpoints, request and response formats, and example use cases.
Available Routes
- Get Estimate - Estimate the price of Order Guard coverage for an order.
- Log Purchase Intention - Log a customer's intention to purchase Order Guard order protection for their order.
- Initiate Policy - Initiate an Order Guard coverage policy for an order.
- Get Billable Amount - Invoice Accounts ONLY - Retrieve the amount your organization owes Order Guard for policies bought in a particular period.
Authentication
Requests made to our API must include an API key to be considered authorized. You'll include your API key in the request headers like this:
x-api-key: YOUR_API_KEYPlease ask your account representative for your API Key, or you can log in and request access in the partner dashboard.
Secret Key - For Vault Integrations
If you integrate using our Tokenization Vault method, you will be provided an additional secret key that you'll include in the headers for your Initiate Policy requests.
x-pcivault-capture-secret: YOUR_VAULT_SECRETGetting Started
You can integrate with Order Guard's API and allow your customers to purchase delivery protection in one of three ways. All 3 methods are PCI-compliant.
- Tokenization Vault (Recommended)
- Stripe Connect (Must have a Stripe Account)
- Partner Revenue Settlement
Tokenization Vault (Recommended)
Overview
Send shopper's credit card details, and amount they are to be charged, to our intermediary - PCI Vault. We'll then receive a token that we can use to charge the customer.
Steps
- Collect the shopper's payment data via your existing form, and charge them for your service.
- POST the amount we should charge them for order protection, and their PAN details (e.g. card_holder, card_number, card_expiry), to our PCI intermediary's "capture" endpoint:
https://api.pcivault.io/v1/capture/YOUR_ENDPOINT_ID - Order Guard receives a callback from the intermediary that contains a token. We use this to charge the customer our fee by passing the token to our payment provider, via the intermediary.
Details about the request and response format for this endpoint can be explored on the Initiate Policy page.
Stripe Connect
Overview
Collect payment via Stripe integration, and pass these details to Order Guard via Stripe Connect so we can charge the shopper our fee
Steps
- Connect with us on Stripe
- You'll need a Stripe account to use this method.
- Connect your Stripe account to Order Guard's, via Stripe Connect. This is a one-time setup step.
- Collect Payment
- Use Stripe Elements (e.g., CardElement) in checkout flow.
- Customer enters their card once.
- Stripe creates a card token (PaymentMethod)
- Token is created on the platform account (Order Guard's Stripe platform account).
- This token can then be attached to:
- Your Stripe account, to charge for the order.
- Order Guard's Stripe account, to charge for the protection fee.
- Two separate charges are made:
- Partner charges the main order via their Stripe account.
- Order Guard charges the protection fee as its own merchant of record, using the same tokenized payment method.
Partner Revenue Settlement
Overview
You charge the shopper for your product as well as our fee and we settle up later. This process gives you the most total control over the customer relationship.
Steps
- Collect full payment, including the Order Guard fee, upfront.
- We then streamline your accounting by sending a periodic statement that automatically deducts your revenue share from the total fees collected, displaying balance due/owed.
- This can be reconciled using the Get Billable Amount route
Demo Site
To see Order Guard in action, you can view our demo restaurant site that showcases the integration:
Demo URL: demo.orderguard.com
What you'll see:
- Delivery Menu: Browse a sample restaurant menu with Order Guard coverage options
- Checkout Process: Experience how Order Guard integrates seamlessly into the checkout flow
- Coverage Options: See how customers can opt-in to Order Guard protection for their orders
- Thank You Page: View confirmation of coverage activation after order completion