Freemarket Web API

Accounts

Accounts__Single

Returns a list of entities

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Accounts_({accountId})/Balances_Single

Returns a list of entities of type AccountBalanceDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Balances

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity AccountBalanceDto

Accounts_({accountId})/Balances({currencyCode})_Single

Returns a single entity of type AccountBalanceDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Balances({currencyCode})

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated
*currencyCode	string		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Accounts_({accountId})/Balances({currencyCode})/Statement_Single

Returns a list of entities of type AccountStatementItemDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Balances({currencyCode})/Statement

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated
*currencyCode	string		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity AccountStatementItemDto

Accounts_({accountId})/Beneficiaries_Single

Returns a list of entities of type BeneficiaryDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Beneficiaries

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity BeneficiaryDto

Accounts_({accountId})/Countries(FilterType = {filterType})_Single

Returns a list of entities of type CountryDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Countries(FilterType = {filterType})

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated
*filterType	string		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity CountryDto

Accounts_({accountId})/DepositInformation_Single

Returns a list of entities of type DepositInformationDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/DepositInformation

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity DepositInformationDto

Accounts_({accountId})/Depositors_Single

Returns a list of entities of type DepositorDto2

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Depositors

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity DepositorDto2

Accounts_({accountId})/DepositRoutingInformation_Single

Returns a list of entities of type DepositRoutingInformationDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/DepositRoutingInformation

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity DepositRoutingInformationDto

Accounts_({accountId})/Deposits_Single

Returns a list of entities of type DepositDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Deposits

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity DepositDto

Accounts_({accountId})/Exchanges_Single

Returns a list of entities of type ExchangeDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Exchanges

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity ExchangeDto

Accounts_({accountId})/InboundTransfers_Single

Returns a list of entities of type InboundTransferDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/InboundTransfers

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity InboundTransferDto

Accounts_({accountId})/OutboundTransfers_Single

Returns a list of entities of type OutboundTransferDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/OutboundTransfers

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity OutboundTransferDto

Accounts_({accountId})/Subaccounts_Single

Returns a list of entities of type AccountDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Subaccounts

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity AccountDto

Accounts_({accountId})/TransferBeneficiaries_Single

Returns a list of entities of type TransferBeneficiaryDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/TransferBeneficiaries

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity TransferBeneficiaryDto

Accounts_({accountId})/Withdrawals_Single

Returns a list of entities of type WithdrawalDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({accountId})/Withdrawals

Parameters

Name	Type	Default	Notes
*accountId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity WithdrawalDto

Accounts_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Accounts({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Alerts

Alerts__Single

Returns a list of entities

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Alerts

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Alerts_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Alerts({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Alerts_Cancel

Cancels an Alert.

Request

POST /v1/Alerts/{alertId}/Cancel

Parameters

Name	Type	Default	Notes
*alertId	integer		AlertId to cancel.

Responses

Status Code	Description	Samples
200	When there is an alert with the provided identifier and it is cancelled.
404	When there is no alert with the provided identifier, or you do not have permission to cancel the alert

Alerts_CreateAlert

Creates a alert.

Request

POST /v1/Alerts/Create

Parameters

Name	Type	Default	Notes
*request			The details of the Alert to be created.

Responses

Status Code	Description	Samples
201	When the Alert has been created successfully. The HTTP Header 'Location' will contain the URL with the details of the created Alert.
400	When there has been an error in any of the Alert's attributes

Beneficiaries

Beneficiaries__Single

Returns a list of entities

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Beneficiaries

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Beneficiaries_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Beneficiaries({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Beneficiaries_Cancel

Request

POST /v1/Beneficiaries/{beneficiaryId}/Cancel

Parameters

Name	Type	Default	Notes
*beneficiaryId	integer

Responses

Status Code	Description	Samples
200	OK

Beneficiaries_Enable

Request

POST /v1/Beneficiaries/{beneficiaryId}/Enable

Parameters

Name	Type	Default	Notes
*beneficiaryId	integer

Responses

Status Code	Description	Samples
200	OK

Beneficiaries_Suspend

Request

POST /v1/Beneficiaries/{beneficiaryId}/Suspend

Parameters

Name	Type	Default	Notes
*beneficiaryId	integer

Responses

Status Code	Description	Samples
200	OK

Beneficiaries_GetRequiredAdditionalInformation

Gets a set of additional information required for particular combination of beneficiary type, currency, country and bank code.

Request

GET /v1/Beneficiaries/{currencyCode}/RequiredAdditionalInformation[?beneficiaryCountryCode&beneficiaryBankCountry&beneficiaryType]

Parameters

Name	Type	Default	Notes
*currencyCode	string		The 3 letter ISO currency code for the beneficiary.
beneficiaryCountryCode	string		The 2 letter ISO country code of beneficiary's address.
beneficiaryBankCountry	string		The 2 letter ISO country code of beneficiary's bank.
beneficiaryType	string		Type of the beneficiary. Possible values are 'Individual' or 'Company'.

Responses

Status Code	Description	Samples
200	Returns required additional information for given combination of input parameters (if any). Returned fields are used as keys in CreateWithdrawalBeneficiary endpoint AdditionalInformation property. Each of the fields is being validated against Rule.RegEx property.

Beneficiaries_CreateWithdrawalBeneficiary

Creates a new withdrawal beneficiary

Request

POST /v1/Beneficiaries/CreateWithdrawalBeneficiary

Parameters

Name	Type	Default	Notes
*request			The details of the beneficiary to be created

Responses

Status Code	Description	Samples
201	When the beneficiary has been created successfully. The HTTP Header 'Location' will contain the URL with the details of the created beneficiary.
400	When there has been an error in any of the beneficiary's attributes

Countries

Countries__Single

Returns a list of entities of type CountryDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Countries

Responses

Status Code	Description	Samples
200	OData endpoint for entity CountryDto

Currencies

Currencies__List

Returns a list of entities of type CurrencyDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Currencies

Responses

Status Code	Description	Samples
200	OData endpoint for entity CurrencyDto

Currencies_({id})_Single

Returns a single entity of type CurrencyDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Currencies({id})

Parameters

Name	Type	Default	Notes
*id	string		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Deposits

Deposits__Single

Returns a list of entities

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Deposits

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Deposits_({depositId})/Fees_Single

Returns a list of entities of type FeeDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Deposits({depositId})/Fees

Parameters

Name	Type	Default	Notes
*depositId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity FeeDto

Deposits_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Deposits({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Deposits_AssignDepositor

Request

POST /v1/Deposits/{depositId}/AssignDepositor

Parameters

Name	Type	Default	Notes
*depositId	integer
*depositor

Responses

Status Code	Description	Samples
200	OK

Deposits_AssignDepositor_depositorId

Request

POST /v1/Deposits/{depositId}/AssignDepositor/{depositorId}

Parameters

Name	Type	Default	Notes
*depositId	integer
*depositorId	integer

Responses

Status Code	Description	Samples
200	OK

Deposits_DepositRequirement

Request

POST /v1/Deposits/DepositRequirement

Parameters

Name	Type	Default	Notes
*request

Responses

Status Code	Description	Samples
200	OK

Entities

Entities__Single

Returns a list of entities of type EntityDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Entities

Responses

Status Code	Description	Samples
200	OData endpoint for entity EntityDto

Entities_({entityId})/Accounts_Single

Returns a list of entities of type AccountDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Entities({entityId})/Accounts

Parameters

Name	Type	Default	Notes
*entityId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity AccountDto

Entities_({entityId})/Countries(FilterType = {filterType})_Single

Returns a list of entities of type CountryDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Entities({entityId})/Countries(FilterType = {filterType})

Parameters

Name	Type	Default	Notes
*entityId	integer		OData v4 Query endpoint. Metadata associated
*filterType	string		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity CountryDto

Entities_({id})_Single

Returns a single entity of type EntityDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Entities({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Exchanges

Exchanges__Single

Returns a list of entities

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Exchanges

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Exchanges_({exchangeId})/Allocations_Single

Returns a list of entities of type AllocationDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Exchanges({exchangeId})/Allocations

Parameters

Name	Type	Default	Notes
*exchangeId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity AllocationDto

Exchanges_({exchangeId})/Deposits_Single

Returns a list of entities of type DepositDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Exchanges({exchangeId})/Deposits

Parameters

Name	Type	Default	Notes
*exchangeId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity DepositDto

Exchanges_({exchangeId})/Fees_Single

Returns a list of entities of type FeeDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Exchanges({exchangeId})/Fees

Parameters

Name	Type	Default	Notes
*exchangeId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity FeeDto

Exchanges_({exchangeId})/Withdrawals_Single

Returns a list of entities of type WithdrawalDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Exchanges({exchangeId})/Withdrawals

Parameters

Name	Type	Default	Notes
*exchangeId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity WithdrawalDto

Exchanges_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Exchanges({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Exchanges_Allocate

Allocates an Instruction.

Request

POST /v1/Exchanges/{exchangeId}/Allocate

Parameters

Name	Type	Default	Notes
*exchangeId	integer		InstructionId to allocate.

Responses

Status Code	Description	Samples
200	When there is an exchange with the provided identifier and it is allocated.
404	When there is no exchange with the provided identifier, or you do not have permission to view the exchange

Exchanges_Approve

Approves a exchange in approval workflow.

Request

POST /v1/Exchanges/{exchangeId}/Approve

Parameters

Name	Type	Default	Notes
*exchangeId	integer		exchangeId to approve.

Responses

Status Code	Description	Samples
200	When there is an exchange with the provided identifier and it is approved.
404	When there is no exchange with the provided identifier, or you do not have permission to view the exchange.
410	When there is an exchange with the provided identifier but it can no longer be approved.

Exchanges_Cancel

Cancels an Instruction.

Request

POST /v1/Exchanges/{exchangeId}/Cancel

Parameters

Name	Type	Default	Notes
*exchangeId	integer		InstructionId to cancel.

Responses

Status Code	Description	Samples
200	When there is an exchange with the provided identifier and it is cancelled.
400	When there has been an error in any of the exchange's attributes
404	When there is no exchange with the provided identifier, or you do not have permission to view the exchange
410	When there is an exchange with the provided identifier but it can no longer be cancelled.

Exchanges_Reject

Rejects a exchange in approval workflow.

Request

POST /v1/Exchanges/{exchangeId}/Reject

Parameters

Name	Type	Default	Notes
*exchangeId	integer		exchangeId to reject.

Responses

Status Code	Description	Samples
200	When there is an exchange with the provided identifier and it is rejected.
404	When there is no exchange with the provided identifier, or you do not have permission to view the exchange.
410	When there is an exchange with the provided identifier but it can no longer be rejected.

Exchanges_Create

Creates a new exchange

Request

POST /v1/Exchanges/Create

Parameters

Name	Type	Default	Notes
*request			The details of the exchange to be created

Responses

Status Code	Description	Samples
201	When the exchange has been created successfully. The HTTP Header 'Location' will contain the URL with the details of the created exchange.
400	When there has been an error in any of the exchange's attributes

InboundTransfers

InboundTransfers_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/InboundTransfers({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

InboundTransfers_({transferId})/Fees_Single

Returns a list of entities of type FeeDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/InboundTransfers({transferId})/Fees

Parameters

Name	Type	Default	Notes
*transferId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity FeeDto

Jobs

Jobs_GetStatus

Request

GET /v1/Jobs/{jobId}/Status?token

Parameters

Name	Type	Default	Notes
*jobId	integer
*token	string

Responses

Status Code	Description	Samples
200	OK

OutboundTransfers

OutboundTransfers_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/OutboundTransfers({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

OutboundTransfers_({transferId})/Fees_Single

Returns a list of entities of type FeeDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/OutboundTransfers({transferId})/Fees

Parameters

Name	Type	Default	Notes
*transferId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity FeeDto

Quotes

Quotes_GetQuote

Request

POST /v1/Quotes/Quote

Parameters

Name	Type	Default	Notes
*request

Responses

Status Code	Description	Samples
200	OK

Sectors

Sectors__List

Returns a list of entities of type SectorDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Sectors

Responses

Status Code	Description	Samples
200	OData endpoint for entity SectorDto

TransferBeneficiaries

TransferBeneficiaries__Single

Returns a list of entities

OData v4 Query endpoint. Metadata associated

Request

GET /v1/TransferBeneficiaries

Responses

Status Code	Description	Samples
200	OData endpoint for entity

TransferBeneficiaries_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/TransferBeneficiaries({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Transfers

Transfers__Single

Returns a list of entities

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Transfers

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Transfers_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Transfers({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Transfers_({transferId})/Fees_Single

Returns a list of entities of type FeeDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Transfers({transferId})/Fees

Parameters

Name	Type	Default	Notes
*transferId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity FeeDto

Transfers_Approve

Approves a transfer in approval workflow.

Request

POST /v1/Transfers/{transferId}/Approve

Parameters

Name	Type	Default	Notes
*transferId	integer		transferId to approve.

Responses

Status Code	Description	Samples
200	When there is a transfer with the provided identifier and it is approved.
404	When there is no transfer with the provided identifier, or you do not have permission to view the transfer
410	When there is a transfer with the provided identifier but it can no longer be approved.

Transfers_Cancel

Cancels a Transfer.

Request

POST /v1/Transfers/{transferId}/Cancel

Parameters

Name	Type	Default	Notes
*transferId	integer		TransferId to cancel.

Responses

Status Code	Description	Samples
200	When there is a transfer with the provided identifier and it is cancelled.
400	When there has been an error in any of the exchange's attributes
404	When there is no transfer with the provided identifier, or you do not have permission to view the transfer
410	When there is a transfer with the provided identifier but it can no longer be cancelled.

Transfers_Reject

Rejects a transfer in approval workflow.

Request

POST /v1/Transfers/{transferId}/Reject

Parameters

Name	Type	Default	Notes
*transferId	integer		transferId to reject.

Responses

Status Code	Description	Samples
200	When there is a transfer with the provided identifier and it is rejected.
404	When there is no transfer with the provided identifier, or you do not have permission to view the transfer
410	When there is a transfer with the provided identifier but it can no longer be rejected.

Transfers_CreateAccountTransfer

Creates a new ad-hoc TransferTransaction

Request

POST /v1/Transfers/CreateAccountTransfer

Parameters

Name	Type	Default	Notes
*request			The details of the transfer to be created

Responses

Status Code	Description	Samples
201	When the transfer has been created successfully. The HTTP Header 'Location' will contain the URL with the details of the created transfer.
400	When there has been an error in any of the transfer's attributes

Withdrawals

Withdrawals__Single

Returns a list of entities

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Withdrawals

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Withdrawals_({id})_Single

Returns a single entity of type Object

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Withdrawals({id})

Parameters

Name	Type	Default	Notes
*id	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Withdrawals_({withdrawalId})/Fees_Single

Returns a list of entities of type FeeDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Withdrawals({withdrawalId})/Fees

Parameters

Name	Type	Default	Notes
*withdrawalId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity FeeDto

Withdrawals_({withdrawalId})/PaymentConfirmationDetails_Single

Returns a single entity of type PaymentConfirmationDetailsDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Withdrawals({withdrawalId})/PaymentConfirmationDetails

Parameters

Name	Type	Default	Notes
*withdrawalId	integer		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity

Withdrawals_Approve

Approves a withdrawal in approval workflow.

Request

POST /v1/Withdrawals/{withdrawalId}/Approve

Parameters

Name	Type	Default	Notes
*withdrawalId	integer		WithdrawalId to approve.

Responses

Status Code	Description	Samples
200	When there is a withdrawal with the provided identifier and it is approved.
404	When there is no Withdrawal with the provided identifier, or you do not have permission to view the Withdrawal.
410	When there is a withdrawal with the provided identifier but it can no longer be approved.

Withdrawals_Cancel

Cancels a Withdrawal.

Request

POST /v1/Withdrawals/{withdrawalId}/Cancel

Parameters

Name	Type	Default	Notes
*withdrawalId	integer		WithdrawalId to cancel.

Responses

Status Code	Description	Samples
200	When there is a withdrawal with the provided identifier and it is cancelled.
404	When there is no withdrawal with the provided identifier, or you do not have permission to view the Withdrawal.
410	When there is a withdrawal with the provided identifier but it can no longer be cancelled.

Withdrawals_GetConfirmationMT103

Returns withdrawal confirmation as a Swift MT103 message

Request

GET /v1/Withdrawals/{withdrawalId}/ConfirmationMT103

Parameters

Name	Type	Default	Notes
*withdrawalId	integer		WithdrawalId

Responses

Status Code	Description	Samples
200	OK
400	When the Swift MT103 style confirmation download feature is not enabled for this account or if withdrawal is not completed.
404	When there is no Withdrawal with the provided identifier, or you do not have permission to view the Withdrawal.

Withdrawals_Reject

Rejects a withdrawal in approval workflow.

Request

POST /v1/Withdrawals/{withdrawalId}/Reject

Parameters

Name	Type	Default	Notes
*withdrawalId	integer		WithdrawalId to reject.

Responses

Status Code	Description	Samples
200	When there is a Withdrawal with the provided identifier and it is rejected.
404	When there is no Withdrawal with the provided identifier, or you do not have permission to view the Withdrawal
410	When there is a Withdrawal with the provided identifier but it can no longer be rejected.

Withdrawals_/BoEPaymentPurposes_List

Returns a list of entities of type PaymentPurposeDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Withdrawals/BoEPaymentPurposes

Responses

Status Code	Description	Samples
200	OData endpoint for entity PaymentPurposeDto

Withdrawals_CreateAccountWithdrawal

Creates an ad-hoc Withdrawal.

Request

POST /v1/Withdrawals/CreateAccountWithdrawal

Parameters

Name	Type	Default	Notes
*request			The details of the Withdrawal to be created.

Responses

Status Code	Description	Samples
201	When the Withdrawal has been created successfully. The HTTP Header 'Location' will contain the URL with the details of the created Withdrawal.
400	When there has been an error in any of the Withdrawal's attributes

Withdrawals_CreateInstructionWithdrawal

Creates a Withdrawal configured and triggered by completion of an Instruction.

Request

POST /v1/Withdrawals/CreateInstructionWithdrawal

Parameters

Name	Type	Default	Notes
*request			The details of the Withdrawal to be created

Responses

Status Code	Description	Samples
201	When the Withdrawal has been created successfully. The HTTP Header 'Location' will contain the URL with the details of the created Withdrawal.
400	When there has been an error in any of the Withdrawal's attributes

Withdrawals_/PaymentPurposes(CountryCode = {countryCode})_Single

Returns a list of entities of type PaymentPurposeDto

OData v4 Query endpoint. Metadata associated

Request

GET /v1/Withdrawals/PaymentPurposes(CountryCode = {countryCode})

Parameters

Name	Type	Default	Notes
*countryCode	string		OData v4 Query endpoint. Metadata associated

Responses

Status Code	Description	Samples
200	OData endpoint for entity PaymentPurposeDto

Other APIs

ExchangeRates_GetMidRate

Returns a mid rate for a currency pair

Request

GET /v1/ExchangeRates/MidRate/{sourceCurrencyCode}/{targetCurrencyCode}

Parameters

Name	Type	Default	Notes
*sourceCurrencyCode	string
*targetCurrencyCode	string

Responses

Status Code	Description	Samples
200	When a rate for the currency pair is found

Definitions

CreateAlertRequest

Name	Type	Notes
SourceCurrencyCode	string	The source currency for the exchange rate
TargetCurrencyCode	string	The target currency for the exchange rate
Limit	number (decimal)	The exchange rate threashold for the alert

AlertDto

Name	Type	Notes
Id	integer (int32)
SourceCurrencyCode	string
TargetCurrencyCode	string
Limit	number (decimal)
CreatedDate	string (date-time)
Rate	number (double)
ValueDate	string (date-time)
NotifiedDate	string (date-time)
CancelledDate	string (date-time)
Active	boolean

GetBeneficiaryRequiredAdditionalPropertiesResponse

Name	Type	Notes
RequiredAdditionalInformation	RequiredAdditionalInformation[]

RequiredAdditionalInformation

Name	Type	Notes
Field	string
Rule	Rule[]

Rule

Name	Type	Notes
RegEx	string

CreateWithdrawalBeneficiaryRequest

Name	Type	Notes
AccountId	integer (int32)	The account id for which the beneficiary will be created
Name	string	The name of the beneficiary
AccountHolderName	string	The name of the bank account holder
PaymentRouting	IPartyIdentification[]	Payment routing information
AlternatePaymentRouting	IPartyIdentification[]	Alternate payment routing information for the same beneficiary to be used for possible payment optimizations.
IntermediaryPaymentRouting	IPartyIdentification[]	Intermediary routing information
CurrencyCode	string	The currency of the transferred funds
BeneficiaryType	string	The type of the beneficiary
Address	AddressDto[]	The address of the beneficiary
IndustryId	integer (int32)	The industry for which the beneficiary belongs
Website	string	The beneficiary website
IndustryDetails	string	The industry details of the industry for which the beneficiary belongs. Only mandatory if industry is Other
AdditionalInformation	object	Additional information required for certain countries of residence/payment routing country combinations.
Reference	string	The withdrawal reference, up to 35 characters
ReceiverLei	string	The Legal Entity Identifier, only applicable when the industry is a Financial Institution Bank or Building Societies

IPartyIdentification

Payment routing information

AddressDto

The address of the beneficiary

Name	Type	Notes
Street	string
HouseNumber	string
HouseName	string
FlatNumber	string
District	string
Town	string
County	string
PostCode	string
CountryCode	string

CreateResultDto

Name	Type	Notes
Id	integer (int32)

AssignDepositorDto

Name	Type	Notes
IsThirdParty	boolean
Individual	IndividualDepositorDto[]
Company	CompanyDepositorDto[]
SupportingDocuments	StreamedHttpFile[]

IndividualDepositorDto

Name	Type	Notes
FirstName	string
MiddleName	string
LastName	string
PhoneNumber	string
Address	AddressDto[]

CompanyDepositorDto

Name	Type	Notes
Name	string
PhoneNumber	string
Website	string
IndustryId	integer (int32)
IndustryDetails	string
Address	AddressDto[]

StreamedHttpFile

Name	Type	Notes
Stream	Stream[]
StreamLength	integer (int64)
Name	string
MediaType	string

Stream

Name	Type	Notes
__identity	object

DepositRequirementRequest

Name	Type	Notes
AccountId	integer (int32)
NetDepositRequirement	number (decimal)
CurrencyCode	string

CreateExchangeRequest

Name	Type	Notes
AccountId	integer (int32)	The account id for which the exchange will be created
SourceCurrencyCode	string	The currency to be disposed of
TargetCurrencyCode	string	The currency to be acquired
Goal	number (decimal)	The amount to be bought or sold in this exchange, depending on GoalType
GoalType	string	The type of the goal, either 'Buy' or 'Sell'
UseAvailableFunds	boolean	True if any available funds in the account should be used for this exchange
BoEPurposeCodeId	integer (int32)	The Bank of Englad Purpose Code, required for GBP withdrawals.
ReceiverLei	string	The LEI code of the payments receiver, required if the beneficiary is a company with a vertical of FI and industry of Banks or building societies

ExchangeDto

Name	Type	Notes
Id	integer (int32)
AccountId	integer (int32)
SourceCurrencyCode	string
TargetCurrencyCode	string
InstructionTypeId	string
Goal	number (decimal)
GoalTypeCode	string
GoalType	string
Sold	number (decimal)
Bought	number (decimal)
StatusCode	string
Status	string
CreatedOn	string (date-time)
UpdatedDate	string (date-time)
Allocations	AllocationDto[]
Deposits	DepositDto[]
Fees	FeeDto[]
Withdrawals	WithdrawalDto[]
DepositReference	string

AllocationDto

Name	Type	Notes
Id	integer (int32)
Amount	number (decimal)
ValueDate	string (date-time)
DepositId	integer (int32)

DepositDto

Name	Type	Notes
Id	integer (int32)
AccountId	integer (int32)
CurrencyCode	string
Amount	number (decimal)
Reference	string
Narrative	array
ValueDate	string (date-time)
Deposited	number (decimal)
StatusCode	string
Status	string
Depositor	DepositorDetailsDto[]
CounterpartAccountName	string
ClientDepositor	ClientDepositorDetailsDto[]
Fees	FeeDto[]

DepositorDetailsDto

Name	Type	Notes
Name	string
VirtualAccount	PartyIdentificationDto[]
Counterparty	PartyIdentificationDto[]
CounterpartyBankCountry	string
CounterpartyBankName	string

PartyIdentificationDto

Name	Type	Notes
Properties	object

ClientDepositorDetailsDto

Name	Type	Notes
DepositorId	integer (int32)

FeeDto

Name	Type	Notes
Id	integer (int32)
Narative	string
CurrencyCode	string
Amount	number (double)
DefinitionAmount	number (double)
BaseAmount	number (double)
TieredFeeBaseValue	number (double)
Percentage	number (double)
PaymentScheme	string
ConfiguredCurrency	string
ConfiguredAmount	number (double)
ConfiguredPercentage	number (double)
ExchangeRate	number (double)
Cancelled	boolean
CanBeCancelled	boolean

WithdrawalDto

Name	Type	Notes
Id	integer (int32)
AccountId	integer (int32)
Account	AccountDto[]
CurrencyCode	string
Amount	number (double)
TargetCurrencyCode	string
TargetAmount	number (double)
IsCrossCurrency	boolean
OutstandingAmount	number (double)
Beneficiary	BeneficiaryDto[]
Reference	string
InstructionId	integer (int32)
CreatedDate	string (date-time)
ValueDate	string (date-time)
Description	string
StatusCode	string
Status	string
Fees	FeeDto[]

AccountDto

Name	Type	Notes
Id	integer (int32)
EntityId	integer (int32)
Name	string
AccountNumber	string
Balances	AccountBalanceDto[]
Exchanges	array
Withdrawals	array
InboundTransfers	InboundTransferDto[]
OutboundTransfers	OutboundTransferDto[]
Deposits	DepositDto[]
Beneficiaries	BeneficiaryDto[]
TransferBeneficiaries	TransferBeneficiaryDto[]
DepositInformation	DepositInformationDto[]
DepositRoutingInformation	DepositRoutingInformationDto[]
Activities	ActivityDto[]
Depositors	DepositorDto2[]
StatusCode	string
Status	string

AccountBalanceDto

Name	Type	Notes
CurrencyCode	string
Currency	CurrencyDto[]
Value	number (decimal)
Allocated	number (decimal)
Processing	number (decimal)
Available	number (decimal)
ValueDate	string (date-time)
Statement	AccountStatementItemDto[]

CurrencyDto

Name	Type	Notes
Id	string
Name	string
Type	string
Format	string
FormatTemplate	string
SignificantDigits	integer (int32)

AccountStatementItemDto

Name	Type	Notes
Id	integer (int32)
CurrencyCode	string
DeltaBalance	number (decimal)
ValueDate	string (date-time)
Sequence	string
RunningTotal	number (decimal)
Exchange	ExchangeStatementDetailsDto[]
Withdrawal	WithdrawalStatementDetailsDto[]
Transfer	TransferStatementDetailsDto[]
Deposit	DepositStatementDetailsDto[]
FundsRequest	FundsRequestStatementDetailsDto[]
Fee	FeeStatementDetailsDto[]
Narrative	string

ExchangeStatementDetailsDto

Name	Type	Notes
Id	integer (int32)
SourceCurrencyCode	string
TargetCurrencyCode	string
Goal	number (decimal)
GoalTypeCode	string
GoalType	string

WithdrawalStatementDetailsDto

Name	Type	Notes
Id	integer (int32)
Reference	string
Exchange	ExchangeStatementDetailsDto[]
BeneficiaryId	integer (int32)
BeneficiaryName	string

TransferStatementDetailsDto

Name	Type	Notes
Id	integer (int32)
Reference	string
PayerAccount	AccountInfoDto[]
BeneficiaryAccount	AccountInfoDto[]

AccountInfoDto

Name	Type	Notes
Id	integer (int32)
AccountNumber	string
Name	string

DepositStatementDetailsDto

Name	Type	Notes
Id	integer (int32)
Reference	string
CounterpartAccountName	string
Exchange	ExchangeStatementDetailsDto[]

FundsRequestStatementDetailsDto

Name	Type	Notes
Id	integer (int32)
PayeeAccountId	integer (int32)
PayerAccountId	integer (int32)
PayeeReference	string
PayerReference	string
Amount	number (decimal)
CurrencyCode	string

FeeStatementDetailsDto

Name	Type	Notes
Id	integer (int32)
AccountId	integer (int32)
DepositId	integer (int32)
Deposit	DepositStatementDetailsDto[]
WithdrawalId	integer (int32)
Withdrawal	WithdrawalStatementDetailsDto[]
TransferId	integer (int32)
Transfer	TransferStatementDetailsDto[]
ExchangeId	integer (int32)
Exchange	ExchangeStatementDetailsDto[]
Narrative	string

InboundTransferDto

Name	Type	Notes
Beneficiary	InboundTransferBeneficiaryDto[]
Id	integer (int32)
AccountId	integer (int32)
AccountName	string
CurrencyCode	string
Amount	number (double)
Reference	string
InstructionId	integer (int32)
CreatedDate	string (date-time)
ValueDate	string (date-time)
StatusCode	string
Status	string
Fees	FeeDto[]

InboundTransferBeneficiaryDto

Name	Type	Notes
Id	integer (int32)
AccountId	integer (int32)
BeneficiaryAccountId	integer (int32)
BeneficiaryAccountName	string
CurrencyCode	string

OutboundTransferDto

Name	Type	Notes
Beneficiary	OutboundTransferBeneficiaryDto[]
Id	integer (int32)
AccountId	integer (int32)
AccountName	string
CurrencyCode	string
Amount	number (double)
Reference	string
InstructionId	integer (int32)
CreatedDate	string (date-time)
ValueDate	string (date-time)
StatusCode	string
Status	string
Fees	FeeDto[]

OutboundTransferBeneficiaryDto

Name	Type	Notes
Name	string
StatusCode	string
Status	string
Id	integer (int32)
AccountId	integer (int32)
BeneficiaryAccountId	integer (int32)
BeneficiaryAccountName	string
CurrencyCode	string

BeneficiaryDto

Name	Type	Notes
Id	integer (int32)
AccountId	integer (int32)
Name	string
CurrencyCode	string
StatusCode	string
Status	string
PaymentRouting	PaymentRoutingDto[]

PaymentRoutingDto

Name	Type	Notes
AccountHolderName	string
PartyIdentification	PartyIdentificationDto[]
IntermediaryPartyIdentification	PartyIdentificationDto[]

TransferBeneficiaryDto

Name	Type	Notes
Id	integer (int32)
AccountId	integer (int32)
BeneficiaryAccountId	integer (int32)
Name	string
Website	string
Vertical	string
Industry	string
CurrencyCode	string
StatusCode	string
Status	string

DepositInformationDto

Name	Type	Notes
CurrencyCode	string
Routings	DepositInformationRoutingTempDto[]

DepositInformationRoutingTempDto

Name	Type	Notes
BeneficiaryName	string
Properties	object

DepositRoutingInformationDto

Name	Type	Notes
CurrencyCode	string
Routings	PaymentRoutingDto[]

ActivityDto

Name	Type	Notes
Id	integer (int32)
ExecutedAt	string (date-time)
UserName	string
Location	string
Description	string
ActivityType	string
ApprovalStatusId	string
InBound	boolean

DepositorDto2

Name	Type	Notes
Id	integer (int32)
CreatedDate	string (date-time)
RemitterName	string
Name	string
EntityType	string
IsThirdParty	boolean
Address	AddressDto[]
Website	string
Industry	IndustryDto[]
IndustryDetails	string
PhoneNumber	string
StatusCode	string
Status	string
ComplianceOverridenEntityTypeId	string

IndustryDto

Name	Type	Notes
Id	integer (int32)
Name	string

QuoteRequest

Name	Type	Notes
AccountId	integer (int32)	The account context for the quote
GoalType	string	The goal of the quote, either a 'Buy' or a 'Sell'
Amount	number (decimal)	The amount to buy or sell
SourceCurrencyCode	string	The currency to be disposed of
TargetCurrencyCode	string	The currency to be acquired

CreateAccountTransferRequest

Name	Type	Notes
AccountId	integer (int32)	The account id for which the instruction will be created
CurrencyCode	string	The currency to be transferred
Amount	number (double)	The amount to be transferred. If left empty, the maximum transferrable amount will be requested for transfer
BeneficiaryId	integer (int32)	The beneficiary id which will receive the funds
Reference	string	The reference for the transaction

CreateAccountWithdrawalRequest

Name	Type	Notes
AccountId	integer (int32)	The account id for which the withdrawal will be created
CurrencyCode	string	The currency to be withdrawn
Amount	number (double)	The amount to be withdrawn. If left empty, the maximum withdrawable amount will be requested for withdrawal
BeneficiaryId	integer (int32)	The beneficiary id who will receive the funds
Reference	string	The withdrawal reference, up to 35 characters
Description	string	The withdrawal description, up to 140 characters
PaymentPurposeId	integer (int32)	The payment purpose id
UltimateOriginator	UltimateOriginatorDto[]	The ultimate originator. Use only if you are creating a withdrawal on behalf of another party or entity.
PaymentChargesCode	string	The payment charges code, OUR or SHA.
BoEPurposeCodeId	integer (int32)	The Bank of Englad Purpose Code, required for GBP withdrawals.
ReceiverLei	string	The LEI code of the payments receiver, required if the

UltimateOriginatorDto

The ultimate originator. Use only if you are creating a withdrawal on behalf of another party or entity.

Name	Type	Notes
Name	string
Address	AddressDto[]
SubaccountNumber	string

CreateInstructionWithdrawalRequest

Name	Type	Notes
InstructionId	integer (int32)	The instruction id which will trigger this withdrawal
BeneficiaryId	integer (int32)	The beneficiary id who will receive the funds
PaymentPurposeId	integer (int32)	The payment purpose id
UltimateOriginator	UltimateOriginatorDto[]	The ultimate originator. Use only if you are creating a withdrawal on behalf of another party or entity.
PaymentChargesCode	string	The payment charges code, OUR or SHA.
BoEPurposeCodeId	integer (int32)	The Bank of Englad Purpose Code, required for GBP withdrawals.
ReceiverLei	string	The LEI code of the payments receiver, required if the beneficiary is a company with a vertical of FI and industry of Banks or building societies

MidRateValue

Name	Type	Notes
SourceCurrencyCode	string
TargetCurrencyCode	string
ValueDate	string (date-time)
MidRate	number (decimal)