Last updated 2 minutes ago

Introduction

The Tilia Pay APIs are the primary means for developers to access the Tilia Pay resources and perform tasks such as registering users, creating invoices, and requesting payouts.

All of our APIs are based on REST architecture and are accessed via HTTPS at specified URLs. Our APIs use JSON as their communication format and the standard HTTP methods like GET, PUT, POST, and DELETE. Refer to the API Reference for the methods available for each endpoint.

Learn more about Tilia Pay resources from our Core Concepts topics. For detailed walk-throughs to help you build your Tilia Pay integration, refer to our Developer Guides.

URI Structure

URIs for Tilia Pay's APIs have the following structure:

https://api-name.environment/version/resource

https://api-name.environment/version/resource_id/resource

In these URIs:

  • api_name is the name of the API, for example, invoicing or registration.
  • environment is the Tilia Pay environment you are working with. Staging is staging.tilia-inc.com, while Production is tilia-inc.com.
  • version is the version of the API or endpoint. Versions are represented as the letter v followed by the version number, for example, v2. Each API endpoint shows the correct version in its usage documentation.
  • resource_id is the unique identifier for the resource.
  • resource is the relative path defined for the resource.

Here are some examples to illustrate the URI structure:

https://registration.staging.tilia-inc.com/v2/register/

https://registration.tilia-inc.com/v2/register/

https://payments.tilia-inc.com/v1/{account_id}/payment_methods

https://payments.staging.tilia-inc.com/v1/{account_id}/payment_methods

All Tilia Pay API requests must be made over HTTPS. Calls made over HTTP will fail.

Staging Environment

The Staging environment mirrors the Tilia Pay Production environment, supporting all of the same API endpoints. Applications should be tested against the Staging environment before being used in production. Here are some key differences from the Production environment:

  • The Staging environment contains test data and is completely separate from your Production environment.
  • Actual money is not sent or received as part of test transactions. Real financial data should not be used in Staging.
  • Test payment methods may only be used in Staging.

API Versions

Non-breaking changes may be introduced to an existing version. Updates are versioned if those updates are considered breaking changes. You can retrieve current version information for each API by appending /info to the API's base URI, for example, GET https://accounts.tilia-inc.com/info.