Know which interface you are evaluating.
Choose an interface for your use case, inspect the selected application contracts and run the downloadable synthetic integration kit.
Four distinct surfaces
An existing HTTP route is not automatically a supported partner product. The application-session routes below support Peyeli’s own authorized product journeys. A server-to-server partner contract needs separate authentication, scope, version, support and acceptance decisions before credentials can be shared.
| Surface | Current purpose | Partner boundary |
|---|---|---|
| Public documentation | Read authored guides and synthetic examples without an account. | No record access or execution. |
| Application-session API | Verified user and current organization permissions. | Only an approved tenant/user workflow; no developer keys promised. |
| Provider protocols | Approved adapters, authenticated incoming evidence and consented callbacks. | Program-specific credentials and agreements; no arbitrary caller. |
| Privileged operations | Administration, scheduling, diagnostics and platform governance. | Not a partner integration surface; no default access. |
Selected application contract catalog
Paths use placeholders, not valid tenant or resource identifiers. All examples are read-only documentation. This selected catalog does not authorize a call or enumerate privileged endpoints.
| Method / path | Operation | Success |
|---|---|---|
| GET /api/v1/orgs/{org}/payment-intents | payment.view; scoped list. | 200 { data: IntentView[] } |
| POST /api/v1/orgs/{org}/payment-intents | payment.create; idempotent creation. | 201 IntentView |
| GET /api/v1/orgs/{org}/payment-intents/{pi} | payment.view; scope checked on the record. | 200 IntentView + attempts + receipt |
| POST /api/v1/orgs/{org}/payment-intents/{pi}/attempts | payment.collect; provider capability checks. | 201 { attemptId, providerReference } |
| POST /api/v1/orgs/{org}/payment-intents/{pi}/cancel | payment.cancel; unresolved attempts block cancellation. | 200 IntentView |
| GET /api/v1/orgs/{org}/invoices | invoice.view; status filter. | 200 { data, canCredit } |
| GET /api/v1/orgs/{org}/reconciliation/{day} | exception.view; business-day evidence. | 200 { day, totals, pairs, lastImport } |
| GET /api/v1/orgs/{org}/exports/payments.csv | export.csv; plan entitlement may also apply. | 200 text/csv attachment |
Scope by domain, not the whole route tree.
The source also contains application families for catalog/orders, customers/invoices, expenses/bank files, subscriptions, accounting, consumer planning and approved financial-provider journeys. A partner may only need one. Select records and operations explicitly; the existence of a domain does not establish an external API or production availability.
| Relationship | Likely review scope |
|---|---|
| Enterprise merchant / institution | Orders, invoices, customers, records, authorized exports and branch/user responsibilities. |
| Software / accounting / analytics | Consented records, mapping, read/write distinctions, synchronization and disconnect. |
| Distribution / ecosystem | Audience, onboarding, branding, support handoff and attribution; no fund movement by default. |
| Financial institution / provider | Only the approved collection, settlement, remittance, custody or issuance program. |
| Consumer product integration | User-owned records and specifically consented exchange; no merchant role inheritance. |
Before a supported external integration
The review must approve a precise endpoint set, target environment, authentication mechanism, operation/tenant restrictions, retry and rate limits, schema version and deprecation process. This pack contains no published universal rate limit, official partner SDK, partner OAuth scope catalog, outbound webhook subscription contract or self-service API-key onboarding. A versioned route prefix alone does not provide those guarantees.
Download, run, and inspect the integration kit.
The downloadable evaluation kit contains OpenAPI 3.1 for five selected operations, a chained Postman collection, a JavaScript SDK with TypeScript declarations, and a dependency-free synthetic sandbox. Run node example.mjs for an in-process scenario or node server.mjs for a loopback HTTP server. No account, API key, provider connection or production server is supplied.
The sandbox binds only 127.0.0.1:3061, holds synthetic records in memory, and makes no provider requests. It demonstrates exact integer money strings, idempotent replay/conflict, read/list, attempt submission and cancellation. Submitted attempts stay processing: no financial confirmation, settled balance or receipt is fabricated. This local simulator does not validate production authentication, tenant isolation, durable recovery, financial rails or provider acceptance. Date filters are synthetic UTC, distinct from the documented application predicate.
node example.mjs
# Or start the local HTTP mock, then import partner-postman.json:
node server.mjsThe selected JSON contract snapshot.
Selected request/response schemas and operations. Documentation only; no calls or credentials.
The integration kit.
OpenAPI, Postman, JavaScript SDK with TypeScript declarations and local test server. No providers or real funds.