INinvoiceninja
client_gateway_tokens

Gets a new blank client payment token object

Changed on

Returns a blank object with default values

get/api/v1/client_gateway_tokens/create

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

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 blank client payment token object

idstring

The hashed id of the client gateway token

client_idstring

The hashed_id of the client

tokenstring

The payment token

routing_numberstring

THe bank account routing number

company_gateway_idstring

The hashed id of the company gateway

is_defaultboolean

Flag determining if the token is the default payment method

Example response

{
  "id": "Opnel5aKBz",
  "client_id": "2",
  "token": "2",
  "routing_number": "2",
  "company_gateway_id": "2",
  "is_default": 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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status