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

# Respaid API

Respaid helps you collect your unsettled receivables using AI, achieved amicably, preserving your brand and client relationships. This API provides Zapier integration endpoints for campaign management, webhook subscriptions, and user information. The API exposes 6 endpoints secured with bearer authentication.

## For AI agents

Programmatically create demo campaign, cancel processing the sequence. Covers 6 operations with bearer authentication.

## Scope

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

## Capabilities

- Create demo campaign
- Cancel processing the sequence
- Subscribe to an event
- Unsubscribe from an event
- List webhook events
- Get current user information

## Use cases

### Payments Operations

Use the Respaid API to perform payments operations programmatically. The API provides 6 endpoints covering core functionality including create demo campaign, cancel processing the sequence, subscribe to an event.

Example prompt: Call POST `/api/zapier/actions/gmail` to create demo campaign

### Automated Actions Management

Automate actions operations by combining multiple Respaid API endpoints. Agents can cancel processing the sequence and then subscribe to an event in a single workflow.

Example prompt: Call POST `/api/zapier/actions/cancel_process` to cancel processing the sequence, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Respaid 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 bearer tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/zapier/actions/gmail` | Create demo campaign |
| POST | `/api/zapier/actions/cancel_process` | Cancel processing the sequence |
| POST | `/api/zapier/webhook/subscribe` | Subscribe to an event |
| DELETE | `/api/zapier/webhook/unsubscribe` | Unsubscribe from an event |
| GET | `/api/zapier/webhook/list` | List webhook events |
| GET | `/api/zapier/me` | Get current user information |

## Key resources

- **Actions** — Campaign and process management actions
- **Webhooks** — Webhook subscription management
- **User** — User information

## 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:** 70 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 56 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 69 / 100
- **View full report:** https://jentic.com/apis/respaid.com/respaid/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 Respaid by hand means setting its bearer auth on every request against the backend.widr.app host and managing webhook subscribe and unsubscribe calls yourself. Through Jentic you install once, import the Respaid API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Respaid addresses its actions and webhooks through operations rather than a resource id in the path, so limit the agent to the operations it needs, such as listing webhooks or the me lookup. You choose that set, so a state-changing one like unsubscribing a webhook is not included unless you add it.
- **Credential handling:** Your Respaid token 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 'list webhook subscriptions' or 'get my account', and Jentic returns the matching Respaid 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 Respaid API use?

The Respaid API uses a Bearer token in the Authorization 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 demo campaign with the Respaid API?

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

### What are the rate limits for the Respaid 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 demo campaign through Jentic?

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

### How many endpoints does the Respaid API have?

The Respaid API exposes 6 endpoints covering actions, webhooks, user operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Respaid operations and credentials the agent can use. Since Respaid addresses its actions and webhooks through operations rather than a resource id in the path, you grant only the ones the agent needs, such as listing webhook events or the current-user lookup, and leave out state-changing calls like unsubscribing a webhook unless you add them. The stored bearer token is injected at execution time, so the agent can only reach the endpoints you allow.