---
title: "Gets a new blank client payment token object"
method: GET
path: "/api/v1/client_gateway_tokens/create"
tags: ["client_gateway_tokens"]
---

# Gets a new blank client payment token object

`GET /api/v1/client_gateway_tokens/create`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/client_gateway_tokens/create`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/client_gateway_tokens/create/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a blank object with default values

## Query parameters

- `include` string

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Response `200`

A blank client payment token object

- ClientGatewayToken
  - `id` string: The hashed id of the client gateway token
  - `client_id` string: The hashed_id of the client
  - `token` string: The payment token
  - `routing_number` string: THe bank account routing number
  - `company_gateway_id` string: The hashed id of the company gateway
  - `is_default` boolean: Flag determining if the token is the default payment method

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `429`: Rate Limit Exceeded
- `5XX`: Server error
- `default`: Unexpected Error

## Changes

- **2026-04-20** `69a36036d334`: 1 info
  - the response optional property `id` became read-only for the status `200`
- **2024-06-06** `8e82a2bd77e0`: 1 breaking, 2 info
  - the response's body type changed from no type to `object` for status `default`
  - added the optional property `code` to the response with the `default` status
  - added the optional property `message` to the response with the `default` status
- **2024-06-05** `e61df65649e2`: 1 breaking, 2 warning
  - the response's body type changed from `object` to no type for status `default`
  - removed the optional property `code` from the response with the `default` status
  - removed the optional property `message` from the response with the `default` status
- **2024-03-09** `9772f0a059b2`: 1 info
  - added the non-success response with the status `429`
- **2024-03-07** `71171a40d629`: 5 breaking, 13 info
  - the response's body type changed from no type to `object` for status `200`
  - the response's body type changed from no type to `object` for status `401`
  - the response's body type changed from no type to `object` for status `403`
  - the response's body type changed from no type to `object` for status `422`
  - …14 more

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/client_gateway_tokens/create/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)