Official vendor OpenAPI document · agent-readyPaymentsBilling Subscriptionsbearer6 EndpointsREST
For Agents
Programmatically create demo campaign, cancel processing the sequence. Covers 6 operations with bearer authentication.
Use for: I need to demo campaign, I want to cancel processing the sequence, Search for subscribe to an event, Find all unsubscribe from an event
Not supported: Does not handle communications, crm, or developer tools - use for payments only.
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.
Install Jentic One Beta
Connect the Respaid API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Respaid API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Frespaid.com%2Frespaid" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Frespaid.com%2Frespaid" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Respaid API.
Create demo campaign
Cancel processing the sequence
Subscribe to an event
Unsubscribe from an event
List webhook events
Get current user information
Use Cases
Patterns agents use Respaid API for, with concrete tasks.
★ 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.
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.
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.
Search Jentic for 'create demo campaign', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
6 endpoints — respaid helps you collect your unsettled receivables using ai, achieved amicably, preserving your brand and client relationships.
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
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
Jentic AI Readiness Score
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.
R
Respaid API
- AI-Aware (B+)70/100
100
Foundational Compliance63
Developer Experience & Jentic Compatibility56
AI-Readiness & Agent Experience94
Agent Usability60
Security69
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
56
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
74%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
60
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
60%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
69
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B+Signals: 1
69%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe
Alternative payments API
Choose Stripe when you need a different approach to payments operations
FAQs
Specific to using Respaid API through Jentic.
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.
GET STARTED