INinvoiceninja
client_gateway_tokens

List of client payment tokens

Changed on

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

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

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

indexstring
Example:user

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

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }
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

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 client_gateway_tokens

Example response

{
  "data": [
    {
      "id": "Opnel5aKBz",
      "client_id": "2",
      "token": "2",
      "routing_number": "2",
      "company_gateway_id": "2",
      "is_default": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Changes

  • 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

  • 93bb427f804bRevision changes
    • breaking

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