Skip to main content
Version: v1

Voucherly API

Introduction

The Voucherly API is organized around REST. Our API has predictable resource-oriented URLs, accepts request bodies and returns responses in JSON-encoded format (using camelCase notation), and uses standard HTTP response codes, authentication, and verbs.

You can use the Voucherly API in sandbox mode, which doesn't affect your live data or interact with the banking networks. The API key you use to authenticate the request determines whether the request is live mode or test mode.

https://api.voucherly.it

Authentication

The Voucherly API uses API keys to authenticate requests. Sandbox mode secret keys have the prefix sk_sand_ and live mode secret keys have the prefix sk_live_. You can view and manage your API keys in the Voucherly Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Provide your API key as the "Voucherly-API-Key" header. For example:

-H  "Voucherly-API-Key: sk_sand_BYsZDnaUWfVKGwHFvLop0dc9Fp1mE8py2Mtgm5aU6IrtCiuJg9s4747J"

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Authentication

Sandbox mode secret keys have the prefix sk_sand_ and live mode secret keys have the prefix sk_live_.

Security Scheme Type:

apiKey

Header parameter name:

Voucherly-API-Key

Contact

API Support: support@voucherly.it