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.

GET /v1/forwarding/requests

List all ForwardingRequests

Lists all ForwardingRequest objects.

Request parameters

Parameter	Location	Type	Description
`created`	query	object	Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
`ending_before`	query	string	A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`limit`	query	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
`starting_after`	query	string	A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`data` required	array of forwarding.request
`has_more` required	boolean	True if this list has another page of items after this one that can be fetched.
`object` required	string	String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
`url` required	string	The URL where this list can be accessed.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/forwarding/requests

Create a ForwardingRequest

Creates a ForwardingRequest object.

Request parameters

Field	Type	Description
`expand`	array of string	Specifies which fields in the response should be expanded.
`metadata`	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
`payment_method` required	string	The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
`replacements` required	array of string	The field kinds to be replaced in the forwarded request.
`request`	object	The request body and headers to be sent to the destination endpoint.
`url` required	string	The destination URL for the forwarded request. Must be supported by the config.

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.
`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`.
`metadata`	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`payment_method` required	string	The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
`replacements` required	array of string	The field kinds to be replaced in the forwarded request.
`request_context`	one of multiple schemas	Context about the request from Stripe's servers to the destination endpoint.
`request_details`	one of multiple schemas	The request that was sent to the destination endpoint. We redact any sensitive fields.
`response_details`	one of multiple schemas	The response that the destination endpoint returned to us. We redact any sensitive fields.
`url`	string	The destination URL for the forwarded request. Must be supported by the config.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/forwarding/requests/{id}

Retrieve a ForwardingRequest

Retrieves a ForwardingRequest object.

Request parameters

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

object. See the OpenAPI specification for the complete schema.

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.
`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`.
`metadata`	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`payment_method` required	string	The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
`replacements` required	array of string	The field kinds to be replaced in the forwarded request.
`request_context`	one of multiple schemas	Context about the request from Stripe's servers to the destination endpoint.
`request_details`	one of multiple schemas	The request that was sent to the destination endpoint. We redact any sensitive fields.
`response_details`	one of multiple schemas	The response that the destination endpoint returned to us. We redact any sensitive fields.
`url`	string	The destination URL for the forwarded request. Must be supported by the config.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors