Account Balance API

Account Balance manages wallet-style balances, credit/debit movements, totals, and transaction history.

Base URL

https://your-instance.pubflow.com/bridge-payment/account-balance

Feature Flags

• ACCOUNT_BALANCE_ENABLED
• ACCOUNT_BALANCE_REQUIRE_AUTH
• ACCOUNT_BALANCE_ALLOWED_ROLES

User Operations

List my balances

GET

/bridge-payment/account-balance/me/balances

Returns authenticated user balances with optional filters.

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Query Parameters

limit

Typeinteger

Default100

reference_code

Typestring

balance_type

Typestring

Valid values

"general""credits""promotional""refund"

status

Typestring

Valid values

"active""suspended""expired""closed"

organization_id

Typestring

project_id

Typestring

currency

Typestring

Responses

Balances retrieved

GET

/bridge-payment/account-balance/me/balances

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

limit

reference_code

balance_type

status

organization_id

project_id

currency

Samples

Powered by VitePress OpenAPI

Get my total balance

GET

/bridge-payment/account-balance/me/total

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Query Parameters

currency

Typestring

Default"USD"

Responses

Total balance returned

GET

/bridge-payment/account-balance/me/total

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

currency

Samples

Powered by VitePress OpenAPI

Get balance by ID

GET

/bridge-payment/account-balance/{id}

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Path Parameters

id*

Typestring

Required

Responses

Balance retrieved

GET

/bridge-payment/account-balance/{id}

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI

Create balance

POST

/bridge-payment/account-balance

Creates an account balance ledger row with ownership checks.

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Request Body

application/json

{

"user_id": "string",

"organization_id": "string",

"project_id": "string",

"customer_id": "string",

"balance_type": "general",

"balance_cents": 0,

"currency": "USD",

"reference_code": "string",

"expires_at": "string",

"status": "active",

"metadata": {

"additionalProperties": "string"

}

}

Responses

Balance created

POST

/bridge-payment/account-balance

Playground

Server

Authorization

SessionAuth

Body

Samples

Powered by VitePress OpenAPI

Credit balance

POST

/bridge-payment/account-balance/{id}/credit

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Path Parameters

id*

Typestring

Required

Request Body

application/json

{

"amount_cents": 0,

"description": "string"

}

Responses

Balance credited

POST

/bridge-payment/account-balance/{id}/credit

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

id*

Body

Samples

Powered by VitePress OpenAPI

Debit balance

POST

/bridge-payment/account-balance/{id}/debit

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Path Parameters

id*

Typestring

Required

Request Body

application/json

{

"amount_cents": 0,

"description": "string",

"allow_negative": true

}

Responses

Balance debited

POST

/bridge-payment/account-balance/{id}/debit

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

id*

Body

Samples

Powered by VitePress OpenAPI

List balance transactions

GET

/bridge-payment/account-balance/{id}/transactions

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Path Parameters

id*

Typestring

Required

Query Parameters

limit

Typeinteger

Default100

Responses

Transactions retrieved

GET

/bridge-payment/account-balance/{id}/transactions

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

id*

limit

Samples

Powered by VitePress OpenAPI

Get balance statistics

GET

/bridge-payment/account-balance/{id}/statistics

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Path Parameters

id*

Typestring

Required

Responses

Statistics retrieved

GET

/bridge-payment/account-balance/{id}/statistics

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI

Admin Operations

List balances for specific user (admin)

GET

/bridge-payment/account-balance/users/{user_id}/balances

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Path Parameters

user_id*

Typestring

Required

Query Parameters

limit

Typeinteger

Default100

Responses

User balances retrieved

GET

/bridge-payment/account-balance/users/{user_id}/balances

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

user_id*

limit

Samples

Powered by VitePress OpenAPI

Get user total balance (admin)

GET

/bridge-payment/account-balance/users/{user_id}/total

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Path Parameters

user_id*

Typestring

Required

Query Parameters

currency

Typestring

Default"USD"

Responses

User total returned

GET

/bridge-payment/account-balance/users/{user_id}/total

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

user_id*

currency

Samples

Powered by VitePress OpenAPI

List expiring balances (admin)

GET

/bridge-payment/account-balance/expiring

Authorizations

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters

Query Parameters

days

Typeinteger

Default7

Responses

Expiring balances returned

GET

/bridge-payment/account-balance/expiring

Playground

Server

Authorization

SessionAuth

Variables

Key

Value

days

Samples

Powered by VitePress OpenAPI