Skip to main content

​
Financial Operations

Complete API reference for post-activation financial operations including wallet management, beneficiaries, transfers, and payments.
Base URL: https://sandbox.finhub.cloud/api/v2.1/fintrans
For complete details on authentication and headers, refer to the Standard HTTP Headers reference documentation.

​
Prerequisites

Before accessing financial operations:
  • Customer account ACTIVATED (individual or organization)
  • Wallet status = ACTIVE
  • Valid JWT token from session
  • Sufficient wallet balance (for outgoing transfers)
Activation Required: All financial operations require account activation. Attempting to access before activation returns 404 or 422 errors.

​
Complete Financial Journey

PhaseOperationTimePrerequisites
1. Wallet SetupCheck balance, fund wallet< 5 minAccount activated
2. BeneficiariesAdd payment recipients< 5 minValid recipient details
3. Payment ConsentsCreate authorization< 5 minBeneficiaries added (optional)
4. Execute TransferPrepare → Execute → Monitor< 2 minBeneficiary + consent + balance
5. ApprovalsMulti-signature (if required)VariesHigh-value or policy-based

​
Quick Start: First Transfer

​
Step 1: Check Wallet Balance

GET /api/v2.1/fintrans/{accountId}/balance

​
Step 2: Add Beneficiary

POST /api/v2.1/fintrans/{accountId}/beneficiaries

POST /api/v2.1/fintrans/{accountId}/payment-consents/types/TRANSFER

​
Step 4: Prepare Transfer

POST /api/v2.1/fintrans/{accountId}/types/TRANSFER/prepare

​
Step 5: Execute Transfer

POST /api/v2.1/fintrans/{accountId}/types/TRANSFER/execute

​
Step 6: Monitor Status

GET /api/v2.1/fintrans/{accountId}/orders/{orderId}

Account Operations

Prepare and execute financial operations on accounts

Transfers & Payments

Create and execute transfers, top-ups, and withdrawals

Beneficiaries

Manage payment beneficiaries

Payment Consents

Manage payment consents and approvals

​
Transaction Flow

​
Operation Types

TypeDirectionDescriptionStatus
topupIncomingAdd funds to wallet✅ Production
transferOutgoingSend to beneficiary✅ Production
withdrawOutgoingRemove from wallet✅ Production
SEPA_TRANSFER_EXTERNALOutgoingExternal SEPA transfer✅ Production
SEPA_INSTANT_PAYMENTOutgoingInstant SEPA payment✅ Production
SEPA_TRANSFER_INTERNALInternalSame-bank SEPA transfer✅ Production
purchaseOutgoingMerchant payment🔜 Planned
saleIncomingReceive payment🔜 Planned

​
API Endpoints Overview

​
Wallet Query & Balance

  • GET /wallets/{walletId}/balance - Get individual wallet balance
  • GET /wallets/customer/{customerId} - Get customer wallets
  • POST /wallets/balance - Tenant Master GP wallet balance
  • POST /wallets/balance/by-lob - Balance by line of business
  • POST /wallets/tenant - Tenant wallets with filtering
  • POST /wallets/tenant-assets - Tenant asset aggregates
  • POST /wallets/classified - Classified wallet view
  • POST /wallets/customer-balance - Customer Master GP wallet
  • POST /wallets/children-balance - Children balance summary
  • POST /wallets/{walletId}/linked-assets - Linked external assets
  • POST /wallets/{walletId}/beneficiaries - Wallet beneficiaries
  • POST /wallets/{walletId}/fund - Fund wallet (sandbox)
  • GET /fintrans/{accountId}/balance - Balance via FinTransResource

​
Beneficiary Management

  • GET /fintrans/{accountId}/beneficiaries - List beneficiaries
  • POST /fintrans/{accountId}/beneficiaries - Create beneficiary (with account)
  • POST /fintrans/beneficiaries - Create beneficiary (no account, nested)
  • PUT /fintrans/beneficiaries/{beneficiaryId} - Update beneficiary
  • DELETE /fintrans/{accountId}/beneficiaries/{beneficiaryId} - Delete beneficiary

​
Payment Consents

  • POST /fintrans/{accountId}/payment-consents/types/{operationType} - Create consent
  • GET /fintrans/{accountId}/payment-consents/{consentId} - Get consent
  • DELETE /fintrans/{accountId}/payment-consents/{consentId} - Revoke consent
  • POST /payment/consent/validate - Validate payment against consent

​
Transfers & Payments (Prepare → Execute)

  • GET /fintrans/{accountId}/allowed-operations - Allowed operations & beneficiaries
  • POST /fintrans/{accountId}/types/{operationType}/prepare - Prepare order
  • POST /fintrans/{accountId}/types/{operationType}/execute - Execute order
  • POST /transfers/{walletId}/prepare - Prepare (muse-proxy alias)
  • POST /transfers/{walletId}/execute - Execute (muse-proxy alias)
  • POST /wallets/orders/prepare - Prepare (Order Wizard alias)
  • POST /wallets/orders/execute - Execute (Order Wizard alias)
  • GET /fintrans/{accountId}/orders - List orders
  • GET /fintrans/{accountId}/orders/{orderId} - Order detail
  • DELETE /fintrans/{accountId}/orders/{orderId} - Cancel order

​
Verification of Payee (VoP)

  • POST /fintrans/vop/verify - Verify payee name, IBAN, BIC before SEPA payment

​
Dashboard & Aggregation

  • POST /wallets/transactions - Overall transactions (paginated)
  • POST /wallets/customer-transactions - Customer transaction history
  • POST /wallets/transactions-by-type - Transactions by B2B/B2C type
  • POST /wallets/asset-transactions - Asset transactions
  • POST /wallets/aggregate-order-status - Order counts by type/status
  • POST /wallets/pending-orders - Pending orders list
  • POST /wallets/order-detail - Order detail by orderId
  • POST /wallets/cancel-order - Cancel pending order

​
Block / Unblock

  • POST /wallets/block-history - Block balance orders history
  • POST /wallets/unblock - Unblock frozen deposit
  • POST /wallets/customer-block-orders - Block orders by customer

​
Transaction Monitoring (TM)

  • POST /wallets/tm/transactions - TM transaction list
  • POST /wallets/tm/transaction-detail - TM transaction detail
  • POST /wallets/tm/update-status - Update TM status
  • POST /wallets/tm/consumer-detail - TM consumer detail

​
Payment Documents (High-Value)

  • POST /fintrans/{walletId}/payment-documents - Upload payment document

Standard Headers

Required HTTP headers for all endpoints

API Schema Mapping

Complete OpenAPI specifications

Individual Activation

Activate individual account first

Organization Activation

Activate organization account first

​
Changelog

VersionDateChanges
v1.02026-01-13Comprehensive financial operations overview