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

Create an outgoing transfer

Use this flow to create and track an outgoing transfer for a BaaS client account.
The exact transfer request depends on the transfer type and the capabilities enabled for your integration. Use the generated API reference as the source of truth for request fields and schemas.

Before you start#

You need:
a valid access token;
a client account that is ready for use;
the transfer details required by the current API schema;
webhooks configured if you want asynchronous status updates.

1. Identify the source account#

Use the account identifier returned by Framnex. If needed, list or retrieve accounts before you create the transfer:
List accounts
Get an account

2. Request an exchange rate when the flow requires one#

When a flow uses different sell and buy accounts, use the exchange-rate endpoint defined for your integration:
Get an exchange rate
Use the API reference for the current request parameters and response schema.

3. Build and submit the transfer request#

Create the transfer using the generated reference page:
Create an outgoing transfer
The API reference defines the currently supported transfer request types and fields. Do not copy an old payload into production without checking it against the current schema.

4. Track the transfer#

Use the transfer read endpoints to inspect the current state:
List transfers
Get a transfer
Transfer processing can be asynchronous. Use webhook deliveries to react to state changes instead of relying only on synchronous create responses.

5. Handle asynchronous updates#

Configure webhooks before production transfers. If a webhook delivery fails, Framnex exposes delivery history and a retry operation.
Continue with Handle webhooks in the Guides folder.
Modified at 2026-09-26 19:16:50
Previous
Open an account
Next
Handle webhooks
Built with