Skip to main content
Use the PayPathIQ inbound API to send posted obligations from your accounting source, including those not yet due. You can create and update Customers and Receivables, and report Payments, refunds, and reversals received outside PayPathIQ as Payment observations. Unsure of a term? See the glossary.
Before you start, you need:
  1. A PayPathIQ login with API access, to create a sandbox key. See Get a sandbox key.
  2. Your clientCode, shown next to the Client name when you create the key.
  3. A shell with curl, or Node.js or Python, to send requests.
Start with synthetic sandbox data, and check Certification and capabilities for what has been proven on which build. Production ingestion, recovery and payment-provider activation require their existing independent approvals. Each accepted request is validated, saved, and applied to PayPathIQ’s records before the API returns success. If that update cannot be completed safely, the request fails with a structured error. Your Integration can update only the facts supplied by your source system.

Complete the sandbox quickstart

Send a Customer, Receivable, Payment observation, and lifecycle command.

Get a sandbox key

Create a sandbox API key in PayPathIQ under Settings → API access.

Download the OpenAPI file

The OpenAPI 3.1 contract as JSON, ready for your API tooling.

Understand the model

Learn how Customers, Contacts, Receivables, and Payment observations relate to your source records.

​
What this API supports

This is the /v1 baseline. It supports credit_union.v1 and property_management.v1, and describes only capabilities that are implemented. Deployment, partner certification, payment-provider activation and recovery activation are separate approvals. Importing a balance never grants recovery permission. See Versioning and deprecation for how this baseline changes after launch. A GET does not return PayPathIQ’s combined operational record or staff corrections. Keep a mapping of your source records to the opaque external IDs you supply. See the credit-union walkthrough for a worked mapping and reconciliation flow.

​
V1 at a glance

  • One record per synchronous request, or a bounded asynchronous batch; no endpoint lists every record. Use the change feed to find what changed.
  • Stable, non-sensitive external IDs in URLs.
  • Full replacement with PUT; partial changes with JSON Merge Patch.
  • An Integration API key identifies your Integration. Current server-side grants authorize its access to an approved Client and Portfolio, with specific permissions.
  • Both launch profiles use explicit financial types, source revisions and EUR amounts. Arbitrary custom fields and other industries are not supported.
The OpenAPI 3.1 JSON defines the supported endpoints, request fields, and responses. The live API also serves its contract at /v1/openapi.json without an API key.

​
Import into Postman or Insomnia

Both tools import an OpenAPI file by URL. PayPathIQ does not publish a ready-made Postman collection or Insomnia workspace.
  1. Copy the OpenAPI URL: https://docs.paypathiq.com/generated/inbound-api-v1.openapi.json.
  2. In Postman, choose Import and paste the URL. In Insomnia, choose Import and then From URL, and paste the URL.
  3. Set the server to https://api.sandbox.paypathiq.com.
  4. Add your sandbox key as a Bearer token, and set clientCode to your Client code.

​
Support

Email help@paypathiq.com about a failed request. Include its X-Request-Id if the response has one. Never send an API key or a full personal-data payload.