API reference

Test mode. Use your secret key on your server; live processing is currently disabled.

https://api.knoxapi.com

Send form-encoded requests with Authorization: Bearer sk_test_....

Complete OpenAPI specification · Integration guide

Operations and schemas are based on the pinned Stripe OpenAPI specification (MIT). Nested object definitions and enums are available in the complete specification.

POST /v1/tokens

Create a bank account token

Creates a single-use token that represents a bank account’s details. You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

Request parameters

Field	Type	Description
`account`	object	Information for the account this token represents.
`bank_account`	object	The bank account this token will represent.
`card`	one of multiple schemas	The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.
`customer`	string	Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://docs.stripe.com/connect/standard-accounts) or [Stripe-Account header](https://docs.stripe.com/connect/authentication). Learn more about [cloning saved payment methods](https://docs.stripe.com/connect/cloning-saved-payment-methods).
`cvc_update`	object	The updated CVC value this token represents.
`expand`	array of string	Specifies which fields in the response should be expanded.
`person`	object	Information for the person this token represents.
`pii`	object	The PII this token represents.

Responses

HTTP 200: Successful response.

Field	Type	Description
`bank_account`	bank_account
`card`	card
`client_ip`	string	IP address of the client that generates the token.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`id` required	string	Unique identifier for the object.
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`type` required	string	Type of the token: `account`, `bank_account`, `card`, or `pii`.
`used` required	boolean	Determines if you have already used this token (you can only use tokens once).

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/tokens/{token}

Retrieve a token

Retrieves the token with the given ID.

Request parameters

Parameter	Location	Type	Description
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`token`	path	string

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`bank_account`	bank_account
`card`	card
`client_ip`	string	IP address of the client that generates the token.
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`id` required	string	Unique identifier for the object.
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`type` required	string	Type of the token: `account`, `bank_account`, `card`, or `pii`.
`used` required	boolean	Determines if you have already used this token (you can only use tokens once).

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors