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/ephemeral_keys

Create an ephemeral key

Creates a short-lived API key for a given resource.

Request parameters

Field	Type	Description
`customer`	string	The ID of the Customer you'd like to modify using the resulting ephemeral key.
`expand`	array of string	Specifies which fields in the response should be expanded.
`issuing_card`	string	The ID of the Issuing Card you'd like to access using the resulting ephemeral key.
`nonce`	string	A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.
`verification_session`	string	The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key

Responses

HTTP 200: Successful response.

Field	Type	Description
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`expires` required	integer	Time at which the key will expire. 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.
`secret`	string	The key's secret. You can use this value to make authorized requests to the Stripe API.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

DELETE /v1/ephemeral_keys/{key}

Immediately invalidate an ephemeral key

Invalidates a short-lived API key for a given resource.

Request parameters

Parameter	Location	Type	Description
`key`	path	string

Field	Type	Description
`expand`	array of string	Specifies which fields in the response should be expanded.

Responses

HTTP 200: Successful response.

Field	Type	Description
`created` required	integer	Time at which the object was created. Measured in seconds since the Unix epoch.
`expires` required	integer	Time at which the key will expire. 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.
`secret`	string	The key's secret. You can use this value to make authorized requests to the Stripe API.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors