/ API reference / Get started / Introduction

Introduction

Learn about request and response formatting, base URLs, and authentication.

How to use our API

The Equals Money API is RESTful, authenticates using API keys, form-encoded request bodies, returns JSON-encoded responses. It uses standard HTTP response codes, authentication, and verbs. We provide a testing environment called sandbox, so that you can safely try out the API without affecting any of your live data.

What's REST?

The Equals Money API conforms to the REST (Representational State Transfer) design principles. When a client requests a resource, our server transfers back the current state of this resource in a standardised representation using HTTP (Hypertext Transfer Protocol). This means that all requests and responses follow the same overall formatting.

Base URLs

Every request uses one of the two following URLs, depending on whether you're working in your live environment (production) or your test environment (sandbox).

https://api.equalsmoney.com

https://api-sandbox.equalsmoney.com

Authentication

The Equals Money API uses API keys to authenticate requests. These are provided during the onboarding process (one per environment).

To authenticate, you need to include an Authorization header in all of your requests. In this header, you must state that you're using an API key (similar to HTTP basic access authentication).

For example, if your API key is 1070598f-6540-4c8a-b08f-f7c33dcc726a:

  'https://api.equalsmoney.com/v2/webhooks' \
  -H 'Authorization: ApiKey 1070598f-6540-4c8a-b08f-f7c33dcc726a'

If the API key isn’t valid, you’ll receive a 403 response. If you don’t provide an Authorization header at all, you’ll receive a 401.