1. Accounts
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. Accounts

Open account

POST
/baas/Accounts
Opens an account in the requested currency for an active client. The currency must be enabled for your
integration.
The account is opened within this request, and the response contains its identifier. Payment credentials
(for example, an IBAN or an account number) are then issued asynchronously for each payment method available
for the currency. Each result is reported with a credentialsIssued or credentialsIssueFailed webhook; you
can also follow it with GET /baas/Accounts/{id}.
externalId is your identifier of the account; a request with the externalId of an existing account is
rejected.
Errors:
404 Not Found - the client does not exist or is not active yet;
409 Conflict - an account with this externalId already exists;
422 Unprocessable Content - an account cannot be opened in this currency.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/json

Example
{
    "externalId": "string",
    "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    "currency": "string",
    "paymentMethod": "sepa"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/baas/Accounts' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "externalId": "string",
    "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    "currency": "string",
    "paymentMethod": "sepa"
}'

Responses

🟢200
application/json
OK
Bodyapplication/json

Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
🟠400
🟠404
🟠422
🔴500
Modified at 2026-09-29 12:10:42
Previous
Handle webhooks
Next
List accounts
Built with