canonical: https://jentic.com/apis/speca.io/speca

# Speca GoPay REST API

GoPay payment gateway REST API for creating and managing payments, recurring payments, preauthorized payments, and account statements. The API exposes 10 endpoints secured with basic, bearer authentication.

## For AI agents

Programmatically create access token, create a standard payment. Covers 10 operations with basic, bearer authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Create access token
- Get payment status
- Refund a payment
- Cancel recurring payment
- Capture preauthorized payment

## Use cases

### Payments Operations

Use the GoPay REST API to perform payments operations programmatically. The API provides 10 endpoints covering core functionality including create access token, create a standard payment, get payment status.

Example prompt: Call POST `/api/oauth2/token` to create access token

### Automated Authentication Management

Automate authentication operations by combining multiple GoPay REST API endpoints. Agents can create a standard payment and then get payment status in a single workflow.

Example prompt: Call POST `/api/payments/payment` to create a standard payment, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call GoPay REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic, bearer tokens manually.

Example prompt: Search Jentic for 'create access token', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/oauth2/token` | Create access token |
| POST | `/api/payments/payment` | Create a standard payment |
| GET | `/api/payments/payment/{id}` | Get payment status |
| POST | `/api/payments/payment/{id}/refund` | Refund a payment |
| POST | `/api/payments/payment/{id}/create-recurrence` | Create recurring payment on demand |
| POST | `/api/payments/payment/{id}/void-recurrence` | Cancel recurring payment |
| POST | `/api/payments/payment/{id}/capture` | Capture preauthorized payment |
| POST | `/api/payments/payment/{id}/void-authorization` | Void preauthorized payment |

## Key resources

- **Authentication** — OAuth2 token management
- **Payments** — Payment creation, status, and refund operations
- **RecurringPayments** — Recurring payment operations
- **PreauthorizedPayments** — Preauthorized payment capture and void operations
- **PaymentMethods** — Available payment instruments

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 61 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 87 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 94 / 100
  - Security: 35 / 100
  - AI Discoverability: 76 / 100
- **View full report:** https://jentic.com/apis/speca.io/speca/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring GoPay by hand means running its OAuth2 token flow, carrying the bearer token alongside basic auth, and choosing the production or sandbox gateway host yourself. Through Jentic you install once, import the GoPay REST API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** GoPay puts the payment id in the URL path (`/api/payments/payment/{id}/...`), so a rule can pin your agent to one payment: it can read status or capture that payment and nothing else. You choose the operations it may call, so ones like refund or void-authorization are not included unless you add them.
- **Credential handling:** Your GoPay credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a payment' or 'check a payment status', and Jentic returns the matching GoPay operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the GoPay REST API use?

The GoPay REST API uses basic, bearer authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create access token with the GoPay REST API?

Yes. Use the POST `/api/oauth2/token` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the GoPay REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create access token through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create access token'. Jentic returns the matching GoPay REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the GoPay REST API have?

The GoPay REST API exposes 10 endpoints covering authentication, payments, recurringpayments operations.

### Can I limit what my agent is allowed to do with the GoPay REST API?

Yes. Jentic One is self-hosted, so your own rules decide which GoPay operations and credentials the agent may use. Because GoPay puts the payment id in the URL path (`/api/payments/payment/{id}/...`), a rule can pin the agent to a single payment so it can only read status or capture that one and nothing else. You choose the operations it may call, so sensitive ones like refund or void-authorization stay off limits unless you explicitly add them.