Feather Financial Inc

Introduction

Production Keys

Auth

All of the stated endpoints and sections are for demonstration purposes only. Theneo does not manage payments API.  
Get sales data, itemize payments, push orders to POS, and more.

**⚠️ Note:** The Orders API provides a one-stop shop for integrating advanced payment functionality. You can itemize payments with custom line items or catalog objects, send orders to real Point of Sale devices to be fulfilled, and more.

In addition, the Orders API allows you to look through all of a seller's previous sales and returns itemization data, customer references, and other information from POS or online transactions.

&lt;img src="https://media.geeksforgeeks.org/wp-content/cdn-uploads/20200318193845/Top-7-Payment-Gateway-APIs-That-Every-Developer-Must-Know.png">

As an organization, you need to be careful while choosing a payment gateway option. It should be according to the customer’s experience on your websites through to cash flow to online sales. Make sure that you take care of at least 5 things mentioned below while choosing a payment gateway… 

- **Security** should be the topmost priority. Make sure that it should be integrated with the 3D security and comply with the PCI Data Security Standard (PCI DSS).
- **Payout Time** should be less to credit money in your bank account.
- **Integration need to be easy and simple** or it can develop a custom-coded solution for your platform easily.
- **Multiple currencies** should be handled by the payment gateway for the customers using different currencies across the world.

User

Creates a new order that can include information about products for purchase and settings to apply to the purchase.

Create User

Update User

Retrieve user

Accounts

Create Account

Retrieve Accounts

Add Beneficiary

Get Beneficiary

Retrieve Documents

Retrieve Positions

Retrieve Historical Account Value

Retrieve Account Limits

Payments

Add Payment Method

Retrieve Payment Methods

Delete Payment Method

Money Movement

Rollover Money Movement

Create Money Movement

Retrieve Money Movement

Trading

Trade Securities

Retrieve Securities

Alternate Assets

Webhooks

Support

Theneo Demo TechCrunch

RaaS

Production

Development

<h2 class="slate-h2">🚀 Feather (Retirement as a Service)</h2><p class="slate-p" placeholder="Type / for widgets">Feather is the quickest and scalable way to offer retirement accounts to your customers. Integrate with Feather in a few days, and not months or years.</p><p class="slate-p" placeholder="Type / for widgets">The Feather REST API uses standard HTTP verbs to communicate and returns a variety of HTTP codes and JSON messages to indicate statuses and errors.</p><p class="slate-p" placeholder="Type / for widgets">You can use our development environment to test your integration both during development. The hostname that you use in your request determines whether it will be received by our development or production environment.</p><p class="slate-p" placeholder="Type / for widgets">All API requests must be made over HTTPS. Calls made over plain HTTP will fail. Unless otherwise noted, API requests without authentication will also fail.</p><p class="slate-p" placeholder="Type / for widgets">All requests are sent server-to-server. Your app or website should never be directly communicating with the Feather APIs, as your private connection keys may be exposed in transit.</p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Protecting your API credentials</h2><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Do not store API tokens inside your applications source control</strong>: If you store API tokens in property or configuration files, keep these files outside your source control systems. This is especially important if you use a public source code management system such as GitHub. You may want to rely on environment variables or similar runtime injection techniques rather than keeping sensitive keys on disk.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Do not embed API keys directly in code</strong>: Instead of embedding API keys in your application&apos;s code, put them in environment variables or include files that are stored separately from the bulk of your code – outside the source repository of your application.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Limit employee access to production API keys</strong>: While keys to access our sandbox environment will likely be shared by many developers, access to production keys (when provided) should be limited to only necessary personnel.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Error Codes</h2><p class="slate-p" placeholder="Type / for widgets">Feather uses standard HTTP response codes to indicate the success or failure of an API request.</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Codes in the 200 range indicate success.</div></li><li class="slate-li"><div style="position:relative">Codes in the 400 range indicate a failure given the information provided.</div></li><li class="slate-li"><div style="position:relative">Codes in the 500 range indicate an error with the Feather servers (very uncommon).</div></li></ul><p class="slate-p" placeholder="Type / for widgets">In the occurrence of 4xx response code, Feather will provide a JSON error code message that briefly explains the error.</p><p class="slate-p" placeholder="Type / for widgets"></p><h2 class="slate-h2">Disclaimer</h2><p class="slate-p" placeholder="Type / for widgets"><span style="color:rgb(56, 66, 72);font-size:15px" class="slate-color">This documentation is intended to provide developers information to assist them with the integration process. This information is not provided as legal, tax, or regulatory advice. Consult with legal and compliance professionals when considering launching a securities product.</span></p><p class="slate-p" placeholder="Type / for widgets"></p>

Feather is the quickest and scalable way to offer retirement accounts to your customers. Integrate with Feather in a few days, and not months or years.

The Feather REST API uses standard HTTP verbs to communicate and returns a variety of HTTP codes and JSON messages to indicate statuses and errors.

You can use our development environment to test your integration both during development. The hostname that you use in your request determines whether it will be received by our development or production environment.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. Unless otherwise noted, API requests without authentication will also fail.

All requests are sent server-to-server. Your app or website should never be directly communicating with the Feather APIs, as your private connection keys may be exposed in transit.

Feather uses standard HTTP response codes to indicate the success or failure of an API request.

In the occurrence of 4xx response code, Feather will provide a JSON error code message that briefly explains the error.

This documentation is intended to provide developers information to assist them with the integration process. This information is not provided as legal, tax, or regulatory advice. Consult with legal and compliance professionals when considering launching a securities product.

200 - OK

The request was unacceptable, often due to missing a required parameter.

400 - Bad request

401 - Unauthorized

The parameters were valid but the request failed.

402 - Request Failed

The API key doesnt have permissions to perform the request.

403 - Forbidden

404 - Not Found

500 - Internal Server Error

<p class="slate-p" placeholder="Type / for widgets"></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">An API key will be provided to you for both sandbox and production. </div></li><li class="slate-li"><div style="position:relative">The key should be sent in the <span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68);font-size:14px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68);font-size:14px" class="slate-backgroundColor"><code style="background-color:rgb(255, 255, 255);color:rgb(68, 68, 68);font-size:14px" class="slate-code">x-api-key</code></span></span> HTTP header. </div></li><li class="slate-li"><div style="position:relative">The API key doesn&apos;t expire</div></li><li class="slate-li"><div style="position:relative">If an API key is lost/stolen then we will revoke and generate a new one</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">The User resource represents an individual. These can be the account openers or the account beneficiaries (in case it is a custodial account). A user object is required to add payment methods, create retirement accounts, and issue tax documents. </p><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">KYC</h3><p class="slate-p" placeholder="Type / for widgets">KYC can be performed in two ways:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Either we verify the KYC on your platform and approve that, or </div></li><li class="slate-li"><div style="position:relative">We perform the KYC ourselves (subject to extra charge)</div></li></ul><p class="slate-p" placeholder="Type / for widgets">Talk to your Feather representative for more information. KYC is mandatory under law.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

The User resource represents an individual. These can be the account openers or the account beneficiaries (in case it is a custodial account). A user object is required to add payment methods, create retirement accounts, and issue tax documents. 

Talk to your Feather representative for more information. KYC is mandatory under law.

<p class="slate-p" placeholder="Type / for widgets">Creates a new user object. A user object can create multiple financial accounts, add payment methods, and much more.</p><p class="slate-p" placeholder="Type / for widgets">If we approve your KYC approval checks, then we won&apos;t perform a KYC check on our end. If this is the case, then the user object will be immediately ‘APPROVED’ instead of moved to ‘PENDING’ checks.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Creates a new user object. A user object can create multiple financial accounts, add payment methods, and much more.

If we approve your KYC approval checks, then we won't perform a KYC check on our end. If this is the case, then the user object will be immediately ‘APPROVED’ instead of moved to ‘PENDING’ checks.

email

first_name

last_name

middle_name

phone_number

date_of_birth

tax_id

tax_id_type

physical_address

mailing_address

Specify if the user is connected to a politician

politically_exposed

marital

disclosures

x-api-key

Content-Type

user_id

status

<p class="slate-p" placeholder="Type / for widgets">Update the user object. When a specific key is missing, then that particular value isn&apos;t updated. In order to update the specific key, please provide the corresponding key/value pair.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Update the user object. When a specific key is missing, then that particular value isn't updated. In order to update the specific key, please provide the corresponding key/value pair.

<p class="slate-p" placeholder="Type / for widgets">Get the most up to date information about the user.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get the most up to date information about the user.

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">The Account object represents a financial account that is tied to an individual. An individual can open the following accounts:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Traditional IRA</div></li><li class="slate-li"><div style="position:relative">Roth IRA</div></li><li class="slate-li"><div style="position:relative">UGMA</div></li><li class="slate-li"><div style="position:relative">UTMA</div></li><li class="slate-li"><div style="position:relative">Solo-401K</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

The Account object represents a financial account that is tied to an individual. An individual can open the following accounts:

<p class="slate-p" placeholder="Type / for widgets">Represents outflow and inflow of funds to a financial account. </p><p class="slate-p" placeholder="Type / for widgets">Types of Money Movement:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">CONTRIBUTION</div></li><li class="slate-li"><div style="position:relative">WITHDRAWAL</div></li><li class="slate-li"><div style="position:relative">DISTRIBUTION</div></li><li class="slate-li"><div style="position:relative">FEE</div></li><li class="slate-li"><div style="position:relative">ROLLOVER</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

Represents outflow and inflow of funds to a financial account. 

<p class="slate-p" placeholder="Type / for widgets">Feather supports investing in alternate assets like real estate through the IRAs. This requires a deeper integration with you, so that we can best understand the use case, flow of funds and investment information. </p><p class="slate-p" placeholder="Type / for widgets">In general, following is a good workflow depicting one use case.</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Bob wants to invest in real estate through a platform called Acme. </div></li><li class="slate-li"><div style="position:relative">Acme has partnered up with Feather to open Bob&apos;s IRA. </div></li><li class="slate-li"><div style="position:relative">Once Bob decides on an investment with Acme, then Acme sends an event to Feather noting the proposed investment.</div></li><li class="slate-li"><div style="position:relative">Bob will be made aware of the proposal</div></li><li class="slate-li"><div style="position:relative">Once Bob approves of the investment, then Feather will remit the funds to Acme</div></li><li class="slate-li"><div style="position:relative">Bob&apos;s IRA becomes the title holder of the investment</div></li><li class="slate-li"><div style="position:relative">Feather will work with Acme to update the value of the positions depending on the type of the investment</div></li></ul><p class="slate-p" placeholder="Type / for widgets">In the event Bob decides to dispose of his investment,</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Bob will sell his investment through Acme. </div></li><li class="slate-li"><div style="position:relative">Acme upon realizing that the title is held by Bob&apos;s IRA, will inform Feather of the same.</div></li><li class="slate-li"><div style="position:relative">Feather will wait to receive funds from Acme and move the investment to a pending state</div></li><li class="slate-li"><div style="position:relative">Upon receiving the funds, Bob&apos;s IRA will be updated to reflect the correct cash balance</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">If you determine that you want to take advantage of alternate asset investing on your platform, then we will work with you on a 1-1 basis and help implement this workflow and flow of funds.</p>

Feather supports investing in alternate assets like real estate through the IRAs. This requires a deeper integration with you, so that we can best understand the use case, flow of funds and investment information. 

In general, following is a good workflow depicting one use case.

In the event Bob decides to dispose of his investment,

If you determine that you want to take advantage of alternate asset investing on your platform, then we will work with you on a 1-1 basis and help implement this workflow and flow of funds.

<p class="slate-p" placeholder="Type / for widgets">If you are interest in receiving various updates on account creation, trades and movement of funds, then you can subscribe to webhooks. Webhooks are part of the upcoming API functionality and a beta version can be made available on request.</p><p class="slate-p" placeholder="Type / for widgets"></p>

If you are interest in receiving various updates on account creation, trades and movement of funds, then you can subscribe to webhooks. Webhooks are part of the upcoming API functionality and a beta version can be made available on request.

<p class="slate-p" placeholder="Type / for widgets">Looking to add new API support and features, report bugs, and get general questions asked, then please reach out to support@featherhq.com</p>

Looking to add new API support and features, report bugs, and get general questions asked, then please reach out to support@featherhq.com

Sections