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

Environments

Framnex provides the base URL and credentials required for the environment enabled for your integration. Use only the connection details provided for that environment, and keep environment-specific configuration separate in your application.

Configure the base URL#

The BaaS API uses the Child Brand Integration service path:
https://<host>/api/child-brand-integration
The <host> value depends on the environment assigned to your integration. Store the full base URL in configuration instead of hard-coding it in application code.
For example:
export BASE_URL="https://<host>/api/child-brand-integration"

Configure credentials securely#

Use the integrator username and secret key provided for the environment you are connecting to.
Store credentials in a server-side secret store and inject them into the application at runtime. Do not put credentials in source control, browser code, mobile applications, logs, or URLs.

Keep environment configuration isolated#

Keep the base URL, credentials, and related configuration for each available environment clearly separated in your application.
Where the API accepts an externalId, use a stable identifier from your own system. This helps you map Framnex resources back to your own records.

Before production#

Before you send production traffic:
confirm the production base URL and credentials with your Framnex implementation representative;
verify that your application is using the intended environment configuration;
configure production webhooks if your integration uses them;
complete the relevant integration flow in any test or non-production environment available to you, if applicable.
Continue with Authentication to obtain an access token, then use the BaaS API Quick Start for the first end-to-end flow.
Modified at 2026-09-26 19:36:11
Previous
Authentication
Next
Onboard a client
Built with