Skip to Main Content
×
Freshbooks
Official App
Free – Google Play
Get it
FreshBooks is Loved by American Small Business Owners
FreshBooks is Loved by Canadian Small Business Owners
FreshBooks is Loved by Small Business Owners in the UK

Gateway

Staff have access to the list API call

The Gateway API provides access to the Online Payment Gateways enabled in the application.

gateway.list

Returns a list of payment gateways enabled in your FreshBooks account that can process transactions. You can optionally filter by autobill_capable to return only gateways that support auto-bills.

Note: This method uses pagination

Request

<?xml version="1.0" encoding="utf-8"?>
<request method="gateway.list">
  <autobill_capable>1</autobill_capable> <!-- Filter by Auto bill capable gateways (Optional) -->
</request>

Response

<?xml version="1.0" encoding="utf-8"?>
<response xmlns="https://www.freshbooks.com/api/" status="ok">
  <gateways page="1" per_page="100" pages="1" total="1">
    <gateway>
      <name>Stripe</name>
      <autobill_capable>1</autobill_capable>
    </gateway>
  </gateways>
</response>