archive_account
Archive an orphaned FA anchor. Unknown id -> success with empty data.
Code
archive_account › Request Body
financial_account_idThe BriteCore anchor to archive.
archive_account › Responses
The archived anchor, or an empty array when the id is unknown.
successIndicates if the request was successful
Any messages or errors related to the request
check_source_balance
One funding source's advisory available balance -- the Check balance action.
Code
check_source_balance › Request Body
integration_instance_idThe funding integration instance, from describe_connection.
funding_source_idThe BriteCore funding-source row id, from list_funding_sources. A source the vendor lists but BriteCore has never linked has a null source_id there and cannot be checked until it is linked.
check_source_balance › Responses
successIndicates if the request was successful. True even when available is null -- an unavailable peek is a normal outcome for an advisory read, not a failed request.
Any messages or errors related to the request
describe_connection
Is funding configured on this site, under which instance, and what may this caller do.
Code
describe_connection › Request Body
describe_connection › Responses
successIndicates if the request was successful
Any messages or errors related to the request
get_financial_account_balance
The FA's live balance, in dollars -- the overview's balance card.
Code
get_financial_account_balance › Request Body
integration_instance_idThe funding integration instance, from describe_connection.
financial_account_idThe BriteCore financial-account anchor to read, from reconcile_view. The stored vendor handle is resolved server-side; a vendor reference is deliberately NOT accepted here.
get_financial_account_balance › Responses
successIndicates if the request was successful
Any messages or errors related to the request
link_funding_source
First-time link of a live vendor source into BC's waterfall.
Code
link_funding_source › Request Body
integration_instance_idThe funding integration instance, from describe_connection.
vendor_reference_idThe live vendor source handle to link.
priorityWaterfall position; defaults to 1 when omitted.
link_funding_source › Responses
A BriteCore funding-source row. Stores only the waterfall priority policy for a vendor source; display and status stay vendor-owned.
successIndicates if the request was successful
Any messages or errors related to the request
list_financial_account_transactions
One page of the FA's live ledger -- the overview's Account activity card.
Code
list_financial_account_transactions › Request Body
integration_instance_idThe funding integration instance, from describe_connection.
financial_account_idThe BriteCore financial-account anchor whose ledger to read, from reconcile_view. The stored vendor handle is resolved server-side.
cursorOpaque vendor pagination cursor. Omit for the first page; pass the previous response's next_pagination_cursor for the next. User-paged ('Load more'), not a background sweep.
list_financial_account_transactions › Responses
successIndicates if the request was successful
Any messages or errors related to the request
list_funding_requests
BC's money-IN log for one FA, newest first -- the "Money added" card.
Code
list_funding_requests › Request Body
financial_account_idThe BriteCore financial-account anchor whose money-IN log to read.
limitPage size, default 25 and capped at 100. Out-of-range and missing values are clamped rather than rejected: a bad page size on a read has an obvious safe answer, unlike a bad id. The cap is what matters -- the log is never pruned.
offsetRows to skip, default 0. Combined with has_more this drives Load more.
list_funding_requests › Responses
successIndicates if the request was successful
Any messages or errors related to the request
list_funding_sources
The live vendor source set, left-joined with BC's stored waterfall state.
Code
list_funding_sources › Request Body
integration_instance_idThe funding integration instance, from describe_connection.
list_funding_sources › Responses
successIndicates if the request was successful
Any messages or errors related to the request
manage_account
Onboard a discoverable vendor FA as a BC anchor; returns the anchor.
manage_account › Request Body
integration_instance_idThe funding integration instance, from describe_connection.
vendor_reference_idThe discoverable vendor account handle to onboard.
manage_account › Responses
A BriteCore financial-account anchor. A pure handle: the vendor reference plus its integration binding. Everything displayable about the account (balance, status, nickname, features) is vendor-owned and read live, never stored here.
successIndicates if the request was successful
Any messages or errors related to the request
reconcile_view
Diff the live vendor FA set against BC's stored anchors; persists nothing.
Code
reconcile_view › Request Body
integration_instance_idThe funding integration instance, from describe_connection.
reconcile_view › Responses
successIndicates if the request was successful
Any messages or errors related to the request
request_source_entry
Mint a vendor source-entry session and return the embed payload verbatim.
Code
request_source_entry › Request Body
integration_instance_idThe funding integration instance, from describe_connection.
request_source_entry › Responses
Vendor-shaped embed payload, rendered verbatim.
successIndicates if the request was successful
Any messages or errors related to the request
set_source_priority
Re-position an already-linked source in the waterfall by BC row id.
Code
set_source_priority › Request Body
funding_source_idThe stored BriteCore source row.
priorityNew waterfall position; 1 is tried first.
set_source_priority › Responses
The updated row, or an empty array when the id is unknown.
successIndicates if the request was successful
Any messages or errors related to the request
top_up
Pull amount dollars from a source into the FA -- this moves money.
Code
top_up › Request Body
integration_instance_idThe funding integration instance, from describe_connection.
financial_account_idThe BriteCore financial-account anchor to pull money INTO.
funding_source_idThe BriteCore funding-source row to pull money FROM, from list_funding_sources. Must already be linked; a never-linked source has a null source_id there.
amountAmount in DOLLARS. Whole cents only -- a sub-cent value is refused rather than rounded, and zero is refused outright. Validated in the service against the funding schema before any vendor call.
request_idCaller-supplied idempotency key, and ALSO the vendor Idempotency-Key. MINT THIS WHEN THE ADD MONEY MODAL OPENS, not on submit: that is what makes a double-click dedupe to one pull. Re-sending the same id replays the recorded outcome; re-sending it with a DIFFERENT amount, account, or source is rejected, so a client bug cannot masquerade as idempotent success.
top_up › Responses
One row of BriteCore's append-only money-IN log: a top-up BriteCore asked the vendor to perform, and how that call turned out. This is BriteCore's own record, not vendor state, so it can legitimately disagree with the live balance and transaction feeds while a pull settles.
successWhether the request was processed and recorded. Not a statement about whether money arrived.
Any messages or errors related to the request. Two refusals arrive here rather than as an outcome, because no pull was attempted: a request_id already in flight, and an unavailable funding lock (fail-closed, no money moved). A message reporting that a pull was attempted but its audit row did not persist means MONEY MAY HAVE MOVED and must be reconciled against the live feed, never retried blindly.
