POST /api/adbalance

Request	`POST /api/adbalance`
Authentication	Session cookie required
Handler	`backend/adbalance.py`

What it does

Opens a payment session for the named amount and returns its URL and reference. `charged_yet` is false: the balance moves only when the provider confirms the payment.

Authentication

Session cookie required. Send the ff_session cookie. Without one the engine treats the caller as a new visitor with no holds and no claims, and returns a new cookie to use from then on.

Parameters

Parameter	In	Type	Required	Description
`ff_session`	cookie	`string`	Optional	The session identifier. Omit it on the first call and store the value the response sets; every later call must send the same one or the engine treats the caller as a new visitor with no holds and no claims.
`amount_minor`	body	`integer`	Required	The amount to add, in the currency's minor units.

Request

The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.

cURLJavaScriptPython

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"amount_minor":"<integer>"}' \
  "https://flowfinds.ai/api/adbalance"

const res = await fetch("https://flowfinds.ai/api/adbalance", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "amount_minor": "<integer>"
  }),
});
const data = await res.json();

import requests

s = requests.Session()
r = s.post("https://flowfinds.ai/api/adbalance", json={
    "amount_minor": "<integer>"
  })
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"amount_minor":5000}' \
  "$FLOWFINDS_ORIGIN/api/adbalance"

Responses

`200` — A payment session opened.

Field	Type	Description
`status`	`string`	`topup_started`.
`reference`	`string`	The provider's order reference.
`pay_url`	`string`	Where to send the browser.
`amount`	`string`	The amount formatted for display.
`amount_minor`	`integer`	The amount in minor units.
`currency`	`string`	The ledger currency.
`charged_yet`	`boolean`	False.

Errors

Status	Reason	When
`400`	—	`amount_minor` is missing or not a usable amount.
`401`	—	The session has no account.
`502`	—	The payment provider answered with an error.

GET /api/ad — The ad artifact for the session's product, with its pass criteria.
POST /api/ad/edit — Override the ad copy, or reset it to the generated version.
POST /api/growth/edit — Edit a growth artifact in natural language.
GET /api/ads-manager — The campaign book.
POST /api/ads-manager — Save the campaign book.
GET /api/adbalance — The advertising balance, its ledger and any pending top-ups.
GET /api/adbalance/confirm — Retired. Balance confirmation is no longer client-driven.
POST /api/organic/research — Research an organic campaign for named platforms.

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.