Online payments API

Base URL: https://app.servflo.ai/api. Every call needs Authorization: Bearer sfk_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.

Online payments: the Stripe account and settings

Whether this business can take card and bank payments online: the server's Stripe configuration (never the key), the business's connected Stripe account's state (charges and payouts enabled, requirements still due, payout schedule) and the business's switches (online payments, partial payments, tips). Read-only; does not call Stripe (POST /payment-account/refresh does).

Permission: payments.read (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk read (OAuth scope servflo.read).

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/payment-account" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Disconnect the Stripe account

Destructive: unlinks the connected Stripe account. Pay online buttons disappear and saved customer cards stop being charged for memberships (autopay off). The account is the business's own and stays at Stripe (its balance still pays out); earlier online payments can still be refunded while Stripe lets ServFlo reach the account, else from the Stripe dashboard. Setting up again creates a new account.

Example

curl -X DELETE "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/payment-account" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Set up or continue online payments (Stripe onboarding link)

GRANTS ACCESS / MONEY: creates the business's own Stripe account on first use (a connected account with a full Stripe dashboard where Stripe carries losses and bills its processing fees to the business; country US; card payments, transfers and ACH debits requested) and returns a fresh Stripe-hosted onboarding link (Account Link, valid for minutes) to send the owner to, where they also create their Stripe login. Stripe returns them to Settings → Payments. Calling it again continues setup on the same account. Needs payments.manage (owners and admins).

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/payment-account/onboarding" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Refresh the Stripe account's status

Asks Stripe for the connected account's current standing (charges and payouts enabled, requirements due, payout schedule) and stores it; webhooks do the same automatically. Returns the same shape as GET /payment-account.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/payment-account/refresh" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Open the business's Stripe dashboard

Returns the address of the Stripe dashboard (https://dashboard.stripe.com/), where the business signs in with the Stripe login it created during onboarding (balance, payouts, bank account, tax forms, disputes). No login link is made: the business has a full Stripe account of its own. Only once onboarding details are submitted (409 before). Needs payments.manage.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/payment-account/dashboard-link" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Turn online payments, partial payments, tips or financing on or off

Exposes to customers: onlinePaymentsEnabled shows or hides every Pay online / Pay deposit button (portal, /i and /q pages) without disconnecting Stripe; allowPartialPayments lets customers pay part of an invoice (default off: the balance); tipsEnabled offers a tip on the pay page (default off); financingEnabled offers Affirm and/or Klarna (financingAffirm, financingKlarna) from financingMinCents up, and asks Stripe for those capabilities (if Stripe refuses, 409 says to turn them on in the business's Stripe dashboard). Send any of them. Needs payments.manage.

Request body

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/payment-account/settings" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"onlinePaymentsEnabled":true,"allowPartialPayments":true,"tipsEnabled":true}'

Response

Charge a card: open Stripe Checkout for an invoice

Money: for a payment taken over the phone. Creates a PENDING online payment (processor STRIPE) for the balance due (or amountCents when partial payments are on) and returns the Stripe Checkout page to enter the card on; the payment and the invoice settle when Stripe's webhook confirms it. An earlier unfinished checkout for the same invoice is expired first. 409 when the business cannot take online payments, 400 when nothing is due. To send the customer a link instead, use POST /invoices/{invoiceId}/link (its /i page has Pay online).

Permission: payments.record (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk sensitive (OAuth scope servflo.sensitive).

Parameters

Request body

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoices/{invoiceId}/checkout" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amountCents":12500,"tipCents":12500,"method":"card"}'

Response

A customer's saved payment method and autopay

Whether the customer saved a card or bank account (from their portal) and their membership invoices are charged automatically, with the method's brand and last four. Read-only.

Permission: payments.read (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk read (OAuth scope servflo.read).

Parameters

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/customers/{customerId}/autopay" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

Turn off a customer's automatic payments

Destructive: membership invoices are no longer charged automatically and the saved method is removed (detached at Stripe). The customer can save a new one from their portal. Invoices already issued are untouched.

Permission: memberships.write (Owner, Admin, Dispatcher, Technician (own jobs)); risk sensitive (OAuth scope servflo.sensitive).

Parameters

Example

curl -X DELETE "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/customers/{customerId}/autopay" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response