×
Freshbooks
Official App
Free – Google Play
Get it

Gateways

General Info

Gateways are also referred to as Payment Processors. The information returned by these endpoints specifies what payment processors are enabled for your Businesses.

Includes

There are no includes for gateways.

Filters

There are no filters for gateways.

Field Descriptions

FieldTypeDescription
sgidintunique to this business id for this gateway
connectionidstringunique to our whole environment id for this gateway
gateway_namestringe.g. "stripe", "fbpay"
idintduplicate of sgid

Get Single Gateway

Getting single Gateways is not supported by the API.

Create Single Gateway

Creating Gateways is not supported by the API.

Update Single Gateway

Updating Gateways is not supported by the API.

Delete Single Gateway

Request: DELETE https://api.freshbooks.comaccounting/account/<accountid>//system/gateways/<id>

Response:
{
  "response": {}
}

List Expense Categories

Request: GET https://api.freshbooks.comaccounting/account/<accountid>/system/gateways

Response:

{
  "response": {
    "result": {
      "per_page": 15,
      "pages": 1,
      "total": 2,
      "gateways": [
        {
          "sgid": 1598106,
          "connectionid": "4620a6cc81c542aa89a9390b94b50fe9",
          "gateway_name": "stripe",
          "id": 1598106
        },
        {
          "sgid": 1221100,
          "connectionid": "8e390c649fa647978f9a9351d40b63a3",
          "gateway_name": "fbpay",
          "id": 1221100
        }
      ],
      "page": 1
    }
  }
}