canonical: https://jentic.com/apis/secpaid.com/secpaid

# SecPaid Interative API

The SecPaid API allows developers to create secure payment links (Link To Pay), manage payment transactions, and process payments seamlessly. Utilize this API to integrate payment functionalities into your applications, enabling users to handle payments efficiently. The API exposes 11 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create a new payment link (link to pay), create a new split payment link. Covers 11 operations with apiKey authentication.

## Scope

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

## Capabilities

- Create a new payment link (Link To Pay)
- Retrieve pay-in transactions
- (to be released) Delete a payment link
- Query and filter SecPaid Interative API records by parameters
- Monitor SecPaid Interative API operational status and events

## Use cases

### Payments Operations

Use the SecPaid Interative API to perform payments operations programmatically. The API provides 11 endpoints covering core functionality including create a new payment link (link to pay), create a new split payment link, retrieve pay-in transactions.

Example prompt: Call POST `/v2/createLink` to create a new payment link (link to pay)

### Automated Createlink Management

Automate createlink operations by combining multiple SecPaid Interative API endpoints. Agents can create a new split payment link and then retrieve pay-in transactions in a single workflow.

Example prompt: Call POST `/v2/createSplitLink` to create a new split payment link, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SecPaid Interative 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 apiKey tokens manually.

Example prompt: Search Jentic for 'create a new payment link (link to pay)', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v2/createLink` | Create a new payment link (Link To Pay) |
| POST | `/v2/createSplitLink` | Create a new split payment link |
| POST | `/v2/getPayInTransactions` | Retrieve pay-in transactions |
| POST | `/v2/getPayOutTransactions` | Retrieve pay-out transactions |
| POST | `/v2/getMyUnusedLinks` | Retrieve unused payment links |
| POST | `/v2/getMyUsedLinks` | Retrieve used payment links |
| POST | `/v2/deleteLink` | (to be released) Delete a payment link |
| POST | `/v2/refundPayment` | Process a payment refund |

## Key resources

- **Createlink** — Operations for createLink
- **Createsplitlink** — Operations for createSplitLink
- **Deletelink** — Operations for deleteLink
- **Generatecsvfile** — Operations for generateCsvFile
- **Generatepdf** — Operations for generatePdf

## Why Jentic

- **Setup:** Wiring the SecPaid Interative API by hand means carrying its token header on every call, working through its POST-only endpoints, and building each payment-link request body yourself. Through Jentic you install once, import SecPaid from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The SecPaid Interative API takes the link and transaction targets in the request body rather than a resource in the URL path, so scope by operation: limit the agent to the operations it needs, such as createLink or getPayInTransactions, and leave refundPayment or deleteLink out unless you add them.
- **Credential handling:** Your SecPaid key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a payment link' or 'list pay-in transactions', and Jentic returns the matching SecPaid 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 SecPaid Interative API use?

The SecPaid Interative API uses an API key passed in the `token` header. 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 a new payment link (link to pay) with the SecPaid Interative API?

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

### What are the rate limits for the SecPaid Interative 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 a new payment link (link to pay) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a new payment link (link to pay)'. Jentic returns the matching SecPaid Interative API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SecPaid Interative API have?

The SecPaid Interative API exposes 11 endpoints covering createlink, createsplitlink, deletelink operations.

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

Yes. Because the SecPaid API takes each link and transaction target in the request body rather than in the URL path, you scope access by operation in your own self-hosted Jentic One instance, where your rules decide which operations and credentials the agent may use. Grant the agent only the operations it needs, such as createLink or getPayInTransactions, and leave sensitive operations like refundPayment and deleteLink out unless you explicitly add them. The stored API key is injected at execution time only for the operations you have allowed.
