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
    • Opens a new account for a client
      POST
    • Returns the paged list of accounts, optionally filtered by client
      GET
    • Returns an account by its identifier
      GET
  • Auth
    • Exchanges integrator client credentials for an access token.
      POST
  • Clients
    • Onboards a client using the JSON fields returned by the client creation fields endpoint.
      POST
    • Returns the paged list of clients, optionally filtered
      GET
    • Returns the OpenAPI 3.0 creation schema for the authenticated brand and requested type.
      GET
    • Returns a client by its identifier
      GET
    • Returns the current client onboarding or profile state
      GET
  • ExchangeRates
    • Returns the exchange rate between the sell and buy accounts
      GET
  • Transfers
    • Creates a new outgoing transfer
      POST
    • Returns the paged list of transfers, filtered by the provided filter
      GET
    • Returns a transfer by its identifier
      GET
  • Webhooks
    • Registers (or replaces) the URL webhooks are delivered to for the integrator
      POST
    • Returns the currently registered webhook URL for the integrator
      GET
    • Returns the paged list of webhook deliveries, filtered by the provided filter
      GET
    • Returns a webhook delivery by its identifier
      GET
    • Re-queues a failed webhook delivery for another attempt
      POST
  • IncomingTransfers
    • Creates (simulates) an incoming transfer
  • TransferDocuments
    • Downloads a document by its file name.
    • Gets all documents
    • Uploads multiple documents.
  • 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
      • ErrorDetailsDto
      • ExchangeRate
      • CreateTransferType
      • CreatedResponse
      • Credentials
      • CredentialsIssueFailedWebhookPayload
      • CredentialsIssuedWebhookPayload
      • ExchangeTransferProcessingWebhookPayload
      • CryptoCredentials
      • IError
      • CryptoTransferDetails
      • IReason
      • DocumentDto
      • ISuccess
      • IdentificationDocument
      • ExchangeTransfer
      • IdentificationDocumentType
      • ExchangeTransferCancelledWebhookPayload
      • ExchangeTransferExecutedWebhookPayload
      • FasterUkCredentials
      • FedWireCredentials
      • ForeignTransferParty
      • GasPaymentWebhookPayload
      • IncomingTransfer
      • IncomingTransferReceivedWebhookPayload
      • OutgoingTransferProcessingWebhookPayload
      • IndividualClient
      • IndividualEntity
      • PageInfoDto
      • InternalCredentials
      • Participant
      • LegalEntity
      • LegalEntityType
      • LocalAEDCredentials
      • ProblemDetails
      • LocalXafCredentials
      • NeftCredentials
      • Result
      • OnboardingCompletedWebhookPayload
      • RiskLevel
      • OnboardingFailedWebhookPayload
      • OutgoingTransfer
      • SortOrderDto
      • OutgoingTransferCancelledWebhookPayload
      • OutgoingTransferExecutedWebhookPayload
      • TransferPagedDataDto
      • PagedFilterDto
      • PaymentMethod
      • TransfersFilter
      • PixCredentials
      • RegisterWebhookRequest
      • ValidationProblemDetails
      • WebhookDelivery
      • WebhookDeliveryPagedDataDto
      • SepaCredentials
      • SortDto
      • WebhookSubscription
      • SwiftCredentials
      • TedPayCredentials
      • WebhooksFilter
      • Transfer
      • TransferDetails
      • TransferDetailsType
      • TransferGas
      • TransferState
      • TransferType
      • UaeFtsCredentials
      • UaeIppCredentials
      • WebhookPayload
      • WebhookState
      • WebhookType
      • YeePayKesLocalCredentials
      • YeePayMxnLocalCredentials
      • YeePayNgnLocalCredentials
GuidesBaaS API Reference
Bank Client API Reference
GuidesBaaS API Reference
Bank Client API Reference
  1. Guides

Open an account

Use this flow to request an account for an active BaaS client and wait until the account is ready.

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. Wait for the account to open#

Account opening is asynchronous. Retrieve the account until its state becomes Opened, or process the corresponding webhook event.
Open the get account endpoint
Do not start a money movement flow with an account that has not reached the required ready state.

4. Continue with money movement#

After the account is open, you can use the supported exchange-rate and transfer flows. 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-26 19:16:50
Previous
Onboard a client
Next
Create an outgoing transfer
Built with