Client API Reference

Client API endpoints authenticate with Payflow API keys.

Base URL:

https://api.ftosllc.co/client/v1

Payments

Method	Path	Auth	Description
`POST`	`/fees/quote`	Secret key	Quote routing, service fees, and total debit.
`POST`	`/payments`	API key, secret recommended	Create a sandbox hosted checkout payment.
`POST`	`/payments/component`	API key	Prepare an embedded card component payment.
`POST`	`/payments/component/:payflowReference/confirm`	Secret key	Confirm a Stripe or Square component result.

ACH

Method	Path	Auth	Description
`POST`	`/ach/customer-tokens`	Secret key	Create an encrypted customer token.
`POST`	`/ach/transfers/preview`	Secret key	Preview ACH transfer routing and fees.
`POST`	`/ach/transfers`	Secret key	Create a provider-routed ACH transfer.

Common headers

Authorization: Bearer sk_test_...
Content-Type: application/json
X-Request-Id: optional-stable-id
X-Payflow-SDK: optional-sdk-name
X-Payflow-SDK-Version: optional-sdk-version

Common payment request object

{
  "amountMinor": "2500",
  "currency": "USD",
  "paymentMethod": "web_card",
  "description": "Payment description",
  "customer": {
    "name": "Customer Name",
    "email": "[email protected]"
  },
  "metadata": {
    "orderId": "order_123"
  }
}

Fee quote request object

{
  "amountMinor": "2500",
  "currency": "USD",
  "paymentMethod": "web_card",
  "flow": "payment_component",
  "metadata": {
    "orderId": "order_123"
  }
}

Fee quotes use the same routing rules as payment preparation. The response includes platformFeeMinor, organizationFeeMinor, combined feeMinor, and totalDebitMinor, plus a versioned breakdown object. For customer-paid fees, charge or debit totalDebitMinor and keep amountMinor as the principal transaction amount. Web payment fees are configured once per provider; hosted checkout and payment component flows share that same fee.

Set flow to hosted_checkout or payment_component for web-card quotes. If omitted, Payflow treats the quote as payment_component.

Hosted checkout response fields

Field	Meaning
`payflowReference`	Stable Payflow payment reference.
`status`	Usually `prepared` at creation time.
`provider`	Selected provider, such as `stripe` or `square`.
`routing`	Rule metadata used for provider selection.
`platformFeeMinor`	Payflow provider-cost recovery fee.
`organizationFeeMinor`	Organization-configured service fee.
`feeMinor`	Combined platform provider-cost and organization fee.
`totalDebitMinor`	Principal amount plus fee.
`checkoutUrl`	Provider-hosted checkout URL.
`preparedAt`	Preparation timestamp.

Component response fields

Component type	Fields
`stripe_payment_element`	`publishableKey`, `clientSecret`, `paymentIntentId`
`square_web_payments`	`applicationId`, `locationId`, `environment`, `amountMinor`, `currency`

ACH transfer request object

{
  "idempotencyKey": "unique-business-action",
  "amountMinor": "12500",
  "currency": "USD",
  "customerToken": "eyJ...",
  "routingNumber": "222222226",
  "accountNumber": "123456789",
  "bankAccountType": "checking",
  "bankName": "Test Bank",
  "accountName": "Jane Stone",
  "description": "ACH transfer",
  "metadata": {},
  "remittanceData": {}
}

Do not log full bank account numbers or customer tokens.

Client API Reference

On this page