GET settings
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
SettingsName | Description | Type | Additional information |
---|---|---|---|
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. |
|
RegistrationUrl | 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. |
Response Formats
application/json, text/json
Sample:
{ "ACHDepositMinimum": 1.0, "AIPDepositMinimum": 2.0, "BrokerUid": "ccf016e4-f9cc-4ab6-accb-0dac7382f219", "BrokerName": "sample string 4", "RootUrl": "sample string 5", "SiteUrl": "sample string 6", "WireWithdrawalFee": 7.0, "AchDepositLimit": 8.0, "CheckDepositLimit": 9.0, "MetaltreamMinimumDepositAmount": 10.0, "SupportSendQuickMessageUrl": "sample string 11", "SupportEmail": "sample string 12", "SupportPhone": "sample string 13", "SupportPhoneTollFree": "sample string 14", "SupportPhoneInternational": "sample string 15", "SupportWorkingHours": "sample string 16", "PricingRefreshFrequencyMilliseconds": 17.0, "FrequentlyAskedQuestionsUrl": "sample string 18", "TermsAndConditionsUrl": "sample string 19", "WebsiteUrl": "sample string 20", "DisclaimerUrl": "sample string 21", "AccessibilityStatementUrl": "sample string 22", "RegistrationUrl": "sample string 23", "VerificationInternalBatchAccountUid": "d91d9459-e4a1-438b-b878-22d85245d000", "PaymentInternalBatchAccountUid": "a6ba9e5f-1e26-40c9-b6e8-fe2bae55dd67", "AllowHAAPipeDriveCRM": true, "InvokeIdentityCall": true, "RegistrationAPIResetPasswordUrl": "sample string 28", "PasswordResetLinkExpirationHours": 29, "DocumentAddress": { "AddressUid": "4c7754ba-8cac-4b95-b654-06037f1995ec", "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 30", "RegistrationContributionLimitAmount": 31.0, "WireDepositLimit": 32.0, "PortalGatewayISOCodesListToIgnoreAreaCode": [ "sample string 1", "sample string 2" ], "IsEquityIRAAllowed": true, "CAPrivacyRightsUrl": "sample string 34", "MetalStreamMaximumDepositAmount": 35.0, "EnableGoogleReCaptcha": true }
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>1</ACHDepositMinimum> <AIPDepositMinimum>2</AIPDepositMinimum> <AccessibilityStatementUrl>sample string 22</AccessibilityStatementUrl> <AchDepositLimit>8</AchDepositLimit> <AllowHAAPipeDriveCRM>true</AllowHAAPipeDriveCRM> <BrokerName>sample string 4</BrokerName> <BrokerUid>ccf016e4-f9cc-4ab6-accb-0dac7382f219</BrokerUid> <CAPrivacyRightsUrl>sample string 34</CAPrivacyRightsUrl> <CheckDepositLimit>9</CheckDepositLimit> <DisclaimerUrl>sample string 21</DisclaimerUrl> <DocumentAddress> <AddressUid>4c7754ba-8cac-4b95-b654-06037f1995ec</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> <FrequentlyAskedQuestionsUrl>sample string 18</FrequentlyAskedQuestionsUrl> <InvokeIdentityCall>true</InvokeIdentityCall> <IsEquityIRAAllowed>true</IsEquityIRAAllowed> <MetalStreamMaximumDepositAmount>35</MetalStreamMaximumDepositAmount> <MetaltreamMinimumDepositAmount>10</MetaltreamMinimumDepositAmount> <PasswordResetLinkExpirationHours>29</PasswordResetLinkExpirationHours> <PaymentInternalBatchAccountUid>a6ba9e5f-1e26-40c9-b6e8-fe2bae55dd67</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> <PricingRefreshFrequencyMilliseconds>17</PricingRefreshFrequencyMilliseconds> <PrivacyPolicyDocumentUrl>sample string 30</PrivacyPolicyDocumentUrl> <RegistrationAPIResetPasswordUrl>sample string 28</RegistrationAPIResetPasswordUrl> <RegistrationContributionLimitAmount>31</RegistrationContributionLimitAmount> <RegistrationUrl>sample string 23</RegistrationUrl> <RootUrl>sample string 5</RootUrl> <SiteUrl>sample string 6</SiteUrl> <SupportEmail>sample string 12</SupportEmail> <SupportPhone>sample string 13</SupportPhone> <SupportPhoneInternational>sample string 15</SupportPhoneInternational> <SupportPhoneTollFree>sample string 14</SupportPhoneTollFree> <SupportSendQuickMessageUrl>sample string 11</SupportSendQuickMessageUrl> <SupportWorkingHours>sample string 16</SupportWorkingHours> <TermsAndConditionsUrl>sample string 19</TermsAndConditionsUrl> <VerificationInternalBatchAccountUid>d91d9459-e4a1-438b-b878-22d85245d000</VerificationInternalBatchAccountUid> <WebsiteUrl>sample string 20</WebsiteUrl> <WireDepositLimit>32</WireDepositLimit> <WireWithdrawalFee>7</WireWithdrawalFee> </Settings>