Welcome to the FarPay API Documentation

This portal is your main resource for learning and integrating with the FarPay API. The documentation is structured to make it easy for both technical and non-technical users to understand the API and get started quickly.

Everything you need — from object definitions to authentication and usage examples — is available right here in ReadMe.io.

Getting Started

Here are a few key things to know before you begin:

Business-Oriented Terminology: Our API uses terms that are intuitive and easy to understand, even for non-developers.

Versioned API: Each version of the API is clearly defined. The current version is v2, and it is accessed like this:

https://api.farpay.io/v2

Authentication Required: All endpoints require an API key. Learn how to get your API key here.

Date Formats:

• Input: yyyy-MM-dd
• Output: yyyy-MM-ddThh:mm:ssZ

Standard HTTP Methods:

• GETfor retrieving collections or specific items
• POST, PUT, PATCH, DELETE as applicable for other operations (details provided per endpoint)

Using the API

Each object and endpoint is described in this documentation, including structure, usage examples, and explanations. You can:

• Learn the structure and fields of each object
• Understand how endpoints relate to business workflows
• Copy example requests and responses
• Test API calls using your API key in an external tool (e.g. Swagger UI or Postman)

Endpoint Access

All endpoints follow a consistent structure. For example, to fetch a specific invoice:

GET https://api.farpay.io/v2/invoices/<invoice_id>

Collection requests use simple GET calls:

GET https://api.farpay.io/v2/invoices

Try It Out

While ReadMe.io is our primary source of documentation, you can also test all the endpoints using ReadMe.io:

• API References – interactive testing tool
• Swagger Docs - raw JSON

Be sure to enter your API key or set request headers to test authenticated routes.

Release Notes

Stay up to date with changes and improvements in our Release Notes.

Object Overview

Each object is documented in detail in this hub. Use the table below to navigate directly to the relevant documentation.

Trial Access

You can try FarPay for free by applying here. After registration, you can generate an API key by clicking Settings → API Access.

Need Help?

If you're an enterprise user, you also have access to our support and ticketing system. You can raise issues, request features, or get help directly from our team.

Now that you're familiar with the basics, start exploring the object pages and endpoints in this hub to begin your integration.