/DocsAuthentication
The Flowcard API uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard.
Authenticate
Verify your API key and retrieve current session details.
Parameters
{
"authenticated": true,
"org_id": "org_123456789",
"scopes": [
"cards.read",
"cards.write",
"wallets.read",
"wallets.write",
"transfers.write"
]
}Team & Users
Manage your organization's team members, roles, and access permissions.
List Users
Retrieve a paginated list of all users in your organization.
Parameters
{
"data": [
{
"id": "usr_123",
"email": "alex@company.com",
"role": "admin",
"status": "active"
},
{
"id": "usr_456",
"email": "sarah@company.com",
"role": "member",
"status": "invited"
}
]
}Invite User
Invite a new member to your organization via email.
{
"email": "new.hire@company.com",
"role": "member",
"first_name": "John",
"last_name": "Doe"
}{
"id": "inv_998",
"email": "new.hire@company.com",
"status": "pending",
"expires_at": 1711200000
}Get User
Get detailed information about a specific user.
Parameters
{
"id": "usr_123",
"email": "alex@company.com",
"role": "admin",
"two_factor_enabled": true,
"last_login": 1710900000
}Update User
Update a user's role or profile details.
Parameters
{
"role": "admin"
}{
"id": "usr_123",
"role": "admin",
"updated_at": 1710950000
}Suspend User
Immediately revoke a user's access to the dashboard and API.
Parameters
{
"id": "usr_123",
"status": "suspended"
}Wallets
Create and manage digital wallets for teams or projects.
Create Wallet
Create a new wallet with a specific currency and budget limits.
{
"name": "Marketing Q4",
"currency": "EUR",
"daily_limit": 1000000
}{
"id": "wlt_882",
"name": "Marketing Q4",
"balance": 0,
"status": "active"
}Get Wallet
Retrieve details of a specific wallet.
Parameters
{
"id": "wlt_882",
"balance": 450000,
"currency": "EUR"
}Update Wallet
Update wallet details.
Parameters
{
"name": "Marketing Q4 - Revised"
}{
"id": "wlt_882",
"name": "Marketing Q4 - Revised"
}Freeze Wallet
Temporarily freeze a wallet.
Parameters
{
"id": "wlt_882",
"status": "frozen"
}Close Wallet
Permanently close a wallet.
Parameters
{
"id": "wlt_882",
"status": "closed"
}Virtual Cards
Manage the lifecycle of virtual cards.
Issue Card
Create a new virtual card.
{
"holder_id": "usr_789",
"type": "reloadable",
"limit": 500000
}{
"id": "crd_abc",
"last4": "4242",
"status": "active"
}Get Card
Retrieve card details.
Parameters
{
"id": "crd_abc",
"status": "active",
"balance": 0
}Update Card
Update card details.
Parameters
{
"label": "SaaS Tools"
}{
"id": "crd_abc",
"label": "SaaS Tools"
}Update Limits
Modify spending limits.
{
"monthly_limit": 500000
}{
"success": true
}Freeze Card
Freeze a card.
Parameters
{
"id": "crd_abc",
"status": "frozen"
}Terminate Card
Permanently terminate a card.
Parameters
{
"id": "crd_abc",
"status": "terminated"
}Transactions
Transaction history and details.
List Transactions
List recent transactions.
{
"data": [
{
"id": "txn_1",
"amount": -2900,
"merchant": "AWS"
}
]
}Get Transaction
Get transaction details.
Parameters
{
"id": "txn_1",
"amount": -2900,
"status": "cleared"
}Attach Receipt
Attach a receipt file to a transaction.
Parameters
{
"file_id": "file_999"
}{
"success": true
}Transfers
Internal and external fund transfers.
Internal Transfer
Move funds between wallets.
{
"source": "wlt_A",
"dest": "wlt_B",
"amount": 100
}{
"id": "trf_1",
"status": "completed"
}External Transfer
Wire transfer to external IBAN.
{
"amount": 1000,
"beneficiary": "ben_1"
}{
"id": "trf_2",
"status": "pending"
}Get Transfer
Get transfer status.
Parameters
{
"id": "trf_2",
"status": "processed"
}List Transfers
History of transfers.
{
"data": []
}Simulate Deposit
Sandbox test deposit.
{
"amount": 5000
}{
"new_balance": 5000
}Beneficiaries
Manage external payees.
Create Beneficiary
Save payee details.
{
"name": "Vendor Inc",
"iban": "DE123..."
}{
"id": "ben_1",
"status": "active"
}List Beneficiaries
List all beneficiaries.
{
"data": []
}Get IBANs
Get wallet IBANs.
{
"data": []
}Issue IBAN
Create new virtual IBAN.
{
"wallet_id": "wlt_1",
"country": "GB"
}{
"iban": "GB89..."
}Delete Beneficiary
Remove a beneficiary.
Parameters
{
"status": "deleted"
}Webhooks
Subscribe to real-time events.
Create Webhook
Register a new webhook endpoint.
{
"url": "https://api.yoursite.com/hook",
"events": [
"transaction.created"
]
}{
"id": "wh_123",
"secret": "whsec_..."
}List Webhooks
List active webhooks.
{
"data": []
}Get Webhook
Get webhook details.
Parameters
{
"id": "wh_123",
"url": "..."
}Update Webhook
Modify webhook events or URL.
Parameters
{
"events": [
"transaction.*"
]
}{
"id": "wh_123",
"events": [
"transaction.*"
]
}Rotate Secret
Generate a new signing secret.
Parameters
{
"secret": "whsec_new..."
}Delete Webhook
Remove a webhook.
Parameters
{
"status": "deleted"
}Files
Manage receipts and KYC documents.
Upload File
Upload a file (PDF, JPG, PNG).
{
"purpose": "receipt",
"file": "(binary)"
}{
"id": "file_999",
"url": "..."
}Get File
Retrieve file metadata.
Parameters
{
"id": "file_999",
"size": 1024
}Reporting
Analytics and statements.
Get Balance History
Get daily balance snapshots.
{
"data": [
{
"date": "2024-03-01",
"balance": 1000
}
]
}Get Spending Stats
Spending aggregated by category.
{
"software": 500,
"travel": 200
}Generate Statement
Request a PDF statement.
{
"month": 3,
"year": 2024
}{
"status": "processing",
"id": "stmt_1"
}Exchange Rates
Get current exchange rates.
Parameters
{
"base": "EUR",
"rates": {
"USD": 1.09,
"GBP": 0.85
}
}