FinLego for developers
  1. Transfers
FinLego for developers
  • FinLego Core Banking
    • Services REST API
      • ClientProfile - FrontOffice
        • Client
          • /Client
          • /Client/deletion-notifications
      • ClientProfile - System
        • Clients
          • /internal/Clients
          • /internal/Clients
          • /internal/Clients/{clientId}/block
          • /internal/Clients/{clientId}/unblock
          • /internal/Clients/{clientId}
          • /internal/Clients/{clientId}
        • Documents
          • /internal/Clients/{clientId}/Documents/upload
          • /internal/Clients/{clientId}/Documents/{documentId}/download
          • /internal/Clients/{clientId}/Documents
          • /internal/Clients/{clientId}/Documents/{documentId}
      • GeneralLedger - System (1)
        • Accounts
          • /Accounts
          • /v2/internal/Accounts
          • /Accounts
          • /v2/internal/Accounts/recalculate
          • /Accounts/{id}
          • /internal/Accounts/calculateBalances
          • /Accounts/{id}
          • /v2/ledger/internal/Accounts/{accountId}
          • /Accounts/{id}
          • /v2/ledger/internal/Accounts/search
          • /Accounts/send-otp
          • /v2/ledger/internal/Accounts/getAggregatedAmounts
          • /Accounts/otp-verification
          • /Accounts/{accountNumber}
          • /Accounts/reorder-accounts
        • Transactions
          • Transactions by filter
          • /internal/Transactions/{id}
          • /internal/Transactions
          • /internal/Transactions/query
          • /internal/Transactions/report
        • BaasProvider
          • /BaasProvider/available-currencies
        • BackgroundJob
          • /internal/BackgroundJob/AccountBalanceCheckJob
        • DailyAccountBalance
          • /internal/DailyAccountBalance
          • /internal/DailyAccountBalance/recalculate
        • DailyCheck
          • /internal/DailyCheck
          • /internal/DailyCheck/details
        • Reports
          • /internal/Reports/ReconciliationReport
        • TreasuryManagement
          • /internal/TreasuryManagement/summary
        • Payments
          • Creates payment with single transaction and transfers money between accounts
          • Creates payment in Draft state without any money transfers
          • Pends payment and holds funds in case of withdrawals
          • Posts payment, withdraws held funds and deposits it to corresponding account
          • Cancels payment and performs payback in case of held
      • GeneralLedger - System (2)
        • Accounts
          • /v2/internal/Accounts
          • /v2/internal/Accounts/recalculate
          • /internal/Accounts/calculateBalances
          • /v2/ledger/internal/Accounts/{accountId}
          • /v2/ledger/internal/Accounts
          • /v2/ledger/internal/Accounts/getAggregatedAmounts
        • Payments
          • Creates payment with single transaction and transfers money between accounts
          • Creates payment in Draft state without any money transfers
          • Pends payment and holds funds in case of withdrawals
          • Posts payment, withdraws held funds and deposits it to corresponding account
          • Cancels payment and performs payback in case of held
      • TransferOrchestrator - FrontOffice
        • Confirmations
          • Generate a new confirmation code for the specified transfer.
        • Documents
          • Downloads a document by its file name.
        • Recipients
          • Fetch recipients based on the specified filters.
          • Fetch recipients based on the specified filters.
          • Add a recipient.
          • Fetch recipient details by the specified recipient identifier.
          • Fetch recipient details by the specified recipient identifier.
          • Update the visibility details of a recipient.
        • Transfers
          • Fetch transfers based on the specified filters.
          • Fetch transfers based on the specified filters.
          • Fetch transfer details by the specified transfer identifier.
          • Fetch transfer details by the specified transfer identifier.
          • Create an outgoing transfer.
          • Fetch outgoing transfer details by the specified transfer identifier.
          • Confirm an outgoing transfer.
          • Fetch incoming transfer details by the specified transfer identifier.
          • Cancel an outgoing transfer by the transfer identifier.
          • Fetch foreign exchange transfer details by the specified transfer identifier.
          • Fetch outgoing transfer details by the specified transfer identifier.
          • Fetch incoming transfer details by the specified transfer identifier.
          • Create a foreign exchange transfer.
          • Confirm an outgoing transfer.
          • Cancel an outgoing transfer by the transfer identifier.
          • Fetch foreign exchange transfer details by the specified transfer identifier.
          • Fetch a transfer type by recipient account and currency.
      • TransferOrchestrator - System (1)
        • Documents
          • Downloads a document by its file name and client identifier.
        • IncomingRequests
          • Fetch internal requests based on the specified filters.
          • process a transfer manually.
        • Recipients
          • Add a recipient.
        • Transfers
          • Fetch internal transfers based on the specified filters.
            GET
          • Fetch outgoing transfer details by the specified transfer identifier.
            GET
          • Fetch incoming transfer details by the specified transfer identifier.
            GET
          • Assign an unrecognized incoming transfer.
            PUT
          • Fetch foreign exchange transfer details by the specified transfer identifier.
            GET
          • Execute a transfer manually.
            POST
          • Continue processing of an outgoing transfer.
            POST
          • Fetch outgoing transfers based on the specified filters.
            GET
          • Fetch incoming transfers based on the specified filters.
            GET
          • Fetch foreign exchange transfers based on the specified filters.
            GET
      • TransferOrchestrator - System (2)
        • Recipients
          • Add a system recipient.
        • Transfers
          • /internal/integration/Transfers/outgoing
          • /internal/integration/Transfers/outgoing/payment-request
  • Onboarding Integration
    • ClientsImport
      • Imports a new individual client from an integrated WL customer's onboarding system
      • Imports a new company client from an integrated WL customer's onboarding system
    • SumsubWebhooks
      • /integration/sumsub-webhooks/update-state
      • Simulates a verification response.
  1. Transfers

Fetch foreign exchange transfers based on the specified filters.

GET
/internal/Transfers/fx

Request

Query Params
ClientId
string <uuid>
optional
DateFrom
string <date-time>
optional
DateTo
string <date-time>
optional
State
enum<string> 
optional
Allowed values:
draftconfirmedcheckingcheckedhardStopamlUnavailableamlTimeOutRejectamlRejectamlErrorexecutedcancelederrorholdcancellingotpEntryTimeHasExpiredincorrectOTPotpExhaustedunrecognizedexecutedRecognized
AccountNumber
string 
optional
AccountName
string 
optional
MinAmount
number <double>
optional
MaxAmount
number <double>
optional
ClientAccountId
string <uuid>
optional
TransferId
string <uuid>
optional
Currency
string 
optional
SortBy
string 
optional
SortOrder
enum<string> 
optional
Allowed values:
ascdesc
PageNumber
integer <int32>
optional
PageSize
integer <int32>
optional

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/internal/Transfers/fx'

Responses

🟢200Request has been successfully completed.
application/json
Body
data
array[object (InternalFxTransferDto) {16}] 
optional
id
string <uuid>
optional
created
string <date-time>
optional
modified
string <date-time>
optional
operationType
enum<string> 
optional
Allowed values:
incomingoutgoingfxinternalselfpaymentRequest
clientId
string <uuid>
optional
sender
object (ParticipantDto) 
required
senderSide
object (TransferSideDto) 
required
recipient
object (ParticipantDto) 
required
recipientSide
object (TransferSideDto) 
required
exchangeRate
number <double> | null 
optional
state
enum<string> 
required
Allowed values:
draftconfirmedcheckingcheckedhardStopamlUnavailableamlTimeOutRejectamlRejectamlErrorexecutedcancelederrorholdcancellingotpEntryTimeHasExpiredincorrectOTPotpExhaustedunrecognizedexecutedRecognized
baasProvider
enum<string> 
optional
Allowed values:
bclpbmyEUPayemBankmanualBaasclearJunctionfuseMeinCorerailsrnovebastubBaas
baasProviderTransferId
string  | null 
optional
payments
array[string <uuid>]
optional
transactions
array[string <uuid>]
optional
reason
string  | null 
optional
page
object (PageInfoDto) 
optional
pageNumber
integer <int64>
optional
pageSize
integer <int64>
optional
totalRecords
integer <int64>
optional
totalPages
integer <int64>
read-onlyoptional
Example
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "created": "2019-08-24T14:15:22Z",
            "modified": "2019-08-24T14:15:22Z",
            "operationType": "incoming",
            "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
            "sender": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "created": "2019-08-24T14:15:22Z",
                "modified": "2019-08-24T14:15:22Z",
                "legalName": "string",
                "firstName": "string",
                "lastName": "string",
                "registrationAddress": {
                    "country": "string",
                    "postalCode": "string",
                    "city": "string",
                    "street": "string"
                },
                "account": {
                    "bic": "string",
                    "iban": "string",
                    "accountNumber": "string",
                    "ukAccountNumber": "string",
                    "ukSortCode": "string",
                    "accountName": "string",
                    "ledgerAccountId": "8fd783bf-c51a-434f-9698-99f6050085a9",
                    "bankCountry": "string",
                    "bankName": "string",
                    "currency": "string"
                }
            },
            "senderSide": {
                "amount": 0,
                "feeAmount": 0,
                "feeAllocation": "our",
                "totalAmount": 0,
                "currency": "string"
            },
            "recipient": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "created": "2019-08-24T14:15:22Z",
                "modified": "2019-08-24T14:15:22Z",
                "legalName": "string",
                "firstName": "string",
                "lastName": "string",
                "registrationAddress": {
                    "country": "string",
                    "postalCode": "string",
                    "city": "string",
                    "street": "string"
                },
                "account": {
                    "bic": "string",
                    "iban": "string",
                    "accountNumber": "string",
                    "ukAccountNumber": "string",
                    "ukSortCode": "string",
                    "accountName": "string",
                    "ledgerAccountId": "8fd783bf-c51a-434f-9698-99f6050085a9",
                    "bankCountry": "string",
                    "bankName": "string",
                    "currency": "string"
                }
            },
            "recipientSide": {
                "amount": 0,
                "feeAmount": 0,
                "feeAllocation": "our",
                "totalAmount": 0,
                "currency": "string"
            },
            "exchangeRate": 0,
            "state": "draft",
            "baasProvider": "bc",
            "baasProviderTransferId": "string",
            "payments": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "transactions": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "reason": "string"
        }
    ],
    "page": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalRecords": 0,
        "totalPages": 0
    }
}
🟠400Provided parameters are invalid.
🔴500Internal Server Error
Modified at 2024-12-23 17:28:42
Previous
Fetch incoming transfers based on the specified filters.
Next
Add a system recipient.
Built with