Get Funding Options
Retrieve the funding options available to a user.
Available to: Traders (own records); organization administrators (any user in their organization)
Environments: Live
Rate Limit: No endpoint-specific limit
On Live, some organizations restrict administrators from accessing other members’ accounts unless they hold an approved trading permission for that account.
Return which funding methods a user is eligible for. Pass the user’s userId. The response sets each option to true or false:
remessaOnline: the user has an account with Brazil (BR) citizenship.SEPA: the user has an account with citizenship in a country in theEUregion.paymentInitiation: the user’s approved contact information lists Great Britain (GB) as the country.
remessaOnline and SEPA are based only on the user’s accounts that the caller can access. In an organization that restricts administrators from accessing other members’ accounts, both can come back false for an eligible member. The optional usePaymentInitiation field doesn’t change the response.
Common Failure Scenarios
- No user matches
userId, or the caller can’t access that user. The call still returnsHTTP 200, with all three options set tofalseand no error, so afalsedoesn’t by itself mean the user is ineligible. userIdisn’t greater than 0. This returnsHTTP 400.- The caller’s user type, or the API key’s permissions, don’t include read access to the
Usersresource. This returnsHTTP 401with"Access is denied". - The request is sent to Demo. This endpoint runs on Live only, so Demo returns
HTTP 501.
Error Messages
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
userId
usePaymentInitiation
Response
FundingOptionsResponse
remessaOnline
SEPA
paymentInitiation