BaaS API
Copy Page
Framnex for Developers
Introduction
Overview
Quick Start
Accounts
Opens a new account for a client
Returns the paged list of accounts, optionally filtered by client
Returns an account by its identifier
Auth
Exchanges integrator client credentials for an access token.
Clients
Onboards a client using the JSON fields returned by the client creation fields endpoint.
Returns the paged list of clients, optionally filtered
Returns the OpenAPI 3.0 creation schema for the authenticated brand and requested type.
Returns a client by its identifier
Returns the current client onboarding or profile state
ExchangeRates
Returns the exchange rate between the sell and buy accounts
Transfers
Creates a new outgoing transfer
Returns the paged list of transfers, filtered by the provided filter
Returns a transfer by its identifier
Webhooks
Registers (or replaces) the URL webhooks are delivered to for the integrator
Returns the currently registered webhook URL for the integrator
Returns the paged list of webhook deliveries, filtered by the provided filter
Returns a webhook delivery by its identifier
Re-queues a failed webhook delivery for another attempt
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
Guides
BaaS API Reference
Bank Client API Reference
Guides
BaaS API Reference
Bank Client API Reference
BaaS API
Copy Page
ErrorDetailsDto
{
"message"
:
"string"
,
"statusCode"
:
0
}