1. Guides
Framnex for Developers
  • Introduction
    • Overview
    • Quick Start
    • Authentication
    • Environments
  • Guides
    • Onboard a client
    • Open an account
    • Create an outgoing transfer
    • Handle webhooks
  • Accounts
    • Open account
      POST
    • List accounts
      GET
    • Get account
      GET
  • Auth
    • Get access token
      POST
  • Clients
    • Create client
      POST
    • List clients
      GET
    • Get client creation schema
      GET
    • Get client
      GET
    • Get client state
      GET
  • Transfers
    • Create transfer
      POST
    • List transfers
      GET
    • Get transfer
      GET
  • Webhooks
    • Register webhook URL
      POST
    • Get webhook URL
      GET
    • List webhook deliveries
      GET
    • Get webhook delivery
      GET
    • Retry webhook delivery
      POST
  • Cards
    • List card products
    • List cardholders
    • Issue card
    • List cards
    • Get card
    • Activate card
    • Freeze card
    • Unfreeze card
    • Close card
    • Set card limits
    • Create encryption envelope
    • Reveal card details
    • Set PIN
  • Card Transactions
    • List card transactions
    • Get card transaction
  • Exchange Rates
    • Get exchange rate
  • Incoming Transfers
    • Simulate incoming transfer
  • Transfer Documents
    • Download document
    • List documents
    • Upload documents
  • Documents
    • Uploads one file for the selected client-creation flow; use its UUID in a configured document field.
  • Schemas
    • BaaS API
      • Account
      • AccountCredentials
      • AccountOpenedWebhookPayload
      • AccountOpeningFailedWebhookPayload
      • AccountPagedDataDto
      • AccountState
      • AccountType
      • AchCredentials
      • Address
      • AuthTokenRequest
      • AuthTokenResponse
      • BankDetails
      • BusinessClient
      • BusinessEntity
      • Client
      • CreateBusinessClientRequest
      • ClientCreateType
      • CreateClientRequest
      • ClientCreatedResponse
      • ClientPagedDataDto
      • CreateIndividualClientRequest
      • ClientState
      • ClientStateResponse
      • ClientType
      • ClientsFilter
      • CreateAccountRequest
      • CreateExchangeTransferRequest
      • CreateIncomingTransferRequest
      • CreateOutgoingTransferRequest
      • CredentialsState
      • CreateTransferRequest
      • ExchangeRate
      • CreateTransferType
      • CreatedResponse
      • Credentials
      • CredentialsIssueFailedWebhookPayload
      • CredentialsIssuedWebhookPayload
      • ExchangeTransferProcessingWebhookPayload
      • CryptoCredentials
      • IError
      • CryptoTransferDetails
      • IReason
      • DocumentDto
      • ISuccess
      • EmptyResponse
      • ErrorDetailsDto
      • IdentificationDocument
      • ExchangeTransfer
      • ExchangeTransferCancelledWebhookPayload
      • ExchangeTransferExecutedWebhookPayload
      • FasterUkCredentials
      • FedWireCredentials
      • ForeignTransferParty
      • GasPaymentWebhookPayload
      • IdentificationDocumentType
      • IncomingTransfer
      • IncomingTransferReceivedWebhookPayload
      • OutgoingTransferProcessingWebhookPayload
      • IndividualClient
      • IndividualEntity
      • LegalEntity
      • InternalCredentials
      • Participant
      • LegalEntityType
      • LocalAEDCredentials
      • LocalXafCredentials
      • NeftCredentials
      • Result
      • OnboardingCompletedWebhookPayload
      • OutgoingTransfer
      • RiskLevel
      • OnboardingFailedWebhookPayload
      • OutgoingTransferCancelledWebhookPayload
      • PageInfoDto
      • OutgoingTransferExecutedWebhookPayload
      • TransferPagedDataDto
      • PagedFilterDto
      • PaymentMethod
      • ProblemDetails
      • TransfersFilter
      • PixCredentials
      • RegisterWebhookRequest
      • WebhookDelivery
      • SortOrderDto
      • WebhookDeliveryPagedDataDto
      • SepaCredentials
      • SortDto
      • Transfer
      • WebhookSubscription
      • SwiftCredentials
      • TedPayCredentials
      • WebhooksFilter
      • TransferDetails
      • TransferDetailsType
      • TransferGas
      • TransferState
      • TransferType
      • ValidationProblemDetails
      • UploadedClientDocumentDto
      • UaeFtsCredentials
      • UaeIppCredentials
      • WebhookPayload
      • WebhookState
      • WebhookType
      • YeePayKesLocalCredentials
      • YeePayMxnLocalCredentials
      • YeePayNgnLocalCredentials
    • CardProduct
    • Cardholder
    • IssueCardRequest
    • Card
    • CardType
    • CardState
    • CardPagedDataDto
    • CloseCardRequest
    • SetCardLimitsRequest
    • CardEncryptionEnvelope
    • CardEncryptedDetailsRequest
    • CardEncryptedDetails
    • SetCardPinRequest
    • CardTransaction
    • CardTransactionState
    • CardTransactionPagedDataDto
    • CardNetwork
    • CardIssuanceFee
    • CardShipping
    • CardSpendingLimit
    • CardLimitInterval
    • CardCloseReason
    • CardSecretType
    • CardEncryptedValue
    • CardMerchant
    • CardWebhookType
    • CardWebhookPayload
    • CardIssuedWebhookPayload
    • CardIssuanceFailedWebhookPayload
    • CardStateChangedWebhookPayload
    • CardTransactionAuthorizedWebhookPayload
    • CardTransactionCompletedWebhookPayload
    • CardTransactionReversedWebhookPayload
GuidesBaaS API Reference
Bank Client API ReferenceFrontOffice API Reference
GuidesBaaS API Reference
Bank Client API ReferenceFrontOffice API Reference
  1. Guides

Open an account

Use this flow to open an account for an active BaaS client. The account is opened in the create request; bank details are provisioned asynchronously.

Before you start#

You need:
a valid access token;
a Framnex client identifier;
a stable account identifier from your own system;
the account currency.
The client must already be Active. If you have not created the client yet, complete Onboard a client first.

1. Create the account#

The BaaS API accepts your own stable account identifier together with the Framnex client identifier and currency.
Example:
See the generated API reference for the current request and response schema:
Open the create account endpoint

2. Store the Framnex account identifier#

A successful response contains the Framnex account identifier. Keep it together with your own externalId and client mapping.

3. Handle bank-detail provisioning#

The account is opened in the create-account request. Bank details are provisioned asynchronously and may not be available immediately after the account is created.
You can retrieve the account when you need its current data:
Open the get account endpoint
Do not treat temporarily unavailable bank details as a failed account creation.

4. Continue with money movement#

After the create-account request succeeds, keep the account identifier for the next supported exchange-rate and transfer flows. If a specific flow depends on bank details, wait until those details are available. Before production transfers, configure webhooks so your system can process asynchronous state changes.
Continue with Create an outgoing transfer and Handle webhooks in the Guides folder.
Modified at 2026-09-28 17:01:07
Previous
Onboard a client
Next
Create an outgoing transfer
Built with