Integration help and documentation feedback.

the partner's keys: prefix, label, active flag, dates. raw keys are never returned.

legacy service keys are rejected: a partner api key is required

rate limit exceeded (default 60 requests/minute per api key; session-authenticated cabinet operations are counted per partner); the retry-after header gives seconds until the window resets

creates a new fl_live_… key (partner session auth, not an api key: a key must not be able to mint keys). the raw value is returned exactly once — store it immediately.

access denied; a cabinet session is required, not an api key

deactivates one of your keys by its id (partner session auth). idempotent: a foreign id matches nothing and returns no error.

returns total (lifetime credited), used (lifetime confirmed spend), reserved (held by open task reservations), available (total − used − reserved, floored at 0) and the islow flag. amounts are in franks (₣), the platform's internal accounting unit.

creates an invoice via t-bank business; on payment the balance is credited automatically (rub→₣ 1:1). limit: 3 requests/min. replace sample company details with your own; obtain expectedprofilerevision from the current get /v1/billing/legal-invoices/profile response.

legal invoices with statuses, amounts and credit dates.

page

limit

the company profile used for legal invoicing (tax id, name, address, etc.).

creates or updates the invoicing company profile. replace sample company details with your own; obtain expectedprofilerevision from the current get /v1/billing/legal-invoices/profile response.

the invoice pdf (inline; occasionally a redirect to the bank's file). limit: 12 requests/min.

fetches the current invoice status from the bank. limit: 6 requests/min.

creates an sbp b2b payment qr link for the invoice. limit: 6 requests/min.

the list of top-up payments with their statuses (pending/authorized/confirmed/canceled/rejected/failed). returns the last 50 payments.

creates a t-bank payment link for topping up the balance (rub→₣ 1:1). the idempotency-key header is required: a retry with the same key returns the same payment instead of creating a new one. card saving is not available programmatically. the link is opened by the payer in a browser. limit: 3 requests/min.

idempotency key (up to 128 chars; a retry with the same key and amount returns the same payment, a different amount yields 409)

idempotency-key

payment created (or an existing one returned): paymenturl to pay

missing/invalid idempotency-key or amount out of range

the base price showcase grouped by media family (video/image/audio/text/processing) with billing units. all prices are in franks — the platform's internal accounting unit (not a currency); the item.unitofaccount field is 'франки'. the item.currency field is a deprecated alias of unitofaccount (transition period, will be removed). the response is not cached (no-store); re-reading once per 24 hours is enough (refreshafterseconds).

a side-effect-free cost quote for a planned operation at your tariff (the same seam that reserves funds on submit). pass the model and parameters; media urls are not accepted — pass reference counts instead.

the effective tariff (base/pro/max/ultra), assigned and earned plans, lifetime spend (₣), the next tier and the spend still required, plus the discount percent against the base price list.

paginated ledger of operations: type (topup/reservation/confirm/refund; debit is a rare legacy row kind), amount in ₣, price per unit, task, date, attribution. pagination by page/limit (limit ≤ 100).

filter by transaction type (debit is a legacy row kind)

type

whose top-ups to show: all / company / personal

attribution

datefrom

dateto

csv download of the ledger (attachment). same filters as the list endpoint; up to 10,000 rows per export — beyond that a `# truncated: …` comment line with the full count is appended.

format

whose top-ups to include: all / company / personal

confirmed spend per utc day: confirm rows minus task-less refunds.

the partner's last 50 deliveries with statuses (pending/delivering/delivered/uncertain/dead_lettered), attempts and response codes.

endpointid

status

re-queues a delivery (uncertain, dead_lettered or delivered) under the same eventid. limit: 30 requests/min.

the partner's endpoints: url, subscriptions, active flag. secrets are never returned.

creates an endpoint; the whsec_… secret is returned exactly once. the url must be public https; internal addresses are rejected. up to 10 endpoints per partner. limit: 10 requests/min.

endpoint created; the secret is shown once

deletes one of your endpoints; its pending deliveries go with it.

generates a new signing secret; the new value is returned exactly once. the old secret keeps working for 6 more hours (grace window): deliveries are signed with the new secret (x-franklab-signature) and additionally with the previous one (x-franklab-signature-previous) — during the grace window the receiver may verify either signature. the response carries previoussecretvaliduntil, the end of the window. after the window the previous secret is wiped. limit: 10 requests/min.

enqueues a webhook.test event for exactly this endpoint — verify receipt and the signature. limit: 6 requests/min.

Support

Work with an AI assistant

What to include