Payflow Docs
Reference

Client API Reference

Reference for public client API endpoints under /client/v1.

Client API endpoints authenticate with Payflow API keys.

Base URL:

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

Payments

MethodPathAuthDescription
POST/paymentsAPI key, secret recommendedCreate a sandbox hosted checkout payment.
POST/payments/componentAPI keyPrepare an embedded card component payment.
POST/payments/component/:payflowReference/confirmSecret keyConfirm a Stripe or Square component result.

ACH

MethodPathAuthDescription
POST/ach/customer-tokensSecret keyCreate an encrypted customer token.
POST/ach/transfers/previewSecret keyPreview ACH transfer routing and fees.
POST/ach/transfersSecret keyCreate a Dwolla-backed 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"
  }
}

Hosted checkout response fields

FieldMeaning
payflowReferenceStable Payflow payment reference.
statusUsually prepared at creation time.
providerSelected provider, such as stripe or square.
routingRule metadata used for provider selection.
checkoutUrlProvider-hosted checkout URL.
preparedAtPreparation timestamp.

Component response fields

Component typeFields
stripe_payment_elementpublishableKey, clientSecret, paymentIntentId
square_web_paymentsapplicationId, 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.

On this page