Documentation

POST /api/settings/payout

Save the payout destination.

RequestPOST /api/settings/payout
AuthenticationSession cookie required
Handlerbackend/server.py

What it does

Writes the payout details and returns the destination as stored.

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

ParameterInTypeRequiredDescription
ff_sessioncookiestringOptionalThe 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.
holderbodystringRequiredThe account holder's name.
ibanbodystringRequiredThe account number.
bicbodystringOptionalThe bank identifier.
countrybodystringRequiredThe bank's country.
currencybodystringRequiredThe payout currency.

Request

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

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"holder":"<string>","iban":"<string>","bic":"<string>","country":"<string>","currency":"<string>"}' \
  "https://flowfinds.ai/api/settings/payout"
const res = await fetch("https://flowfinds.ai/api/settings/payout", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "holder": "<string>",
    "iban": "<string>",
    "bic": "<string>",
    "country": "<string>",
    "currency": "<string>"
  }),
});
const data = await res.json();
import requests

s = requests.Session()
r = s.post("https://flowfinds.ai/api/settings/payout", json={
    "holder": "<string>",
    "iban": "<string>",
    "bic": "<string>",
    "country": "<string>",
    "currency": "<string>"
  })
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"holder":"…","iban":"…","country":"HU","currency":"EUR"}' \
  "$FLOWFINDS_ORIGIN/api/settings/payout"

Responses

200Saved.

FieldTypeDescription
statusstring`ok`.
destinationobjectAs stored.

Errors

StatusReasonWhen
400A field is missing or unusable, or there is no account yet.

Related

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