Payflow API Documentation
Start here for Payflow client APIs, payment creation, API credentials, sandbox testing, provider callbacks, and production-safe integration.
Payflow client APIs let your product create payment experiences without coupling application code directly to every payment provider. Your integration calls /client/v1, Payflow authenticates the application environment, evaluates routing, prepares provider handoff, and returns stable Payflow references for your records.
This documentation intentionally covers only the client API surface and the concepts directly required to use it well: credentials, environments, CORS origins, payment flows, ACH transfers, routing outcomes, provider callback behavior, error handling, request IDs, and launch readiness.
Who this is for
Use these docs if you are:
- Building a checkout, billing, marketplace, payout, or bank-transfer experience on top of Payflow.
- Calling Payflow from a backend, browser checkout, mobile app, or internal commerce workflow.
- Choosing between hosted checkout, embedded card components, and ACH bank transfers.
- Deciding when to use publishable keys versus secret keys.
- Configuring browser-safe origins and production-safe credentials.
- Handling Payflow response envelopes, provider callbacks, retries, and support identifiers.
Client API surface
| Area | Primary paths |
|---|---|
| Hosted checkout | /client/v1/payments |
| Embedded card components | /client/v1/payments/component, /client/v1/payments/component/:payflowReference/confirm |
| ACH customer tokenization | /client/v1/ach/customer-tokens |
| ACH transfer preview | /client/v1/ach/transfers/preview |
| ACH transfer creation | /client/v1/ach/transfers |
Base URLs
Payflow client API requests use the hosted API origin. Your credentials determine whether a request is handled as sandbox or production.
Client API base: https://api.ftosllc.co/client/v1For example, create a hosted checkout payment with POST https://api.ftosllc.co/client/v1/payments.
Response envelope
Payflow client API JSON endpoints return a stable envelope:
{
"success": true,
"data": {},
"message": null
}Expected API errors return the same shape with success: false:
{
"success": false,
"data": null,
"message": "Readable error message"
}Provider callback acknowledgements may intentionally use a provider-native acknowledgement shape.
Recommended path
- Read Concepts to understand applications, environments, credentials, routing, and Payflow references.
- Complete Quickstart to create the first sandbox payment.
- Choose a payment flow in Payments.
- Configure keys and origins with Applications and keys.
- Prepare for launch with Going live, Webhooks, and Errors.
Source of truth
For integration code, treat Payflow's client API responses as the source of truth for the payment preparation, selected provider, Payflow reference, and provider handoff details. Store the payflowReference on your own order, invoice, transfer, or customer-facing record.