canonical: https://jentic.com/apis/ecommpay.com/ecommpay # ECOMMPAY API ECOMMPAY is a payments orchestration platform offering acquiring and alternative payment methods for merchants across Europe and Asia. The exposed OpenAPI spec covers the access-token exchange and a small resources surface used to list and retrieve account-level resource records. Merchants integrate the broader ECOMMPAY platform through dashboards and channel-specific endpoints; this spec gives agents a programmatic foothold for token issuance and resource lookup. ## For AI agents Exchange an ECOMMPAY API key for an access token and list or retrieve account resources via three REST endpoints. ## Scope Does not handle payment capture, refunds, or transaction lookups - use for ECOMMPAY API key to access-token exchange and merchant resource lookup only. ## Capabilities - Exchange an ECOMMPAY API key for a short-lived access token via the auth endpoint - List account resources available to the authenticated merchant - Retrieve a single resource record by its ECOMMPAY resource ID - Drive token rotation in scripted environments where API keys must rotate frequently - Power read-only inventories of merchant configuration as part of a wider payment integration ## Use cases ### Access Token Bootstrap for ECOMMPAY Calls Merchants authenticate against ECOMMPAY by exchanging an X-API-Key for an access token via POST `/auth/token.` Agents that intend to call other ECOMMPAY surfaces start every session with this exchange, store the token, and reuse it for subsequent calls until it expires. The flow is the entry point to all programmatic interaction in this spec. Example prompt: POST `/auth/token` with the merchant's X-API-Key and store the returned access token for subsequent requests. ### Merchant Resource Inventory Operations teams sometimes need an inventory of every resource record configured on a merchant account. GET /resources returns the list and GET `/resources/{id}` returns the detail for a single entry. Agents can run this on a schedule and flag changes between runs. Example prompt: After token exchange, GET /resources, then GET `/resources/{id}` for each ID returned, and persist the snapshot for diffing. ### Scripted Token Rotation Compliance regimes often require API keys and tokens to rotate on a fixed schedule. Because POST `/auth/token` is the only route for issuing access tokens here, a scheduled job can rotate the API key in the merchant dashboard and immediately call the auth endpoint with the new key to confirm the rotation works before traffic switches over. Example prompt: Rotate the X-API-Key in the dashboard, POST `/auth/token` with the new key, and abort the rotation if the call fails. ### AI Agent Payment Orchestration Bootstrap An AI agent operating across multiple payment providers can use Jentic to discover the ECOMMPAY auth and resource endpoints as the first step of an orchestration workflow. The agent obtains an access token, inventories merchant resources, and then hands off to provider-specific payment surfaces, all without a custom integration. Example prompt: Through Jentic, search 'get ecommpay access token', execute POST `/auth/token`, then call GET /resources for the merchant inventory. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/auth/token` | Exchange an X-API-Key for an access token | | GET | `/resources` | List account resources | | GET | `/resources/{id}` | Retrieve a resource by ID | ## Key resources - **Authentication** — Exchange an X-API-Key for a short-lived access token - **Resources** — List and retrieve account-level resource records ## Why Jentic - **Setup:** Wiring the ECOMMPAY API by hand means managing its X-API-Key header, exchanging the key for an access token, and pointing requests at the api.ecommpay.com host. Through Jentic you install once, import the ECOMMPAY API from the API Directory, store the X-API-Key once, and your agent calls it. - **Permission scoping:** One operation puts the resource id in the URL path (`/resources/{id}`), so a rule can pin your agent to reading one resource. You choose the operations it may call, so you can allow the token exchange and resource reads while nothing beyond those is included unless you add it. - **Credential handling:** Your ECOMMPAY X-API-Key is stored once, encrypted, by your own Jentic One instance and injected as the request header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'get an ECOMMPAY access token' or 'list ECOMMPAY resources', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Square API** — Full payment processing platform with broader endpoint coverage than the ECOMMPAY spec - **Ecwid API** — E-commerce storefront API that pairs with ECOMMPAY's payment orchestration - **Shopify Admin API** — Storefront and payments together for merchants on Shopify ## FAQ ### What authentication does the ECOMMPAY API use? The ECOMMPAY API uses an API key passed in the X-API-Key header (the ApiKeyAuth scheme), exchanged via POST `/auth/token` for an access token. Through Jentic, the X-API-Key is stored encrypted in your Jentic One instance and injected at call time. ### How do I get an access token from the ECOMMPAY API? Call POST `/auth/token` with your X-API-Key in the header. The response returns an access token that you then use for the resources endpoints. ### What are the rate limits for the ECOMMPAY API? The OpenAPI spec does not publish rate limits. ECOMMPAY applies platform-level fair-use throttling on its API gateway; production traffic should pace token-exchange calls and reuse tokens until they expire rather than re-issuing per request. ### How do I list ECOMMPAY merchant resources through Jentic? Search 'list ecommpay resources' in Jentic, load the GET /resources schema, execute, and Jentic returns the resource list. For a specific entry, follow up with GET `/resources/{id}.` ### Does this ECOMMPAY API spec cover payment processing endpoints? No. The current spec exposes only authentication and resource lookup. Payment processing on ECOMMPAY uses channel-specific endpoints documented separately at developers.ecommpay.com. ### Can I limit what my agent is allowed to do with the ECOMMPAY API? Yes. Because you run Jentic One yourself, your own rules decide which of the ECOMMPAY operations the agent may call, so you can allow the token exchange (POST `/auth/token`) and resource reads (GET /resources and GET `/resources/{id}`) while nothing else is available unless you add it. Since the single-resource read puts the resource ID in the URL path (`/resources/{id}`), a rule can pin the agent to reading one specific resource. The encrypted X-API-Key is held by your own instance and injected at call time, so the agent never handles the credential directly.