Dev Api Payfactory App Payfactory API
42
AI ReadinessFoundational (D-)42/100
Agent-ready OpenAPI document · curated by JenticPaymentsPayment ProcessingapiKey15 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Onboard merchant applications, manage underwriting, attach transaction metadata, and pull deposit and ACH reporting data through Payfactory's embedded payfac API.
Use for: Submit a new merchant application to Payfactory, Check the underwriting status of an application, Upload a bank statement to a merchant application, Start a hosted application form session for a new merchant
Not supported: Does not handle hosted checkout, subscription billing, or chargeback management - use for embedded payfac onboarding, transaction metadata, and deposit reporting only.
Jentic publishes the only available OpenAPI specification for Payfactory API, keeping it validated and agent-ready. Payfactory provides embedded payment facilitation (payfac) services for ISVs and SaaS platforms that want to monetise payments without becoming a payfac themselves. The API covers merchant application onboarding, document upload, underwriting, transaction metadata, and reporting on deposits and ACH transactions, so software vendors can offer payments inside their product without rebuilding the back-office plumbing.
Install Jentic One Beta
Connect the Payfactory API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Payfactory 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%2Fdev-api.payfactory.app%2Fpayfactory" | 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%2Fdev-api.payfactory.app%2Fpayfactory" | 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 Payfactory API.
Submit a merchant application and track its underwriting status
Drive a multi-step application form session through token-based handoff
Upload supporting documents like bank statements or IDs to a merchant application
Attach metadata to processed transactions for reconciliation
Pull deposit and ACH transaction reporting for finance teams
Trigger underwriting on a submitted application
Retrieve detailed application status for a given merchant
Use Cases
Patterns agents use Payfactory API for, with concrete tasks.
★ Embedded Merchant Onboarding
Vertical SaaS platforms onboard their customers as merchants by combining the application form session endpoints with document upload. The /v1/ApplicationForm/session endpoint hands off a tokenised session for the merchant to fill out the form, and /v1/Document/Upload attaches required documents - bank statements, IDs, voided checks - before /v1/Application/Submit and StartUnderwriting close the loop.
Create a session via POST /v1/ApplicationForm/session, upload required documents via POST /v1/Document/Upload/{type}/{appId}, then call POST /v1/Application/Submit and POST /v1/Application/StartUnderwriting/{appId}.
Underwriting Status Tracking
Operations teams use the application detail and status endpoints to poll where each merchant sits in the underwriting queue and surface that state inside their own admin UI. This avoids bouncing customers between systems while their account is being reviewed.
Call GET /v1/Application/Status/{appId} for each in-flight application and update the internal admin record with the latest status.
Transaction Metadata for Reconciliation
Finance and accounting teams attach internal references to processed transactions via /v1/Transaction/Metadata and the bulk variant. The metadata helps reconcile Payfactory deposits against the platform's own ledger entries and customer invoices.
POST /v1/Transaction/MetadataBulk with an array of transaction IDs and corresponding internal invoice numbers to enable reconciliation in the finance system.
Deposit and ACH Reporting
Finance teams pull funded deposits and the ACH transactions that make them up via /v1/Reporting/Deposits and /v1/Reporting/AchTransactions. This drives daily settlement reports, cash forecasting, and the reconciliation runs that bridge gateway activity to the bank account.
Call GET /v1/Reporting/Deposits/{numberOfDeposits} for the last 7 deposits and GET /v1/Reporting/AchTransactions/{referenceId} for each, then build a settlement report.
Agent-Driven Merchant Operations
AI agents help platform ops triage onboarding queues, chase missing documents, and update status across Payfactory by going through Jentic. The Payfactory API key stays in your Jentic One instance and the agent can resolve intents like 'check this merchant's underwriting status' without writing custom integration code.
Search Jentic for 'check Payfactory application status', load the GET /v1/Application/Status/{appId} operation, and execute it for each in-flight applicant ID.
Key Endpoints
15 endpoints — jentic publishes the only available openapi specification for payfactory api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/v1/Application/Submit
Submit a merchant application
GET
/v1/Application/Status/{appId}
Get current application status
POST
/v1/Application/StartUnderwriting/{appId}
Trigger underwriting on a submitted application
POST
/v1/ApplicationForm/session
Create a hosted application form session
POST
/v1/Document/Upload/{type}/{appId}
Upload a supporting document to an application
POST
/v1/Transaction/MetadataBulk
Attach metadata to multiple transactions
GET
/v1/Reporting/Deposits
List recent deposits
GET
/v1/Reporting/AchTransactions/{referenceId}
List ACH transactions for a deposit
POST
/v1/Application/Submit
Submit a merchant application
GET
/v1/Application/Status/{appId}
Get current application status
POST
/v1/Application/StartUnderwriting/{appId}
Trigger underwriting on a submitted application
POST
/v1/ApplicationForm/session
Create a hosted application form session
POST
/v1/Document/Upload/{type}/{appId}
Upload a supporting document to an application
POST
/v1/Transaction/MetadataBulk
Attach metadata to multiple transactions
GET
/v1/Reporting/Deposits
List recent deposits
GET
/v1/Reporting/AchTransactions/{referenceId}
List ACH transactions for a deposit
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.
P
Payfactory Api
- Foundational (D-)42/100
73
Foundational Compliance70
Developer Experience & Jentic Compatibility18
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
73
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
93%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
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.
70
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B+Signals: 4
34%
Example Density
How richly the API is illustrated with examples.
95%
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.
18
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
28%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
45%
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.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
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 the Payfactory API by hand means learning its API key header and building the embedded onboarding, underwriting, document upload, transaction metadata, and deposit reporting calls yourself. Through Jentic you install once, import the Payfactory API from the API Directory, store the key once, and your agent calls it.
Permission scoping
Payfactory puts the application id in the URL path (/v1/Application/Status/{appId}), so a rule can pin your agent to one application: it can check that application's status and read its reports and nothing else. You choose the operations it may call, so actions like starting underwriting or submitting a new application are not included unless you add them.
Credential isolation
Your Payfactory API key is stored once, encrypted, by your own Jentic One instance and injected into the ApiKey header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'check a Payfactory application status' or 'pull last week's deposits', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing Payfactory docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe API
Stripe Connect provides full payfac-style onboarding and processing for platforms.
Choose Stripe when you want a global payfac with deeper international and online checkout coverage; choose Payfactory when the focus is US ISV-embedded card-present and ACH.
FAQs
Specific to using Payfactory API through Jentic.
Why is there no official OpenAPI spec for Payfactory API?
Payfactory does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Payfactory API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Payfactory API use?
Payfactory uses an API key passed in a request header (ApiKey scheme). Through Jentic the key is stored encrypted in the vault and injected at call time so the raw value never enters agent context.
Can I onboard a merchant end-to-end with the Payfactory API?
Yes - chain POST /v1/ApplicationForm/session, POST /v1/Document/Upload/{type}/{appId} for each document, POST /v1/Application/Submit, and POST /v1/Application/StartUnderwriting/{appId} to drive a full onboarding flow.
How do I pull deposit and ACH reporting from the Payfactory API?
Call GET /v1/Reporting/Deposits or /v1/Reporting/Deposits/{numberOfDeposits} for the deposit list, then GET /v1/Reporting/AchTransactions/{referenceId} to get the underlying ACH transactions for each deposit.
What are the rate limits for the Payfactory API?
The OpenAPI spec does not declare rate limits. For reporting workloads, prefer the bulk metadata endpoint (/v1/Transaction/MetadataBulk) and paginate deposit reads to reduce request volume.
How do I check an application's status through Jentic?
Search Jentic for 'check Payfactory application status', load the GET /v1/Application/Status/{appId} operation, and execute it with the application ID. Jentic injects the API key at execution time.
Can I limit what my agent is allowed to do with the Payfactory API?
Yes. Because you run Jentic One yourself, your own rules decide which Payfactory operations and credentials the agent can use. Since Payfactory puts the application id in the URL path, such as GET /v1/Application/Status/{appId}, a rule can pin the agent to a single application so it only reads that application's status and deposit and ACH reports. Write actions like POST /v1/Application/Submit or POST /v1/Application/StartUnderwriting/{appId} stay off limits unless you explicitly allow them.
GET STARTED