API Introduction

Understand general concepts, response codes, and authentication strategies.

Base URL

The vxpay API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. The API does not support HTTP.

All requests contain the following base URL:

https://api.vxpay.co/

Versioning

The API architecture is designed to support versioning through different versions.

The current version route is:

https://api.vxpay.co/v1/

Authentication

To authenticate you need to add an Authorization header with the contents of the header being Bearer KEY where Keyis your API Key (opens in a new tab).

Authorization: Bearer YOUR_API_KEY

Response codes

vxpay uses standard HTTP codes to indicate the success or failure of your requests.

In general, 2xx HTTP codes correspond to success, 4xx codes are for user-related failures, and 5xx codes are for infrastructure issues.

• 200 Successful request.
• 400 Check that the parameters were correct.
• 401 The API key used was missing.
• 403 The API key used was invalid.
• 404 The resource was not found.
• 5xx Indicates an error with vxpay servers.