1. BankClientAPI
Framnex for Developers
  • Introduction
    • Overview
    • Quick Start
  • ClientIntegrationAccounts
    • Returns an account by its identifier
    • Returns the paged list of accounts
  • ClientIntegrationAuth
    • Obtain an access token using client credentials.
  • ClientIntegrationExchangeRates
    • Returns the exchange rate between the sell and buy accounts
  • ClientIntegrationTransfers
    • Creates a new outgoing transfer
    • Returns the paged list of transfers, filtered by the provided filter
    • Returns a transfer by its identifier
  • ClientIntegrationWebhooks
    • 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
  • ClientIntegrationTransferDocuments
    • Downloads a document by its file name.
    • Gets all documents
    • Uploads multiple documents.
  • 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. BankClientAPI

IncomingTransfer

An incoming transfer received from an external sender.

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "details": [
        {
            "type": "crypto",
            "txHash": "string",
            "gas": {
                "gasPaymentId": "2276332b-f8b0-4d66-92d8-55d8621398f1",
                "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
                "amount": 0,
                "currency": "string"
            }
        }
    ],
    "system": "sepa",
    "currency": "string",
    "amount": 0,
    "feeAmount": 0,
    "reference": "string",
    "type": "incoming",
    "sender": {
        "credentials": {
            "bankDetails": {
                "bankName": "string",
                "bankCountry": "string",
                "bankRegion": "string",
                "bankAddress": "string",
                "bic": "string",
                "intermediaryBic": "string",
                "bankCode": "string",
                "routingNumber": "string",
                "sortCode": "string",
                "branchCode": "string"
            },
            "type": "sepa",
            "iban": "string",
            "reference": "string"
        },
        "legalEntity": {
            "address": {
                "streetLine1": "string",
                "streetLine2": "string",
                "city": "string",
                "state": "string",
                "zip": "string",
                "country": "string"
            },
            "type": "business",
            "legalName": "string"
        }
    },
    "recipientAccountId": "18fcfe37-0f50-4867-bd6f-e618727414c4"
}
Built with