Skip to main content
Use the Businesses API to register a shop with the payment processor and manage the accounts that receive payouts. Stripe is the supported processor today.

​
Register the business

To accept payments, register with the payment processor. The payload differs for an individual versus a company. Individuals send the last four digits of their SSN, date of birth, and address. Companies also send the legal name and EIN. If the business is already registered, you get businessAlreadyRegistered.

​
Add financial accounts and cards

After registration, add financial accounts for payouts, manually or through Plaid for faster verification. You can also add payout cards for faster access, usually at a higher fee. Mark one account or card as the default destination. You cannot remove a default financial account or remove a default payout card. That returns cannotRemoveDefault. Set a different default first, then remove the old one.

​
Read the balance

Get the business balance across four buckets: Available: ready for standard bank payouts. Available for instant: the share you can send instantly to a card, subject to daily limits. Pending: still settling. Allocated: already tied to payouts in flight. If processor setup is incomplete, you get paymentProviderNotSetup.

​
Match destinations to payout methods

When you list financial accounts or list payout cards, filter by payout method to see which destinations work for the transfer you want. Guile routes the payout from the method you choose to a destination that supports it.

​
Common failures

​
Suggested order

  1. Register the business
  2. Finish identity and business verification
  3. Add bank accounts or cards
  4. Watch balances before you pay out
  5. Create payouts under Payouts