Documentation Index
Fetch the complete documentation index at: https://developers.ingopayments.com/llms.txt
Use this file to discover all available pages before exploring further.
Every spec file published to this developer center is available as a raw YAML file at a stable URL. Use these links to import specs into Postman, generate client SDKs, connect IDE plugins, or run your own validation tooling. Specs are updated with each platform release — the URLs below always reflect the current published version.
Specs marked Coming Soon on their reference pages are excluded from this index. Those specifications are subject to change prior to general availability and are not recommended for integration. Contact your Ingo integration manager for availability timelines.
IngoPay API
The IngoPay API uses a shared endpoint (POST /gateway/verify, POST /gateway/process, POST /gateway/v12/debit/process) that branches by account_type. Each spec below covers a single account type so the request and response schemas are unambiguous in the API playground and in generated clients.
Account Tokenization
| Spec | Type | URL |
|---|
| Card Tokenization | OpenAPI 3.0 | ingopay-verify-card.yaml |
| ACH Tokenization | OpenAPI 3.0 | ingopay-verify-ach.yaml |
| BillPay Tokenization | OpenAPI 3.0 | ingopay-verify-billpay.yaml |
| Check by Mail Tokenization | OpenAPI 3.0 | ingopay-verify-check.yaml |
| PayPal / Venmo Tokenization | OpenAPI 3.0 | ingopay-verify-paypal-venmo.yaml |
| Retail Card-Present Tokenization | OpenAPI 3.0 | ingopay-verify-retail-card-present.yaml |
Push Payments
| Spec | Type | URL |
|---|
| Card Push Disbursement | OpenAPI 3.0 | ingopay-process-card.yaml |
| ACH Push Disbursement | OpenAPI 3.0 | ingopay-process-ach.yaml |
| BillPay Push | OpenAPI 3.0 | ingopay-process-billpay.yaml |
| Check by Mail Push | OpenAPI 3.0 | ingopay-process-check.yaml |
| PayPal / Venmo Push | OpenAPI 3.0 | ingopay-process-paypal-venmo.yaml |
| Retail Card-Present Push | OpenAPI 3.0 | ingopay-process-retail-card-present.yaml |
Pull Payments
| Spec | Type | URL |
|---|
| Card Pull (v12 Debit) | OpenAPI 3.0 | ingopay-debit-process-card.yaml |
| ACH Pull (v12 Debit) | OpenAPI 3.0 | ingopay-debit-process-ach.yaml |
Risk & Compliance
| Spec | Type | URL |
|---|
| Risk Session + Risk Score | OpenAPI 3.0 | ingopay-risk.yaml |
Ancillary Services
Notify
| Spec | Type | URL |
|---|
| Notify v3 — Classic | OpenAPI 3.0 | ingopay-notify-v3.yaml |
| Notify v4 — Managed Parties | OpenAPI 3.0 | ingopay-notify-v4.yaml |
Webhooks
| Spec | Type | URL |
|---|
| IngoPay Gateway Webhook Events | AsyncAPI 3.0 | asyncapi-ingopay.yaml |
Embedded Account Capture
| Spec | Type | URL |
|---|
| iFrame Session Management | OpenAPI 3.0 | iframe-session-create.yaml |
| EAC Plugin Webhook Events | AsyncAPI 3.0 | asyncapi-iframe.yaml |
Notify — Classic
| Spec | Type | URL |
|---|
| Notify Classic Webhook Events | AsyncAPI 3.0 | asyncapi-notify-v3.yaml |
Notify — Managed Parties
| Spec | Type | URL |
|---|
| Notify Managed Parties Webhook Events | AsyncAPI 3.0 | asyncapi-notify-v4.yaml |
| Spec | Type | URL |
|---|
| Banking Platform API | OpenAPI 3.0 | ingo-banking-merchant-ledgering.yaml |
| Banking Platform Webhook Events | AsyncAPI 3.0 | asyncapi-banking.yaml |
The Banking Platform webhook spec includes Card Lifecycle and Card Authorization event schemas. These are documented for advance integration planning — Card Issuance is currently In Development and these events will not fire until the capability is enabled for your program.
