Top-up status, including intermediate provider states

GET

/billing/topups/{topup_id}

const url = 'https://api.flotera.com/api/v1/billing/topups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-erm_session=<__Host-erm_session>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.flotera.com/api/v1/billing/topups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie __Host-erm_session=<__Host-erm_session>

The only authoritative source of payment outcome. partially_paid is progress information, not an operator decision, and does not move the balance (D-13).

Authorizations

sessionCookie

Parameters

Path Parameters

topup_id

required

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

Responses

200

Top-up.

application/json

object

required

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

status

required

Internal top-up state (14 §6.3). Exactly one of them means the money arrived: succeeded.

partially_paid is progress information — the customer under-paid but the payment is still moving. It does not park the top-up for an operator and it does not move the balance (D-13).

review means invoice/order/currency disagreement, an unknown provider status or an ambiguous create — a human has to look.

string

Allowed values: creating provider_unknown waiting_for_customer confirming confirmed settling partially_paid succeeded failed expired reversed review

amount_usd

required

Invoiced amount. What was credited is the confirmed amount, not this.

string

/^[0-9]+(\.[0-9]{1,6})?$/

payment_method

required

Code from the server-owned catalogue, e.g. card or usdt_tron. The catalogue depends on which providers the operator has enabled, so a code that worked yesterday may be absent today — always take the list from GET /billing/payment-methods.

string

<= 32 characters /^[a-z][a-z0-9_]{1,31}$/

provider

required

string

<= 32 characters

checkout_url

Hosted provider page. Open it as external navigation — never inject it as HTML. Absent once the top-up reaches a terminal state.

string | null format: uri

<= 2048 characters

expires_at

RFC 3339 UTC with microsecond precision, or null.

string | null format: date-time

created_at

required

RFC 3339 UTC with microsecond precision.

string format: date-time

Example

{
  "status": "creating",
  "created_at": "2026-07-25T10:15:30.123456Z"
}

401

Missing/invalid credentials (code=unauthorized).

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

Allowed values: unauthorized forbidden csrf_rejected not_found conflict idempotency_conflict validation_failed rate_limited payload_too_large unsupported_agent_version temporarily_unavailable offline_queue_full online_queue_full plan_required server_limit_reached feature_not_entitled account_in_grace account_frozen payment_pending payment_expired payment_amount_mismatch change_already_pending change_already_applied change_effective reserve_not_covered direction_changed

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}

403

Authenticated but not permitted. code=forbidden — role/scope mismatch; code=feature_not_entitled — the plan does not include the capability; code=account_frozen — the account is frozen and this operation is declared x-ermeon-frozen: deny. The three are deliberately distinct: only the last one is fixed by a top-up (13 §5.6).

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}

404

Resource does not exist in this tenant. Foreign identifiers also return 404 (anti-enumeration).

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}