FxHubPartnersApi

<back to all web services

CreateTradeQuote

Requires Authentication
The following routes are available for this service:
POST/trade_quotes/save
CreateTradeQuote Parameters:
NameParameterData TypeRequiredDescription
TradeQuotesbodyTradeQuotesNo
RetailClientbodyRetailClientNo
ClientTccbodyClientTccNo
SdaRemainderbodySdaRemainderNo
TccRemainderbodyTccRemainderNo
CashBalancesbodyCashBalancesNo
RiskRatingbodyRiskRatingNo
TradeQuoteMessagesbodyTradeQuoteMessageNo
TradeQuotes Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerIdformintNo
PartnerNameformstringNo
UserIdformintNo
UserNameformstringNo
AdminIdformintNo
AdminNameformstringNo
ClientIdformintNo
FirstLastNameformstringNo
SelectedRateformstringNo
TradeTypeformstringNo
EnteredZarformboolNo
CrossCurrencyformstringNo
TradeCurrencyformstringNo
TradeTimingformstringNo
CommissionRateformdecimal?No
CommissionRateInclVatformdecimal?No
BuyZarTradeZarValueformdecimal?No
BuyZarTradeCrossValueformdecimal?No
SellZarTradeZarValueformdecimal?No
SellZarTradeCrossValueformdecimal?No
CrossTradeValueformdecimal?No
CrossTradeCrossValueformdecimal?No
TradeValueformdecimal?No
CrossValueformdecimal?No
QuotedRateformdecimal?No
ClientRateformdecimal?No
InitialSendformDateTime?No
InitialSendTimeformstringNo
InitialReplyTimeformstringNo
QuoteStatusformstringNo
QuoteAcceptedformbool?No
QuoteAcceptedDateformDateTime?No
QuoteAcceptedTimeformstringNo
QuoteDeclinedDateformDateTime?No
QuoteDeclinedTimeformstringNo
AcHasRepliedformbool?No
ZarAccountNumberformstringNo
FcaAccountNumber1formstringNo
FcaAccountNumber2formstringNo
TradeAccountNumberformstringNo
FcaCurrency1formstringNo
FcaCurrency2formstringNo
HasClientTccformbool?No
TccApplicationStatusformstringNo
SdaRemainderformdecimal?No
TccRemainderformdecimal?No
CurrentZarCashBalanceformdecimal?No
CurrentFca1CashBalanceformdecimal?No
CurrentFca2CashBalanceformdecimal?No
CurrentTradeCashBalanceformdecimal?No
HasChatEnabledformbool?No
DoesHaveChatformstringNo
HasSufficientCashBalanceformstringNo
HasSufficientSdaBalanceformstringNo
HasSufficientTccBalanceformstringNo
RiskStatusformstringNo
ActualTradedRateformdecimal?No
TradeQuoteMessagesformList<TradeQuoteMessage>No
TradeQuoteMessage Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SentByformstringNo
UpdatedAtformstringNo
RetailClient Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerIdformintNo
PartnerIdsformList<int>No
PartnerNameformstringNo
ClientTypeformstringNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
FullNamesformstringNo
FirstLastNameformstringNo
TitleformstringNo
GenderformstringNo
RaceformstringNo
ResidencyStatusformstringNo
TaxRefNumberformstringNo
IdNumberformstringNo
DateOfBirthformDateTime?No
PlaceOfBirthformstringNo
NationalityformstringNo
CountryOfResidenceformstringNo
PassportNumberformstringNo
PassportIssueDateformDateTime?No
PassportExpiryDateformDateTime?No
PassportCountryformstringNo
TempResNumberformstringNo
TempResDateformstringNo
EmailAddressformstringNo
ContactNumber1formstringNo
ContactNumber2formstringNo
ContactNumber3formstringNo
AddressformstringNo
SuburbformstringNo
CityformstringNo
ProvinceformstringNo
PostalCodeformstringNo
CountryformstringNo
PostalSameAsStreetformbool?No
PostalAddressformstringNo
PostalSuburbformstringNo
PostalCityformstringNo
PostalProvinceformstringNo
PostalPostalCodeformstringNo
PostalCountryformstringNo
IsSoleProprietorformbool?No
TradingSameAsStreetformbool?No
TradingAddressformstringNo
TradingSuburbformstringNo
TradingCityformstringNo
TradingProvinceformstringNo
TradingPostalCodeformstringNo
TradingCountryformstringNo
OccupationformstringNo
OccupationSpecifyformstringNo
DesignationformstringNo
DesignationSpecifyformstringNo
BusinessTypeformstringNo
IsZarAccountformbool?No
FcaRequiredformbool?No
FcaCurrency1formstringNo
FcaCurrency2formstringNo
FcaDetailsformstringNo
TradeLimitformstringNo
LessR10kformbool?No
LessR20kformbool?No
LessR50kformbool?No
LessR100kformbool?No
MoreR100kformbool?No
MonthlyIncomeformstringNo
AccountPurposeformstringNo
SourceOfFundsformstringNo
SourceOfFundsSpecifyformstringNo
SourceOfWealthformstringNo
SourceOfWealthSpecifyformstringNo
AccountDomicileformstringNo
ThirdPartyAccountformstringNo
InvestmentValueformstringNo
UsPersonYesformbool?No
UsPersonNoformbool?No
TinNumberformstringNo
ExSaTaxResidentYesformbool?No
ExSaTaxResidentNoformbool?No
Country1formstringNo
TinNumber1formstringNo
Country2formstringNo
TinNumber2formstringNo
CurrentDateformDateTime?No
MultipleSignatoriesformboolNo
Capacity1formstringNo
ClSignFullNames2formstringNo
Capacity2formstringNo
MustSignformstringNo
SignedAtformstringNo
StatusformstringNo
CifNumberformstringNo
ZarAccountNumberformstringNo
FcaAccountNumber1formstringNo
FcaAccountNumber2formstringNo
FaceToFaceformbool?No
NonFaceToFaceformbool?No
BrokerIntroducedformbool?No
TradingAccountformbool?No
Residentformbool?No
NonResidentformbool?No
EmigrantBlockedAccountformbool?No
EbaSavingsformbool?No
EbaCurrentformbool?No
EbaTradingAccountformbool?No
ExternalReferenceformstringNo
GeoCodeformstringNo
ExchangeControl1formbool?No
ExchangeControl2formbool?No
ExchangeControl3formbool?No
TheAgentformstringNo
IpIntroducerformstringNo
IsSwitchClientformbool?No
PreviousIntermediaryformstringNo
ResignationDateformDateTime?No
IsPartnerClientformbool?No
ClientAllocatedToPartnerformbool?No
HavePopiPermissionformbool?No
IsSanctionsCheckCompleteformbool?No
SanctionsScreenformstringNo
HasForm25Dataformbool?No
HasClientTccformbool?No
HasClientTccPendingformbool?No
HasHadClientTccformbool?No
IsDeactivatedformbool?No
DeactivatedDateformDateTime?No
DiscretionaryAllowanceformdecimal?No
DaStartDateformDateTime?No
DaEndDateformDateTime?No
ProgressOneformbool?No
ProgressTwoformbool?No
ProgressThreeformbool?No
IsEditingformbool?No
HasFicaUploadformbool?No
CreatedByUserIdformintNo
CompletedNotificationSentformbool?No
HigherRiskClientsChecksDoneformbool?No
LessAnnual100kformbool?No
LessAnnual250kformbool?No
LessAnnual500kformbool?No
LessAnnual1milformbool?No
MoreAnnual1milformbool?No
SpotForeignExchangeformbool?No
ForwardExchangeformbool?No
ClientTcc Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
FullNamesformstringNo
FirstLastNameformstringNo
PartnerIdformintNo
PartnerNameformstringNo
ApplicationStatusformstringNo
TccIssuerformstringNo
TccPinformstringNo
TccValueformdecimal?No
IssueDateformDateTime?No
ExpiryDateformDateTime?No
Chargesformdecimal?No
ChargesInvoiceformstringNo
ChargesDateformDateTime?No
ChargesTypeformstringNo
CommentsformstringNo
InitialSendformDateTime?No
UpdatedAtformDateTime?No
TimeElapsedformdoubleNo
HasTccDocsformbool?No
SdaRemainder Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
FirstLastNameformstringNo
PartnerIdformintNo
PartnerNameformstringNo
CifNumberformstringNo
DaRemainderformdecimal?No
InputDateformDateTime?No
TotalTradesformdecimal?No
TccRemainder Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
FirstLastNameformstringNo
PartnerIdformintNo
PartnerNameformstringNo
TccRemaindersformdecimal?No
CifNumberformstringNo
DaRemainderformdecimal?No
InputDateformDateTime?No
TccValueformdecimal?No
TotalTradesformdecimal?No
ApplicationStatusformstringNo
ExpiredPreviousYearformbool?No
PinformstringNo
TccIdformintNo
CashBalances Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
FirstLastNameformstringNo
PartnerIdformintNo
PartnerNameformstringNo
CifNumberformstringNo
AccountNumberformstringNo
AccountCurrencyformstringNo
CurrentBalanceformdecimalNo
InputDateformDateTimeNo
RiskRating Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
FullNamesformstringNo
FirstLastNameformstringNo
PartnerIdformintNo
PartnerNameformstringNo
IdNumberformstringNo
UpdatedAtformDateTime?No
NationalityformstringNo
NationalityRiskLevelDescriptionformstringNo
NationalityRiskLevelScoreformint?No
AccountDomicileformstringNo
AccountDomicileRiskLevelDescriptionformstringNo
AccountDomicileRiskLevelScoreformint?No
CountryOfResidenceformstringNo
CountryOfResidenceRiskLevelDescriptionformstringNo
CountryOfResidenceRiskLevelScoreformint?No
OccupationformstringNo
OccupationRiskLevelDescriptionformstringNo
OccupationRiskLevelScoreformint?No
SourceOfFundsformstringNo
SourceOfFundsRiskLevelDescriptionformstringNo
SourceOfFundsRiskLevelScoreformint?No
SourceOfWealthformstringNo
SourceOfWealthRiskLevelDescriptionformstringNo
SourceOfWealthRiskLevelScoreformint?No
ThirdPartyformstringNo
ThirdPartyRiskLevelDescriptionformstringNo
ThirdPartyRiskLevelScoreformint?No
InvestmentValueformstringNo
InvestmentValueRiskLevelDescriptionformstringNo
InvestmentValueRiskLevelScoreformint?No
SanctionsScreenformstringNo
SanctionsScreenRiskLevelDescriptionformstringNo
SanctionsScreenRiskLevelScoreformint?No
SumScoreformint?No
SumScoreDescriptionformstringNo
InitialFicaDateformDateTime?No
NextFicaDateformDateTime?No
RequireReficaformbool?No
CommentsformstringNo
CreateTradeQuoteResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /trade_quotes/save HTTP/1.1 
Host: api.fxhub.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"tradeQuotes":{"id":0,"partnerId":0,"partnerName":"String","userId":0,"userName":"String","adminId":0,"adminName":"String","clientId":0,"firstLastName":"String","selectedRate":"String","tradeType":"String","enteredZar":false,"crossCurrency":"String","tradeCurrency":"String","tradeTiming":"String","commissionRate":0,"commissionRateInclVat":0,"buyZarTradeZarValue":0,"buyZarTradeCrossValue":0,"sellZarTradeZarValue":0,"sellZarTradeCrossValue":0,"crossTradeValue":0,"crossTradeCrossValue":0,"tradeValue":0,"crossValue":0,"quotedRate":0,"clientRate":0,"initialSend":"0001-01-01","initialSendTime":"String","initialReplyTime":"String","quoteStatus":"String","quoteAccepted":false,"quoteAcceptedDate":"0001-01-01","quoteAcceptedTime":"String","quoteDeclinedDate":"0001-01-01","quoteDeclinedTime":"String","acHasReplied":false,"zarAccountNumber":"String","fcaAccountNumber1":"String","fcaAccountNumber2":"String","tradeAccountNumber":"String","fcaCurrency1":"String","fcaCurrency2":"String","hasClientTcc":false,"tccApplicationStatus":"String","sdaRemainder":0,"tccRemainder":0,"currentZarCashBalance":0,"currentFca1CashBalance":0,"currentFca2CashBalance":0,"currentTradeCashBalance":0,"hasChatEnabled":false,"doesHaveChat":"String","hasSufficientCashBalance":"String","hasSufficientSdaBalance":"String","hasSufficientTccBalance":"String","riskStatus":"String","actualTradedRate":0,"tradeQuoteMessages":[{"message":"String","sentBy":"String","updatedAt":"String"}]},"retailClient":{"id":0,"partnerId":0,"partnerIds":[0],"partnerName":"String","clientType":"String","firstName":"String","middleName":"String","lastName":"String","fullNames":"String String String","firstLastName":"String String","title":"String","gender":"String","race":"String","residencyStatus":"String","taxRefNumber":"String","idNumber":"String","dateOfBirth":"0001-01-01","placeOfBirth":"String","nationality":"String","countryOfResidence":"String","passportNumber":"String","passportIssueDate":"0001-01-01","passportExpiryDate":"0001-01-01","passportCountry":"String","tempResNumber":"String","tempResDate":"String","emailAddress":"String","contactNumber1":"String","contactNumber2":"String","contactNumber3":"String","address":"String","suburb":"String","city":"String","province":"String","postalCode":"String","country":"String","postalSameAsStreet":false,"postalAddress":"String","postalSuburb":"String","postalCity":"String","postalProvince":"String","postalPostalCode":"String","postalCountry":"String","isSoleProprietor":false,"tradingSameAsStreet":false,"tradingAddress":"String","tradingSuburb":"String","tradingCity":"String","tradingProvince":"String","tradingPostalCode":"String","tradingCountry":"String","occupation":"String","occupationSpecify":"String","designation":"String","designationSpecify":"String","businessType":"String","isZarAccount":false,"fcaRequired":false,"fcaCurrency1":"String","fcaCurrency2":"String","fcaDetails":"String","tradeLimit":"String","lessR10k":false,"lessR20k":false,"lessR50k":false,"lessR100k":false,"moreR100k":false,"monthlyIncome":"String","accountPurpose":"String","sourceOfFunds":"String","sourceOfFundsSpecify":"String","sourceOfWealth":"String","sourceOfWealthSpecify":"String","accountDomicile":"String","thirdPartyAccount":"String","investmentValue":"String","usPersonYes":false,"usPersonNo":false,"tinNumber":"String","exSaTaxResidentYes":false,"exSaTaxResidentNo":false,"country1":"String","tinNumber1":"String","country2":"String","tinNumber2":"String","currentDate":"0001-01-01","multipleSignatories":false,"capacity1":"String","clSignFullNames2":"String","capacity2":"String","mustSign":"String","signedAt":"String","status":"String","cifNumber":"String","zarAccountNumber":"String","fcaAccountNumber1":"String","fcaAccountNumber2":"String","faceToFace":false,"nonFaceToFace":false,"brokerIntroduced":false,"tradingAccount":false,"resident":false,"nonResident":false,"emigrantBlockedAccount":false,"ebaSavings":false,"ebaCurrent":false,"ebaTradingAccount":false,"externalReference":"String","geoCode":"String","exchangeControl1":false,"exchangeControl2":false,"exchangeControl3":false,"theAgent":"String","ipIntroducer":"String","isSwitchClient":false,"previousIntermediary":"String","resignationDate":"0001-01-01","isPartnerClient":false,"clientAllocatedToPartner":false,"havePopiPermission":false,"isSanctionsCheckComplete":false,"sanctionsScreen":"String","hasForm25Data":false,"hasClientTcc":false,"hasClientTccPending":false,"hasHadClientTcc":false,"isDeactivated":false,"deactivatedDate":"0001-01-01","discretionaryAllowance":0,"daStartDate":"0001-01-01","daEndDate":"0001-01-01","progressOne":false,"progressTwo":false,"progressThree":false,"isEditing":false,"hasFicaUpload":false,"createdByUserId":0,"completedNotificationSent":false,"higherRiskClientsChecksDone":false,"lessAnnual100k":false,"lessAnnual250k":false,"lessAnnual500k":false,"lessAnnual1mil":false,"moreAnnual1mil":false,"spotForeignExchange":false,"forwardExchange":false},"clientTcc":{"id":0,"clientId":0,"fullNames":"String","firstLastName":"String","partnerId":0,"partnerName":"String","applicationStatus":"String","tccIssuer":"String","tccPin":"String","tccValue":0,"issueDate":"0001-01-01","expiryDate":"0001-01-01","charges":0,"chargesInvoice":"String","chargesDate":"0001-01-01","chargesType":"String","comments":"String","initialSend":"0001-01-01","updatedAt":"0001-01-01","timeElapsed":0,"hasTccDocs":false},"sdaRemainder":{"id":0,"clientId":0,"firstLastName":"String","partnerId":0,"partnerName":"String","cifNumber":"String","daRemainder":0,"inputDate":"0001-01-01","totalTrades":0},"tccRemainder":{"id":0,"clientId":0,"firstLastName":"String","partnerId":0,"partnerName":"String","tccRemainders":0,"cifNumber":"String","daRemainder":0,"inputDate":"0001-01-01","tccValue":0,"totalTrades":0,"applicationStatus":"String","expiredPreviousYear":false,"pin":"String","tccId":0},"cashBalances":{"id":0,"clientId":0,"firstLastName":"String","partnerId":0,"partnerName":"String","cifNumber":"String","accountNumber":"String","accountCurrency":"String","currentBalance":0,"inputDate":"0001-01-01"},"riskRating":{"id":0,"clientId":0,"fullNames":"String","firstLastName":"String","partnerId":0,"partnerName":"String","idNumber":"String","updatedAt":"0001-01-01","nationality":"String","nationalityRiskLevelDescription":"String","nationalityRiskLevelScore":0,"accountDomicile":"String","accountDomicileRiskLevelDescription":"String","accountDomicileRiskLevelScore":0,"countryOfResidence":"String","countryOfResidenceRiskLevelDescription":"String","countryOfResidenceRiskLevelScore":0,"occupation":"String","occupationRiskLevelDescription":"String","occupationRiskLevelScore":0,"sourceOfFunds":"String","sourceOfFundsRiskLevelDescription":"String","sourceOfFundsRiskLevelScore":0,"sourceOfWealth":"String","sourceOfWealthRiskLevelDescription":"String","sourceOfWealthRiskLevelScore":0,"thirdParty":"String","thirdPartyRiskLevelDescription":"String","thirdPartyRiskLevelScore":0,"investmentValue":"String","investmentValueRiskLevelDescription":"String","investmentValueRiskLevelScore":0,"sanctionsScreen":"String","sanctionsScreenRiskLevelDescription":"String","sanctionsScreenRiskLevelScore":0,"sumScore":0,"sumScoreDescription":"String","initialFicaDate":"0001-01-01","nextFicaDate":"0001-01-01","requireRefica":false,"comments":"String"},"tradeQuoteMessages":{"message":"String","sentBy":"String","updatedAt":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":false,"message":"String"}