Overview
Find each Facto API, its authentication method, and its detailed reference.
Use these pages after choosing what you want to build. The guides explain the flow; the reference pages list the exact requests, responses, and rules.
The reference includes the Merchant API and Card Program Connect API. Card provider API documentation is temporarily hidden because new provider onboarding is closed. Credentials are never shared between these groups or environments.
API groups
| API group | Authentication | Reference |
|---|---|---|
/api/connect/*, /api/merchant/* | Basic auth: credential_id and its show-once secret | Merchant API |
/api/partner-workspace/*, /api/partner-auth/* | The Dashboard's own browser session. Not callable from your backend | Not documented as an API |
/api/admin/* | Facto operators only | Not partner-facing |
/api/card-program-connect/* | Signed server requests using the target environment's credential | Card Program Connect API |
The Card Program Connect routes are implemented in the Engine. Calls require an active Program Connection and server credential in the target environment, and Facto must enable the APIs that program needs. Sandbox and Production credentials are not interchangeable. Production requires separate approval.
Conventions
- Error format depends on the API. Merchant API errors use
{ error: { category, code, message, request_id, retryable, details? } }. The Card Program API uses flat{ error, message, request_id }. See Errors and statuses. - Writes are idempotent or they are not retryable. See Idempotency.
- Two limits apply at once: a per-app quota and a per-IP limit. See Rate limits.
Pages
- Merchant API and SDKs for merchant integrations.
- Card provider reference pages are temporarily hidden.
- Card Program Connect API for card connection and authorization contracts.
- Errors and statuses, Idempotency, Rate limits and Security explain the shared rules and the listed exceptions.
- Migration for the retired
/api/external/*aliases.