Reference

API Design 🔥

The WoodCore API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the WoodCore API for free in Sandbox mode. This does not affect your data in Production mode, nor does it interact with any production instance from financial service offerings. It is an environment that offers functionality for testing purposes only.

Production mode offers you full, unlimited access to every feature of your selected plan, and begins processing live requests when in use.

🚧

The API key you use to authenticate requests will determine whether the request is in Sandbox or Production mode. API keys for the Sandbox and Production environments are obtained on request at [email protected]


📘

For Sandbox keys, they start with wc_test_{{api_key}} and for Production/Live keys they start with wc_live_{{api_key}}.


API Protocol

The WoodCore API follows the REST standard taking advantage of HTTP methodologies defined by the RFC 2616 protocol. It uses GET/POST requests to communicate and HTTP response codes to indicate status and errors.

All responses come in standard JSON and all requests must include Content-Type: application/json Header, and a valid JSON body when applicable.

The WoodCore API is served over HTTPS TLS v1.2 to ensure data privacy; HTTP or HTTPS with TLS equal 1.1 and below are not supported.

❗️

The API supports only secure communications over HTTPS TLS v1.2 to ensure data privacy. HTTP or HTTPS with TLS under v1.2 are not supported and will be rejected.