1. Introduction
Framnex for Developers
  • Introduction
    • Overview
    • Quick Start
    • Authentication
    • Environments
  • Guides
    • Create an outgoing transfer
    • Handle webhooks
    • Transfer documents
  • ClientIntegrationAccounts
    • Returns an account by its identifier
      GET
    • Returns the paged list of accounts
      GET
  • ClientIntegrationAuth
    • Obtain an access token using client credentials.
      POST
  • ClientIntegrationExchangeRates
    • Returns the exchange rate between the sell and buy accounts
      GET
  • ClientIntegrationTransfers
    • 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
  • ClientIntegrationWebhooks
    • 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
  • ClientIntegrationTransferDocuments
    • Downloads a document by its file name.
      GET
    • Gets all documents
      GET
    • Uploads multiple documents.
      POST
  • Schemas
    • BankClientAPI
      • Account
      • AccountCredentials
      • AccountState
      • AccountType
      • AchCredentials
      • Address
      • BankDetails
      • BusinessEntity
      • ClientIntegrationAuthRequest
      • ClientIntegrationAuthResponse
      • ClientIntegrationErrorResponse
      • CreateExchangeTransferRequest
      • CreateOutgoingTransferRequest
      • CreateTransferRequest
      • CreateTransferType
      • CreatedResponse
      • Credentials
      • CredentialsState
      • CryptoCredentials
      • CustomerTransferStateDto
      • CryptoTransferDetails
      • ExchangeRate
      • DocumentDto
      • FasterUkCredentials
      • ExchangeTransferCancelledWebhookPayload
      • ExchangeTransfer
      • FedWireCredentials
      • IndividualEntity
      • ExchangeTransferExecutedWebhookPayload
      • InternalCredentials
      • InternalServerError
      • IError
      • LegalEntity
      • GasPaymentWebhookPayload
      • IReason
      • LegalEntityType
      • ISuccess
      • LocalAEDCredentials
      • LocalXafCredentials
      • IncomingTransferReceivedWebhookPayload
      • IncomingTransfer
      • NeftCredentials
      • OperationTypeDto
      • PageInfoDto
      • Participant
      • PixCredentials
      • SepaCredentials
      • SortOrderDto
      • SwiftCredentials
      • OutgoingTransferCancelledWebhookPayload
      • OutgoingTransfer
      • TedPayCredentials
      • OutgoingTransferExecutedWebhookPayload
      • PagedFilterDto
      • TransferGas
      • TransferPagedDataDto
      • TransferState
      • TransferType
      • PaymentMethod
      • TransferTypeDto
      • PaymentSystem
      • UaeFtsCredentials
      • RegisterWebhookRequest
      • UaeIppCredentials
      • Result
      • ValidationProblemDetails
      • ProblemDetails
      • YeePayNgnLocalCredentials
      • Transfer
      • TransferDetails
      • TransferDetailsType
      • WebhookDelivery
      • WebhookDeliveryPagedDataDto
      • WebhookPayload
      • WebhookState
      • WebhookSubscription
      • WebhookType
      • YeePayKesLocalCredentials
      • YeePayMxnLocalCredentials
GuidesBaaS API ReferenceBank Client API Reference
GuidesBaaS API ReferenceBank Client API Reference
  1. Introduction

Environments

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

Configure the base URL#

The Bank Client API uses the Merchant service path:
https://<host>/api/merchant
The <host> value depends on the environment assigned to your organization. Store the full base URL in configuration instead of hard-coding it in application code.
For example:
export BASE_URL="https://<host>/api/merchant"

Configure credentials securely#

Use the username and secret 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.
Keep Framnex resource identifiers associated with the environment in which they were created so your application always uses them with the intended configuration.

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 Bank Client API Quick Start for the first authenticated requests.
Modified at 2026-09-26 19:36:07
Previous
Authentication
Next
Create an outgoing transfer
Built with