INinvoiceninja
company_gateways

Gets a list of company_gateways

Changed on

Lists company_gateways, search and filters allow fine grained lists to be generated.

    Query parameters can be added to performed more fine grained filtering of the company_gateways, these are handled by the CompanyGatewayFilters class which defines the methods available
get/api/v1/company_gateways

Request

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

per_pageinteger
Example:20

The number of records to return for each request, default is 20

pageinteger
Example:1

The page number to return for this request (when performing pagination), default is 1

sortstring[]

Order the list by choosing a column and direction. Each value uses the form column|asc or column|desc.

Single sort — for example sort=label|asc.

Multiple sorts — for example
sort[]=id|desc&sort[]=label|asc.

Sorting is limited to columns on the company gateways table (for example label, id). Unsupported keys are ignored.

[
  "label|asc"
]

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

A list of company_gateways

Example response

{
  "data": [
    {
      "id": "Opnel5aKBz",
      "gateway_key": "2",
      "accepted_credit_cards": 32,
      "require_billing_address": true,
      "require_shipping_address": true,
      "config": "dfadsfdsafsafd",
      "update_details": true,
      "fees_and_limits": [
        {
          "min_limit": "2",
          "max_limit": "2",
          "fee_amount": 2,
          "fee_percent": 2,
          "fee_tax_name1": "GST",
          "fee_tax_name2": "VAT",
          "fee_tax_name3": "CA Sales Tax",
          "fee_tax_rate1": 10,
          "fee_tax_rate2": 17.5,
          "fee_tax_rate3": 25,
          "fee_cap": 2,
          "adjust_fee_percent": true
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Changes

  • 89876e7e51d6Revision changes
    • info

      added the new optional query request parameter sort

  • 69a36036d334Revision changes
    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

    • info

      the response optional property // became read-only for the status