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/mandates/{mandate}

Retrieve a Mandate

Retrieves a Mandate object.

Request parameters

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

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`customer_acceptance` required	customer_acceptance
`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`.
`multi_use`	mandate_multi_use
`object` required	string	String representing the object's type. Objects of the same type share the same value.
`on_behalf_of`	string	The account (if any) that the mandate is intended for.
`payment_method` required	one of multiple schemas	ID of the payment method associated with this mandate.
`payment_method_details` required	mandate_payment_method_details
`single_use`	mandate_single_use
`status` required	string	The mandate status indicates whether or not you can use it to initiate a payment.
`type` required	string	The type of the mandate.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors