1. Accounts
Framnex for Developers
  • Client Profile
    • Client
      • /Client
      • /Client/deletion-notifications
      • /Client/plan
    • Kyc
      • /Kyc/StartAction
  • Transfer Orchestrator
    • Activities
      • /Activities/{id}
      • /Activities/correlation/{id}
      • /Activities
    • BankDetailsDirectory
      • Returns the bank details known for a BIC, to complete the recipient's bank on the send-money form.
    • ClientOperations
      • Get allowed client operations
      • /ClientOperations/requestFxAccount
    • Documents
      • Downloads a document by its file name.
      • Uploads multiple documents.
      • Gets all documents for the current user.
    • Participants
      • Get payment methods available for the account, to render the participant-creation options.
      • Get required participant fields based on account
      • Get required participant fields based on account
      • /Participants
      • /Participants/get-paged
    • Transfers
      • Fetch transfers based on the specified filters.
      • Fetch transfer details by the specified transfer identifier.
      • Fetch incoming transfer details by the specified transfer identifier.
      • Create a foreign exchange transfer.
      • Fetch foreign exchange transfer details by the specified transfer identifier.
      • Create a self transfer (same-BAAS or cross-BAAS same currency).
      • Get list of available accounts to make fx transfer to (in/cross baas)
      • Get list of available accounts to make self/crossbaas transfer to
      • Create an outgoing transfer.
      • Create a mass payout - many outgoing transfers from one account, confirmed together by a single OTP. Nothing is created unless every payment can be: a request with any unusable payment is refused as a whole, listing what is wrong with each of them again
      • Fetch a mass payout of the current client by its identifier.
      • Fetch outgoing transfer details by the specified transfer identifier.
      • Check whether a confirmation document is required for an outgoing transfer with the given parameters.
      • Get the additional payment-data fields (form descriptors) required for an outgoing transfer from the given account to the given recipient over the given payment system — e.g. the UAE purpose-of-payment code, or fields configured for the account's provid
      • Get the constraints configured for the transfer's reference and purpose, so the form can apply the provider's alphabet and length limits before the payment is sent. An empty array means nothing is configured and the platform defaults apply.
  • Dfns Integration
    • AccessRecovery
      • Starts access recovery and returns the challenge the new credentials attest to, together with the encrypted recovery key stored by Dfns.
    • CredentialOperations
      • Reports how a credential ceremony ended.
    • Credentials
      • Lists the keys and devices of the client, together with whether an active recovery key exists.
      • Starts issuing a credential and returns what the client needs to generate it.
      • Hands over the generated credential and creates the confirmation authorizing its registration.
      • Starts revoking a credential and creates the confirmation authorizing it.
    • CustodialKey
      • Starts issuing the custodial key and creates the confirmation authorizing it.
    • Devices
      • Starts adding a device and creates the confirmation authorizing the one-time code.
      • Exchanges the one-time code for the challenge the new device's passkey attests to.
      • Registers the passkey the new device produced, which ends the ceremony.
    • Gas
      • Tells whether a crypto account can pay the network's coin one transfer needs, and what to tell a person when it cannot.
  • Accounts
    • Accounts
      • /Accounts/{id}
      • /Accounts/{id}
      • /Accounts/{id}
      • /Accounts/{id}/incoming-requisites
      • /Accounts
      • /Accounts
      • /Accounts/{id}/get-commission-strategies
      • /Accounts/reorder-accounts
      • /Accounts/request-account
    • Currencies
      • /Currencies
      • /Currencies/available-for-open
    • Settings
      • /Settings
  • Cards
    • Cards
      • Returns the caller's configured card routes and their required KYC status.
      • Issues an allowed provider/currency card for the calling client.
      • Returns a page of the caller's own cards.
      • Returns one of the caller's own cards.
      • Returns the accounts one of the caller's own cards draws on.
      • /Cards/{cardId}/freeze
      • /Cards/{cardId}/unfreeze
      • Prepares a provider-defined encrypted session for one of the caller's cards.
      • Relays an opaque encrypted-session exchange for one of the caller's cards.
  • Confirmations
    • Challenges
      • /Challenges/{id}
      • /Challenges/{id}/retry
      • /Challenges/{id}/confirm
      • /Challenges/{id}/cancel
  • Reporter
    • Reports
      • Generates an account statement report.
      • Generates an account confirmation report.
      • Generates a transfer statement report.
      • Gets the overall balance across all client accounts, converted to EUR, GBP, and USD.
  • Merchant
    • PaymentSession
      • /frontoffice/payment-session/{id}
      • /frontoffice/payment-session/pay
      • /frontoffice/payment-session/{id}/cancel
    • Transfer
      • /frontoffice/transfer/{transferId}
  • Onboarding Lite
    • Onboarding
      • Returns an applicant's profile. If it doesn't exist, the system reads info from SSO and creates it.
      • Set profile type for user
      • /frontoffice/onboarding/GetAvailableProfileTypes
    • Sumsub
      • Generates applicant's verification flow token for WebSDK access.
  • Fee
    • Card
      • /Card/issuance-fee
    • Transfers
      • Method returns fee for transfers in transfer’s currency for front-office
  • Exchange
    • Transactions
      • Starts monitoring fx rate and returns actual value. How much of the quote currency is needed to buy 1 unit of the base currency
  • Schemas
    • Client Profile
      • AddressDto
      • BeneficiaryType
      • BusinessPartnerDto
      • ClientCompanyDto
      • ClientDto
      • ClientDtoResult
      • ClientIndividualDto
      • ClientState
      • ClientType
      • CompanyType
      • ComplianceEvaluationDto
      • CountriesGroup
      • CustomerType
      • DocumentSide
      • DocumentType
      • EmployeeCount
      • FundFlowsDto
      • HighRiskActivity
      • IError
      • IReason
      • ISuccess
      • IdentificationDocumentDto
      • IdentificationDocumentType
      • Industry
      • KycBlockDto
      • KycBlockStatus
      • PurposeAccountOpening
      • RelatedIndividualInfoDto
      • Result
      • SourceOfFunds
      • StartActionDto
      • TariffPlan
      • Turnover
      • TurnoverUsd
      • UploadedDocumentDto
      • UploadedDocumentFileDto
    • Transfer Orchestrator
      • AccountType
      • AchCredentials
      • Address
      • ApplePayCredentials
      • BankDetails
      • BankDetailsByBicDto
      • BizumCredentials
      • BlikCredentials
      • BlockchainNetworkCode
      • BunqCredentials
      • BusinessEntity
      • CardCredentials
      • CardMerchantCredentials
      • CardNetwork
      • CardPayOutActivityDto
      • CardPaymentInfo
      • CardProvider
      • CardholderType
      • CoinsPaidCredentials
      • CreateParticipantDto
      • Credentials
      • CryptoCredentials
      • CryptoCurrencyResponseDto
      • CryptoTransferDetails
      • CurrencyResponseDto
      • CustomerFxTransferDto
      • CustomerIncomingTransferDto
      • CustomerOutgoingTransferDto
      • CustomerTransferBatchDto
      • CustomerTransferBatchItemDto
      • CustomerTransferDto
      • CustomerTransferDtoPagedDataDto
      • CustomerTransferStateDto
      • DocumentDto
      • ErrorDetailsDto
      • ExchangeTransferActivityDto
      • FasterUkCredentials
      • FedWireCredentials
      • FeeAllocationDto
      • FiatCurrencyResponseDto
      • FieldCondition
      • FieldInfo
      • FieldType
      • FieldValueFormatter
      • FieldValueInfo
      • FxAccountType
      • FxBaseAccountDto
      • FxBuyAccountDto
      • FxOpenAccountDto
      • FxRequestAccountDto
      • FxTransferParamsDto
      • GasPaymentActivityDto
      • GasPaymentInfoDto
      • GetUsedParticipantsDto
      • GooglePayCredentials
      • IActivityDto
      • IActivityDtoPagedDataDto
      • IncomingTransferActivityDto
      • IndividualEntity
      • InternalCredentials
      • LegalEntity
      • LegalEntityType
      • LocalAEDCredentials
      • LocalXafCredentials
      • MBWayCredentials
      • MidpointRounding
      • MultibancoCredentials
      • N26Credentials
      • NeftCredentials
      • NetellerCredentials
      • OpenBankingCredentials
      • OperationTypeDto
      • OutgoingBatchPaymentDto
      • OutgoingDocumentRequirementDto
      • OutgoingTransferActivityDto
      • OutgoingTransferBatchParamsDto
      • OutgoingTransferDocumentDto
      • OutgoingTransferParamsDto
      • PageInfoDto
      • PagedFilterDto
      • Participant
      • ParticipantDto
      • ParticipantPagedDataDto
      • PaymentSystem
      • PaysafecardCredentials
      • PixCredentials
      • ProblemDetails
      • Przelewy24Credentials
      • RequestFxAccountDto
      • RevolutCredentials
      • SelfAccountType
      • SelfBaseAccountDto
      • SelfBuyAccountDto
      • SelfRequestAccountDto
      • SelfTransferActivityDto
      • SelfTransferParamsDto
      • SepaCredentials
      • SkrillCredentials
      • SortDto
      • SortOrderDto
      • SwiftCredentials
      • TedPayCredentials
      • TransferBatchDraftedDto
      • TransferBatchDraftedItemDto
      • TransferDetails
      • TransferDraftedDto
      • TransferOperationDetailsDto
      • TransferSideDto
      • TransferTypeDto
      • UaeFtsCredentials
      • UaeIppCredentials
      • ValidationProblemDetails
      • WiseCredentials
      • YeePayKesLocalCredentials
      • YeePayMxnLocalCredentials
      • YeePayNgnLocalCredentials
    • Dfns Integration
      • AccessRecoveryChallengeDto
      • ClientCredentialDeviceDto
      • ClientCredentialDto
      • ClientCredentialKind
      • ClientCredentialOperationStatus
      • ClientCredentialPurpose
      • ClientCredentialStatus
      • ClientCredentialsDto
      • CredentialCreationAuthenticatorSelectionDto
      • CredentialCreationChallengeDto
      • CredentialCreationParamDto
      • CredentialCreationUserDto
      • CredentialOperationConfirmationDto
      • CredentialOperationStatusDto
      • EndUserDeviceMetadata
      • GasRequirementDto
      • GasTransferType
      • IssueCredentialRequest
      • PasskeyCreationChallengeDto
      • PasswordProtectedKeyCreationChallengeDto
      • PresentDeviceCodeRequest
      • RecoveryKeyCreationChallengeDto
      • RegisterCredentialRequest
      • RegisterDeviceCredentialRequest
      • RegisterDevicePasskeyRequest
      • RegisterDevicePasswordProtectedKeyRequest
      • RegisterPasskeyRequest
      • RegisterPasswordProtectedKeyRequest
      • RegisterRecoveryKeyRequest
      • UniversalCreationChallengeDto
    • Accounts
      • AccountDraftedDto
      • BankAccountFrontOfficeDto
      • BankAccountState
      • CommissionStrategy
      • CreateAccountDto
      • FrontOfficeAvailableCurrenciesDto
      • FrontOfficeAvailableCurrencyDto
      • FrontOfficeBankCurrencyDto
      • FrontOfficeOpenCurrencyDto
      • FrontOfficeRequestableCurrencyDto
      • FrontOfficeSettingsDto
      • IncomingRequisitesChannel
      • IncomingRequisitesDto
      • IncomingRequisitesGroupDto
      • IncomingRequisitesItemDto
      • IncomingRequisitesItemKind
      • IncomingRequisitesPaymentMethodDto
      • ParticipantLegalEntityType
      • RenameBankAccountDto
      • ReorderAccountsFrontOfficeDto
      • RequestAccountDto
      • SettlementInstructionsDto
    • Cards
      • AvailableCardDto
      • AvailableCardsDto
      • CardAccountDto
      • CardStatus
      • CardType
      • ClientCardDto
      • ClientCardDtoPagedDataDto
      • ClientCardsFilterDto
      • CreateEncryptedEnvelopeRequest
      • CreateEncryptedEnvelopeResponse
      • GetEncryptedCardDetailRequest
      • GetEncryptedCardDetailResponse
      • IssueOwnCardRequestDto
    • Confirmations
      • AccessRecoveryChallenge
      • AccessRecoveryChallengeDataDto
      • AccessRecoveryConfirm
      • AccessRecoveryConfirmation
      • AllowedCredential
      • ChallengeConfirm
      • ChallengeConfirmType
      • ChallengeDataDto
      • ChallengeDataType
      • ChallengeDto
      • ChallengeState
      • ConfirmResult
      • ConfirmResultOperationResult
      • CredentialCreationChallenge
      • CredentialCreationChallengeDataDto
      • CredentialCreationConfirm
      • CredentialRegistrationConfirmation
      • CredentialToRegisterKind
      • EmailChannelInfoDto
      • EmptyResult
      • EndUserCredentialToRegister
      • EndUserSignature
      • EndUserSignatureKind
      • KeyPairAllowedCredential
      • KeyPairCredentialToRegister
      • KeyPairSignature
      • NotificationChannel
      • OperationAssertionChallenge
      • OperationAssertionChallengeDataDto
      • OperationAssertionConfirm
      • OperationAssertionConfirmation
      • OtpChallengeConfirm
      • OtpChallengeDataDto
      • OtpChannelInfoDto
      • OtpState
      • PasswordProtectedKeyAllowedCredential
      • PasswordProtectedKeyCredentialToRegister
      • PasswordProtectedKeySignature
      • RecoveryCredentialToRegister
      • RecoveryKeySignature
      • RetryResult
      • RetryResultOperationResult
      • SmsChannelInfoDto
      • WebAuthnAllowedCredential
      • WebAuthnCoseAlgorithm
      • WebAuthnCredentialToRegister
      • WebAuthnPublicKeyCredentialParam
      • WebAuthnPublicKeyCredentialType
      • WebAuthnSignature
      • WebAuthnState
    • Reporter
      • CurrencyBalanceDto
      • OverallBalanceDto
      • ReportFormat
      • StatusCodeResult
    • Merchant
      • Currency
      • ExtendedPaymentSessionDto
      • InternalServerError
      • KeyValueDto
      • MakePaymentDto
      • PaymentSessionState
      • PayoutDto
      • PayoutState
      • TransferInfoDto
    • Onboarding Lite
      • ApplicantStatus
      • ProfileDto
      • ProfileType
      • ProfileTypeListResult
    • Fee
      • BaasProvider
      • CardIssuanceFeeDto
      • GetTransferTariffDto
      • TransferFeeDto
      • ValidationErrorInfo
    • Exchange
GuidesBaaS API ReferenceBank Client API ReferenceFrontOffice API Reference
GuidesBaaS API ReferenceBank Client API ReferenceFrontOffice API Reference
  1. Accounts

SettlementInstructionsDto

The bank's standard settlement instructions for paying into the account by one method - shown next to that
method's requisites in the top-up.

{
    "paymentMethod": {},
    "correspondentBankName": "string",
    "correspondentBic": "string",
    "beneficiaryBic": "string",
    "additionalInformation": "string"
}
Built with