INinvoiceninja
company_gateways

Performs bulk actions on an array of company_gateways

Changed on
post/api/v1/company_gateways/bulk

Request

Query parameters

indexstring
Example:user

Replaces the default response index from data to a user specific string

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }

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

Request body

integer[] required

Response

The Company Gateways response

idstring

The hashed id of the company gateway

gateway_keystring

The gateway key (hash)

accepted_credit_cardsinteger

Bitmask representation of cards

require_billing_addressboolean

Determines if the the billing address is required prior to payment.

require_shipping_addressboolean

Determines if the the billing address is required prior to payment.

configstring

The configuration map for the gateway

update_detailsboolean

Determines if the client details should be updated.

Example response

{
  "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
    }
  ]
}

Changes

  • 69a36036d334Revision changes
    • info

      the response optional property became read-only for the status

  • 8e82a2bd77e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status