API reference
Test mode. Use your secret key on your server; live processing is currently disabled.
https://api.knoxapi.comSend 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/country_specs
List Country Specs
Lists all Country Spec objects available in the API.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
ending_before | query | string | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. |
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 cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
data required | array of country_spec | |
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 |
GET /v1/country_specs/{country}
Retrieve a Country Spec
Returns a Country Spec for a given Country code.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
country | path | string | |
expand | query | array of string | Specifies which fields in the response should be expanded. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
default_currency required | string | The default currency for this country. This applies to both payment methods and bank accounts. |
id required | string | Unique identifier for the object. Represented as the ISO country code for this country. |
object required | string | String representing the object's type. Objects of the same type share the same value. |
supported_bank_account_currencies required | object | Currencies that can be accepted in the specific country (for transfers). |
supported_payment_currencies required | array of string | Currencies that can be accepted in the specified country (for payments). |
supported_payment_methods required | array of string | Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges). |
supported_transfer_countries required | array of string | Countries that can accept transfers from the specified country. |
verification_fields required | country_spec_verification_fields |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |