API Reference

The BTPay REST API allows you to integrate cryptocurrency payments into your business.

API Endpoint

https://api.digital.blackthornfs.com

Authorization

UniXPay APIs are secured using Bearer API Tokens. Bearer tokens enable requestes to authenticate using an access key, such as a JSON Web Token (JWT).

Authorization: Bearer <token>

Content Type

For all requests you need to use the next format key in the headers.

"Content-Type": "application/json"

Date Formatting

It is important to have the proper format for the date field in all API requests. We use basic ISO 8601 format for mixed date-time: YYYY-MM-DDThh:mm:ss YYYY is the 4-digit year MM is the 2-digit month (zero-padded) DD is the 2-digit day (zero-padded) T is a constant to indicate that the time follows hh is the 2-digit hour (zero-padded) mm is the 2-digit minute (zero-padded) ss is the 2-digit second (zero-padded)

While the ISO 8601 standard does support some versions of timezone syntax, we recommend leaving timezones off all date/time parameter values. SupraPay treats and stores all date/time values in UTC.

All dates and times are stored and displayed in UTC (Greenwich Mean Time) timezone.

Responses

All responses are returned as JSON in the Body of the response.

When successful, the HTTP Response Code is 200 and the response data is in the Body. When it fails, the HTTP Response Code reflects the type of error; if the API generates the response, the Body contains a JSON object of the form:

{ ‘errors’: ‘message’ }