Light APIv1.0.0

Introduction

Welcome to the Light API documentation.

The Light API is organised around REST and uses standard HTTP response codes, authentication and verbs. Most endpoints accept and return JSON-encoded data in camel case.

All requests go to:

https://api.light.inc

Start with Authentication to get a key, then browse the API reference for the endpoint you need.

Enum values and forward compatibility

Some fields in this API use enumerated (enum) values to represent specific states or types. While these enums are fully documented, they are not guaranteed to be exhaustive. New enum values may be introduced over time as the system evolves.

To maintain forward compatibility:

  • Always handle unexpected or unknown enum values gracefully.
  • Avoid assuming the list of values is complete or immutable.
  • Where possible, use string-based comparisons or a safe fallback rather than exhaustive matching.

This policy allows Light to extend functionality without introducing breaking changes for consumers who implement robust handling.

Amounts

Amounts are integers in minor units — 1250 USD is 12.50 USD and 150 JPY is 150 JPY. Each amount is paired with its currency in the same object.