Developers / API

API-first infrastructure for last-mile payment, verification and release.

Connect orders, carriers, PSPs, payment sessions, release events, returns and reporting through one auditable API layer.

Open API reference Request API key

No funds held by IPAYLicensed PSP processingCarrier-controlled releaseImmutable paid stateFull audit trailAPI-first infrastructureMerchant-owned customer relationshipGDPR-ready · Role-based accessNo funds held by IPAYLicensed PSP processingCarrier-controlled releaseImmutable paid stateFull audit trailAPI-first infrastructureMerchant-owned customer relationshipGDPR-ready · Role-based access

Live API reference

809 endpoints. 46 domains. Auto-generated, always in sync.

Every endpoint lives under api.ipay.global. Most integrations start with orders, payment sessions, webhooks and release events, then expand into carrier orchestration, settlement, returns, reporting and compliance when needed. The machine-readable spec is available as OpenAPI JSON, Swagger UI, ReDoc and Postman collection.

Open API reference OpenAPI JSON Swagger UI Postman

809

Endpoints

Domains

Bearer

Auth

curl -H "Authorization: Bearer $TOKEN" \
https://portal.ipay.global/api/orders

Curated quickstart groups

Start with the flows that matter for your role.

The API is organised into curated groups across merchant onboarding, payment sessions, carrier orchestration, settlement, returns, RBAC and compliance — covering every flow that powers IPAY.

Browse the full reference

Every group, every endpoint, request/response examples, copy as curl / JS / Python — auto-generated from the live OpenAPI spec.

Open API reference

Authentication

API keys, bearer tokens and role-based access.

Orders

Create orders, import bulk orders, fetch order details and start an IPAY payment session.

Payment Sessions

Create and track payment sessions with unique IPAY references, PSP status and full event history.

Release verification

Verify release authorization at the door, pickup point or locker before parcel release.

E-commerce Integrations

Shopify · PrestaShop · WooCommerce · Odoo · Shopware · Magento · BigCommerce · Lightspeed · bol.com.

Carrier Tariffs & Cost Engine

Multi-carrier tariff and cost database for shipping and release flows.

Carrier Invoice Reconciliation

Auto-match invoices vs shipped orders; flag MISMATCH / UNMATCHED.

Quote Engine (Offers)

Branded customer quotes with full cost+margin breakdown.

Auto-sync Scheduler

Recurring sync for every CONNECTED merchant integration.

Real-time event stream (SSE)

Server-sent events for live operator dashboards.

Smart Returns

Create return flows, capture return reasons, trigger labels or QR codes and track retention outcomes.

Carrier Statements & Aging

Reconciliation → PDF statement → emailed via transactional mail.

Settlement (Merchant Portal)

Fixed-fee IPAY commercial model · PDF + accountant export.

CRM & onboarding sync

Sync merchant, partner and onboarding status with CRM and operational workflows.

RBAC — roles & permissions

Resources × actions × data scopes, multi-role per user.

Internal Controls & Compliance

Daily controls, CFO approval, automated digest.

Localization

Manage translated payment, notification and support flows across markets.

Accounting & finance exports

Export settlement, fee, accrual and reconciliation data to accounting systems.

Marketplace integrations

15+ providers — Lazada · TikTok · Amazon · Shopee · Temu · AliExpress · Vinted.

Consumer app flows

Pay-on-arrival, parcel tracking, pickup instructions and return flows.

Inbound webhooks

Providers → IPAY (HMAC-signed where supported).

Outbound webhooks

IPAY → merchant — real-time event push.

Webhook events

Build event-driven workflows.

IPAY pushes signed webhook events for every state change in the payment, carrier and release flow. Idempotent event IDs, HMAC signature, automatic retries with exponential backoff.

order.created
payment.requested
payment.confirmed
carrier.out_for_delivery
release.authorized
parcel.released
return.initiated
return.received
refund.created
retention.offer.accepted
settlement.created

webhook · release.authorized

{
  "event": "release.authorized",
  "order_id": "ord_8FQ4d2a",
  "merchant": "acme-shop",
  "carrier": "ups",
  "payment": {
    "psp": "adyen",
    "status": "confirmed",
    "amount": 78.40,
    "currency": "EUR"
  },
  "release": {
    "authorized_at": "2026-05-29T09:14:22Z",
    "method": "carrier_release"
  }
}

REST API · Webhooks · Sandbox · Role-based access · Audit trail · Idempotent event handling.

Live

Interactive API reference

api.ipay.global / reference

Try every endpoint, inspect request and response shapes, copy code snippets in curl / JS / Python.

Open API reference

Sandbox

portal.ipay.global / sandbox

Test merchant, carrier and PSP flows before go-live. Mock PSPs, simulate carrier scans, replay webhooks.

Live API

portal.ipay.global / api

Production endpoints for orders, payments, release, returns and settlement. SLA-backed, HMAC-signed webhooks.

The endpoints, schemas and sandbox shown here are powered by the live Core IPAY platform. Every API call is processed by the same infrastructure that handles real merchant orders, carrier releases and PSP settlements in production.

Open Core IPAY portal →

Build with IPAY.

Get an API key, spin up the sandbox and ship Pay On Arrival inside your platform.

Open API reference Request Sandbox Request API key