Typecastle API

​

Introduction

The Typecastle API is built on REST principles, ensuring a stateless, scalable, and reliable interface for interacting with merchant accounts on behalf of customers.

Our API reference provides all the necessary details to integrate Typecastle’s features into your application, including endpoint descriptions, request and response formats, and examples.

​

Base URL

Append an endpoint to the base URL root address to form a complete request URL.

https://api.typecastle.com/

​

Authentication

All API endpoints are authenticated using API keys. Include the following headers in every request.

headers = {
  "X-Api-Key-Id": "{yourkeyid}",
  "X-Api-Key": "{yourkeyvalue}"
}

​

Authorization

We reserve the Authorization header for endpoints that require an authorization token. See creating tokens to understand token types and when to use them.

headers = {
  ...
  "Authorization": "Bearer: {token}"
}