Lift Developer Portal

Integrator Walkthrough

Step through the same calls a real 3rd-party enrollment site would make against Production APIM — your subscription key stays in your browser and never touches our servers.

  1. 0 Key
  2. 1 Template
  3. 2 Schema
  4. 3 Onboard
  5. 4 Status

Subscription Key

Paste the APIM subscription key you received from support@postmerchant.com. We'll validate it with a quick GET /Templates call.

Pick a Template

Templates define which fields a merchant will fill out. Pick one to see its schema and then onboard a merchant against it.

Loading templates…

Review the Schema

These are the fields a merchant will see when they fill out their merchant application online — marked Required, Optional, or . You can pass any of these fields along to prepopulate the application before you email or request a merchant link, so the merchant doesn't have to re-enter information you've already collected.

Note: this is the contract for the MERCHANT'S online form. The POST /Applications/Onboard call you'll make next has a much smaller required minimum — just enough to create the application and generate the link. Anything in this schema that you DON'T pass to Onboard becomes the merchant's job to fill in. Pass more → less work for the merchant.

Loading schema…

Onboard a Merchant

Pre-populated with sample data for Acme Coffee Co. Edit anything you want before submitting — this hits the real API.

Two-tier validation: the full Lead (contact + business info) is required so the lead is actionable on its own. Owner, Address, and Items are Optional prefill — anything you pass reduces what the merchant has to fill in when they open the link.

Application Required
Lead / Business All required
Primary Owner Optional prefill
Business Address Optional prefill
Application Items (sample) Optional prefill

Canonical ItemName values shown below. Full reference at GET /api/v1/Reference/ApplicationItems (or in the API Reference under the Reference group).

Status Polling

Poll GET /Applications/{id}/Status until the application reaches a terminal state (APPROVED, AUTO_APPROVED, or DECLINED). The demo polls every 10 seconds; stop or manually poll with the buttons below.

Application:
Current status:
Polls: 0 · last at