GET settings
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
SettingsName | Description | Type | Additional information |
---|---|---|---|
BrokerCode | string |
None. |
|
ACHDepositMinimum | decimal number |
None. |
|
AIPDepositMinimum | decimal number |
None. |
|
BrokerUid | globally unique identifier |
None. |
|
BrokerName | string |
None. |
|
RootUrl | string |
None. |
|
SiteUrl | string |
None. |
|
WireWithdrawalFee | decimal number |
None. |
|
AchDepositLimit | decimal number |
None. |
|
CheckDepositLimit | decimal number |
None. |
|
MetaltreamMinimumDepositAmount | decimal number |
None. |
|
SupportSendQuickMessageUrl | string |
None. |
|
SupportEmail | string |
None. |
|
SupportPhone | string |
None. |
|
SupportPhoneTollFree | string |
None. |
|
SupportPhoneInternational | string |
None. |
|
SupportWorkingHours | string |
None. |
|
PricingRefreshFrequencyMilliseconds | decimal number |
None. |
|
FrequentlyAskedQuestionsUrl | string |
None. |
|
TermsAndConditionsUrl | string |
None. |
|
WebsiteUrl | string |
None. |
|
DisclaimerUrl | string |
None. |
|
AccessibilityStatementUrl | string |
None. |
|
RegistrationUrlV1 | string |
None. |
|
RegistrationUrlV2 | string |
None. |
|
VerificationInternalBatchAccountUid | globally unique identifier |
None. |
|
PaymentInternalBatchAccountUid | globally unique identifier |
None. |
|
AllowHAAPipeDriveCRM | boolean |
None. |
|
InvokeIdentityCall | boolean |
None. |
|
RegistrationAPIResetPasswordUrl | string |
None. |
|
PasswordResetLinkExpirationHours | integer |
None. |
|
DocumentAddress | Address |
None. |
|
PrivacyPolicyDocumentUrl | string |
None. |
|
RegistrationContributionLimitAmount | decimal number |
None. |
|
WireDepositLimit | decimal number |
None. |
|
PortalGatewayISOCodesListToIgnoreAreaCode | Collection of string |
None. |
|
IsEquityIRAAllowed | boolean |
None. |
|
CAPrivacyRightsUrl | string |
None. |
|
MetalStreamMaximumDepositAmount | decimal number |
None. |
|
EnableGoogleReCaptcha | boolean |
None. |
|
ShowIntercomLiveChatTool | boolean |
None. |
|
MetalStreamCaption | string |
None. |
|
PortalUrl | string |
None. |
|
EquityIraSetupFee | integer |
None. |
|
EquityIraSetupOneTimeFee | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{ "BrokerCode": "sample string 1", "ACHDepositMinimum": 2.0, "AIPDepositMinimum": 3.0, "BrokerUid": "03a7d992-4cab-4025-8299-f344dc65be1d", "BrokerName": "sample string 5", "RootUrl": "sample string 6", "SiteUrl": "sample string 7", "WireWithdrawalFee": 8.0, "AchDepositLimit": 9.0, "CheckDepositLimit": 10.0, "MetaltreamMinimumDepositAmount": 11.0, "SupportSendQuickMessageUrl": "sample string 12", "SupportEmail": "sample string 13", "SupportPhone": "sample string 14", "SupportPhoneTollFree": "sample string 15", "SupportPhoneInternational": "sample string 16", "SupportWorkingHours": "sample string 17", "PricingRefreshFrequencyMilliseconds": 18.0, "FrequentlyAskedQuestionsUrl": "sample string 19", "TermsAndConditionsUrl": "sample string 20", "WebsiteUrl": "sample string 21", "DisclaimerUrl": "sample string 22", "AccessibilityStatementUrl": "sample string 23", "RegistrationUrlV1": "sample string 24", "RegistrationUrlV2": "sample string 25", "VerificationInternalBatchAccountUid": "57204945-9713-4e95-824c-270db761e66b", "PaymentInternalBatchAccountUid": "9fa3811f-5596-4f29-abd0-34e5ad68bd06", "AllowHAAPipeDriveCRM": true, "InvokeIdentityCall": true, "RegistrationAPIResetPasswordUrl": "sample string 30", "PasswordResetLinkExpirationHours": 31, "DocumentAddress": { "AddressUid": "34701472-f627-41d2-84ce-b35196821deb", "Street": "sample string 2", "AptOrSuite": "sample string 3", "City": "sample string 4", "State": "sample string 5", "CountryIso3Code": "sample string 6", "PostalCode": "sample string 7" }, "PrivacyPolicyDocumentUrl": "sample string 32", "RegistrationContributionLimitAmount": 33.0, "WireDepositLimit": 34.0, "PortalGatewayISOCodesListToIgnoreAreaCode": [ "sample string 1", "sample string 2" ], "IsEquityIRAAllowed": true, "CAPrivacyRightsUrl": "sample string 36", "MetalStreamMaximumDepositAmount": 37.0, "EnableGoogleReCaptcha": true, "ShowIntercomLiveChatTool": true, "MetalStreamCaption": "sample string 40", "PortalUrl": "sample string 41", "EquityIraSetupFee": 42, "EquityIraSetupOneTimeFee": 1.0 }
application/xml, text/xml
Sample:
<Settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBI.WebAPI.RegistrationGateway.Business.Models.Registration"> <ACHDepositMinimum>2</ACHDepositMinimum> <AIPDepositMinimum>3</AIPDepositMinimum> <AccessibilityStatementUrl>sample string 23</AccessibilityStatementUrl> <AchDepositLimit>9</AchDepositLimit> <AllowHAAPipeDriveCRM>true</AllowHAAPipeDriveCRM> <BrokerCode>sample string 1</BrokerCode> <BrokerName>sample string 5</BrokerName> <BrokerUid>03a7d992-4cab-4025-8299-f344dc65be1d</BrokerUid> <CAPrivacyRightsUrl>sample string 36</CAPrivacyRightsUrl> <CheckDepositLimit>10</CheckDepositLimit> <DisclaimerUrl>sample string 22</DisclaimerUrl> <DocumentAddress> <AddressUid>34701472-f627-41d2-84ce-b35196821deb</AddressUid> <AptOrSuite>sample string 3</AptOrSuite> <City>sample string 4</City> <CountryIso3Code>sample string 6</CountryIso3Code> <PostalCode>sample string 7</PostalCode> <State>sample string 5</State> <Street>sample string 2</Street> </DocumentAddress> <EnableGoogleReCaptcha>true</EnableGoogleReCaptcha> <EquityIraSetupFee>42</EquityIraSetupFee> <EquityIraSetupOneTimeFee>1</EquityIraSetupOneTimeFee> <FrequentlyAskedQuestionsUrl>sample string 19</FrequentlyAskedQuestionsUrl> <InvokeIdentityCall>true</InvokeIdentityCall> <IsEquityIRAAllowed>true</IsEquityIRAAllowed> <MetalStreamCaption>sample string 40</MetalStreamCaption> <MetalStreamMaximumDepositAmount>37</MetalStreamMaximumDepositAmount> <MetaltreamMinimumDepositAmount>11</MetaltreamMinimumDepositAmount> <PasswordResetLinkExpirationHours>31</PasswordResetLinkExpirationHours> <PaymentInternalBatchAccountUid>9fa3811f-5596-4f29-abd0-34e5ad68bd06</PaymentInternalBatchAccountUid> <PortalGatewayISOCodesListToIgnoreAreaCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </PortalGatewayISOCodesListToIgnoreAreaCode> <PortalUrl>sample string 41</PortalUrl> <PricingRefreshFrequencyMilliseconds>18</PricingRefreshFrequencyMilliseconds> <PrivacyPolicyDocumentUrl>sample string 32</PrivacyPolicyDocumentUrl> <RegistrationAPIResetPasswordUrl>sample string 30</RegistrationAPIResetPasswordUrl> <RegistrationContributionLimitAmount>33</RegistrationContributionLimitAmount> <RegistrationUrlV1>sample string 24</RegistrationUrlV1> <RegistrationUrlV2>sample string 25</RegistrationUrlV2> <RootUrl>sample string 6</RootUrl> <ShowIntercomLiveChatTool>true</ShowIntercomLiveChatTool> <SiteUrl>sample string 7</SiteUrl> <SupportEmail>sample string 13</SupportEmail> <SupportPhone>sample string 14</SupportPhone> <SupportPhoneInternational>sample string 16</SupportPhoneInternational> <SupportPhoneTollFree>sample string 15</SupportPhoneTollFree> <SupportSendQuickMessageUrl>sample string 12</SupportSendQuickMessageUrl> <SupportWorkingHours>sample string 17</SupportWorkingHours> <TermsAndConditionsUrl>sample string 20</TermsAndConditionsUrl> <VerificationInternalBatchAccountUid>57204945-9713-4e95-824c-270db761e66b</VerificationInternalBatchAccountUid> <WebsiteUrl>sample string 21</WebsiteUrl> <WireDepositLimit>34</WireDepositLimit> <WireWithdrawalFee>8</WireWithdrawalFee> </Settings>