Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.erysta.com/llms.txt

Use this file to discover all available pages before exploring further.

Your financial standing is the engine of your integration. The Erysta API allows you to monitor your purchasing power in real-time, ensuring that your automated procurement flows never skip a beat due to insufficient funds. This section covers how we calculate your spending capacity and how to programmatically track your transactions.

​
Financial Models

To support businesses of all sizes, Erysta offers two distinct financial models. By default, all new accounts operate on a Prepaid basis.

​
1. Prepaid Balance (Default)

Most partners operate by “topping up” their account. You deposit funds via the dashboard or with our support team, and these funds are deducted as you place orders.
  • Spending Limit = Your current balance.
  • Top-up: Managed manually via the Erysta Dashboard or with our team.

​
2. Authorized Credit Line (On-Demand)

For high-volume partners or established businesses, Erysta can authorize a Credit Limit. This acts as a safety net or a “post-paid” facility, allowing you to continue operations even if your liquid balance is exhausted.
  • Spending Limit = Balance + Credit Limit.
  • Activation: This feature is not enabled by default. It is granted only upon manual review or specific request to our team.
If you haven’t requested a credit line, your credit_limit will always return 0. Your total purchasing power will be strictly limited to your prepaid funds.

​
The Balance Object

When you call GET /balance, the details.data object contains the following fields:
​
balance
number
required
Your current liquid funds in EUR (decimal format). For example, 150.50 represents 150.50€. This value can be negative if you are currently using your credit line.
​
credit_limit
number
required
Your authorized overdraft limit in EUR (decimal format). This is a fixed value granted by Erysta.

​
Metadata (Extensions)

Every response includes an extensions object for debugging and cache tracking:
​
cache
string
Indicates if the response was served from cache (HIT) or freshly generated (no-store).
​
trace_id
string
A unique request identifier. Please provide this ID when contacting support about a specific request.
​
timestamp
string (ISO 8601)
The exact time the server processed the request.