Merchants
List Fiat Flows
Retrieve a double-entry ledger view of all fiat balance movements for a merchant, including trade lines, fee entries, and rollback events.
GET
/
v2
/
merchant
/
fiat
/
flows
List Fiat Flows
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/fiat/flows \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/fiat/flows"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/merchant/fiat/flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/merchant/fiat/flows")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"id": 123,
"merchantId": 123,
"settingsId": 123,
"txId": "<string>",
"category": "<string>",
"flowType": "<string>",
"fiat": "<string>",
"changed": 123,
"total": 123,
"extId": "<string>",
"createTime": "<string>"
}
]
}
}Use this endpoint to retrieve a granular ledger of fiat balance changes for a merchant account. Unlike Funding Records (which show aggregate transactions), Fiat Flow records surface the individual double-entry lines — including separate fee entries, rollback events, and transfer movements. This is the recommended endpoint for building real-time balance reconciliation and accounting exports.
All requests must include the
X-BH-TOKEN header with a business token from GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/merchant/fiat/flows
Query Parameters
integer
Filter by the merchant’s ID.
string
Filter by fiat currency code.
integer
Filter by a specific funding transaction ID.
string
Filter by flow type. Accepted values:
ALL— all types (default)DEPOSIT— incoming depositWITHDRAW— outgoing withdrawalWITHDRAW_ROLLBACK— reversal of a withdrawalBUY_CRYPTO— crypto purchase debitBUY_CRYPTO_ROLLBACK— reversal of a crypto purchaseREFUND— refund creditREFUND_ROLLBACK— reversal of a refundTRANSFER_IN— internal transfer creditTRANSFER_OUT— internal transfer debit
integer
Start of the date range as a Unix timestamp in milliseconds.
integer
End of the date range as a Unix timestamp in milliseconds.
integer
Page number to retrieve (1-based). Defaults to
1.integer
Number of records per page. Default is
10, maximum is 1000.Response Fields
number
HTTP-style response code.
200 indicates success.string
Human-readable status message, e.g.
SUCCESS.object
Show data fields
Show data fields
number
Current page number returned.
number
Number of records on this page.
number
Total number of flow records matching the query.
array
Show record item fields
Show record item fields
number
Unique ID of this fiat flow line.
number
ID of the merchant this flow line belongs to.
number
ID of the merchant account (payment channel settings).
string
ID of the parent funding transaction.
string
High-level category:
TRADE, FEE, or TRANSFER.string
Specific flow type (see query parameter values above).
string
Fiat currency of this flow line.
number
Amount the balance changed. Positive = credit, negative = debit.
number
Running balance after applying this flow line.
string
External reference ID linking to the related order or record.
string
Unix timestamp (milliseconds) when the flow line was created.
Example
cURL
curl -G https://api.velafi.com/v2/merchant/fiat/flows \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=3" \
--data-urlencode "fiat=MXN" \
--data-urlencode "flowType=DEPOSIT" \
--data-urlencode "pageSize=10"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"currentPage": 1,
"size": 10,
"total": 100,
"record": [
{
"id": 282,
"merchantId": 3,
"settingsId": 3,
"txId": "573901321954934784",
"category": "TRADE",
"flowType": "DEPOSIT",
"fiat": "MXN",
"changed": 105.61,
"total": 37042.07,
"extId": "573901321434841088",
"createTime": "1737452292000"
}
]
}
}
Each trade typically generates at least two flow lines — one
TRADE line for the principal and one FEE line for the fee. Filter by category to separate them in your accounting workflow.Was this page helpful?
⌘I
List Fiat Flows
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/fiat/flows \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/fiat/flows"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/merchant/fiat/flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/merchant/fiat/flows")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"id": 123,
"merchantId": 123,
"settingsId": 123,
"txId": "<string>",
"category": "<string>",
"flowType": "<string>",
"fiat": "<string>",
"changed": 123,
"total": 123,
"extId": "<string>",
"createTime": "<string>"
}
]
}
}