{"__v":14,"_id":"54c935c70174630d00efa94f","api":{"auth":"required","params":[],"results":{"codes":[]},"url":""},"body":"In order to use the SEED API, you need to become a member and open an account. To apply for membership, visit our homepage at https://seed.co.\n\nOnce you are a member, you'll be able to create client application keys to allow you to access the API and to be able to authorize applications to access your accounts.","category":"54c935c60174630d00efa94d","createdAt":"2015-01-28T19:17:27.612Z","excerpt":"Become a member of the SEED network to open an account and begin using our business banking API.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"54c935c60174630d00efa949","slug":"getting-started","sync_unique":"","title":"API Banking With SEED","type":"basic","updates":[],"user":"54c933e34574700d00f016f4","version":"54c935c60174630d00efa94c"}API Banking With SEED
Become a member of the SEED network to open an account and begin using our business banking API.
{"__v":15,"_id":"54c95f194574700d00f01759","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":""},"body":"This is our general API for our banking services. It contains endpoints for creating and maintaining customer accounts, creating and maintaining individual user credentials, getting transaction history, performing transfers, and configuring notification settings.\n\nWe use the OAuth2 framework to implement access control and authorization.\n\nOur API terminology represents two important concepts to understand: members and individuals. A *member* is a business account in the system, while an *individual* is a human's account, that may have different levels of access to various member accounts. For instance, the company account for ABC Inc would be a member, while the CFO would be an individual with full administrator privileges for the account, while their accountant may only have limited, view-only access to the member account.","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-28T22:13:45.760Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"54c935c60174630d00efa949","slug":"overview","sync_unique":"","title":"General overview","type":"basic","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}General overview
{"__v":4,"_id":"54c96aa77a11f60d0022a97f","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":""},"body":"The OAuth2 framework is used for authentication. The basic flow is:\n\n* Username and password is forwarded to the `token` endpoint with a username and password.\n* User gets a long-lived refresh token and a short-lived access token.\n* (later) User uses refresh token to get a new short-lived access token using the `token` endpoint.\n\nThe token will be a base64 string, like `ohrqPAqtQs-xVSltMhypTg`,\nwhich will be used in the `Authorization` header, like:\n\n```\nAuthorization: Bearer ohrqPAqtQs-xVSltMhypTg\n```\n\nIn the near future, we will also support a redirect workflow more suitable web-based applications with redirect URIs.","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-28T23:03:03.348Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"project":"54c935c60174630d00efa949","slug":"authentication","sync_unique":"","title":"Authentication","type":"basic","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}Authentication
{"__v":4,"_id":"54c9693869c3390d000339c5","api":{"auth":"optional","params":[{"_id":"54c9693869c3390d000339c8","required":true,"desc":"User name.","default":"","type":"string","name":"username"},{"_id":"54c9693869c3390d000339c7","required":true,"desc":"Password.","default":"","type":"string","name":"password"},{"_id":"54c9693869c3390d000339c6","required":false,"desc":"One-time password (generated from Google Authenticator, for example). (Coming Soon.)","default":"","type":"string","name":"otp"},{"_id":"54ca8c9bdd5cf30d00c35218","required":true,"desc":"Random string that will be reflected back to you. This is useful for protecting against certain kinds of attacks, or to help you keep track of session state.","default":"","type":"string","name":"state"},{"_id":"54ca8da2dd5cf30d00c35223","required":false,"desc":"Request scopes. Can end in `:id`, like `view:someuuid` for access to a specific customer account (otherwise defaults to all of your customer accounts). `view` and `edit` are currently supported. Multiple scopes can be separated with commas.","default":"view","type":"string","name":"scope"},{"_id":"54ced25b40b0920d006d6d41","required":true,"desc":"Client ID of your application","default":"","type":"string","name":"client_id"},{"_id":"54ced25b40b0920d006d6d40","required":true,"desc":"Client secret for your application","default":"","type":"string","name":"client_secret"},{"_id":"54ced307c8d0440d00eb07b7","required":true,"desc":"Must be 'password'","default":"password","type":"string","name":"grant_type"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"ok\": true,\n \"access_token\": \"LgoKGWhHTv6BdrmvFqdoyw\",\n \"refresh_token\": \"WOKyWKarRde5SgMylH_CNw\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n\t\"scope\": \"view\",\n \"custom_parameter\": \"19923\",\n \"state\": \"123819283918\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/auth/token"},"body":"You may also use Basic auth to send the username and password.","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-28T22:56:56.397Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"54c935c60174630d00efa949","slug":"authentication-login","sync_unique":"","title":"Authentication: Login","type":"post","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}postAuthentication: Login
username:
required
String
User name.
password:
required
String
Password.
otp:
String
One-time password (generated from Google Authenticator, for example). (Coming Soon.)
state:
required
String
Random string that will be reflected back to you. This is useful for protecting against certain kinds of attacks, or to help you keep track of session state.
scope:
Stringview
Request scopes. Can end in `:id`, like `view:someuuid` for access to a specific customer account (otherwise defaults to all of your customer accounts). `view` and `edit` are currently supported. Multiple scopes can be separated with commas.
client_id:
required
String
Client ID of your application
client_secret:
required
String
Client secret for your application
grant_type:
required
Stringpassword
Must be 'password'
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":2,"_id":"54ca8abedd5cf30d00c3520c","api":{"auth":"never","params":[{"_id":"54ca8abedd5cf30d00c3520d","required":true,"desc":"Must be 'refresh_token'","default":"refresh_token","type":"string","name":"grant_type"},{"_id":"54ca912feb42170d0045d4bf","required":false,"desc":"Any state you would like to pass along with the request","default":"","type":"string","name":"state"},{"_id":"54ced2d340b0920d006d6d45","required":true,"desc":"The refresh token you wish to use for an access token","default":"","type":"string","name":"refresh_token"},{"_id":"54ced2d340b0920d006d6d44","required":true,"desc":"Client ID for your application","default":"","type":"string","name":"client_id"},{"_id":"54ced2d340b0920d006d6d43","required":true,"desc":"Client secret for your application","default":"","type":"string","name":"client_secret"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"custom_parameter\": \"19923\",\n \"expires_in\": 3600,\n \"refresh_token\": \"ohrqPAqtQs-xVSltMhypTg\",\n \"scope\": \"view\",\n \"token_type\": \"bearer\",\n \"access_token\": \"7HE5Ejs8QPSfKIuxcUM1QA\",\n \"state\": \"12039102\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/auth/token"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T19:32:14.673Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"54c935c60174630d00efa949","slug":"authentication-refresh","sync_unique":"","title":"Authentication: Refresh","type":"post","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}postAuthentication: Refresh
grant_type:
required
Stringrefresh_token
Must be 'refresh_token'
state:
String
Any state you would like to pass along with the request
refresh_token:
required
String
The refresh token you wish to use for an access token
client_id:
required
String
Client ID for your application
client_secret:
required
String
Client secret for your application
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":2,"_id":"54c96b7e7a11f60d0022a988","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":""},"body":"Individual credentials are, essentially, an account associated with an individual human that has a login, password, and some accesses to various member (business) accounts.\n\nIndividual accounts also contain preferences for how and when you, as an individual, like to communicated with, via email, text, or phone, and under what circumstances. By default, only important email correspondence will be sent. (Critical business communications cannot be disabled.)","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-28T23:06:38.818Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"54c935c60174630d00efa949","slug":"individuals","sync_unique":"","title":"Individuals","type":"basic","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}Individuals
{"__v":2,"_id":"54c96b1c7a11f60d0022a985","api":{"auth":"required","params":[{"_id":"54ca871ff4c2b70d00859888","required":true,"desc":"UUID of the individual account","default":"","type":"string","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": \"79a277b3-c519-43f7-ae04-b1d4bdceae6b\",\n\t\"permissions\": [\n\t\t{\n\t\t\t\"account\": \"c8a188ee-f762-452e-82f4-f128530c372e\",\n\t\t\t\"permissions\": [\"read\"]\n\t\t}\n\t],\n\t\"email\": \"a@b.com\",\n\t\"phone\": \"800-555-1234\",\n\t\"notification_preferences\": {...},\n\t...\n}","name":""},{"status":403,"language":"text","code":"You do not have permission to view the given account, or the account was not found.","name":""}]},"url":"/individuals/:id"},"body":"Notification preferences are an object with the following information:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Key\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"email\",\n \"0-1\": \"object\",\n \"0-2\": \"Email preferences\",\n \"1-0\": \"phone\",\n \"1-1\": \"object\",\n \"1-2\": \"Phone preferences (coming soon)\",\n \"2-0\": \"text\",\n \"2-1\": \"object\",\n \"2-2\": \"Text preferences (coming soon)\",\n \"3-0\": \"push\",\n \"3-1\": \"object\",\n \"3-2\": \"Push notification preferences (coming soon)\",\n \"4-0\": \"hooks\",\n \"4-1\": \"object\",\n \"4-2\": \"Webhook notification preferences (coming soon)\"\n },\n \"cols\": 3,\n \"rows\": 5\n}\n[/block]\nFor now, only `email` preferences are supported, and it only has a single field, `enabled`, which is set to either `true` or `false`, like:\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"notification_preferences\\\": {\\n \\\"email\\\": { \\\"enabled\\\": true }\\n }\\n}\",\n \"language\": \"json\"\n }\n ]\n}\n[/block]","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-28T23:05:00.243Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"54c935c60174630d00efa949","slug":"individuals-get","sync_unique":"","title":"Individuals: Get","type":"get","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}getIndividuals: Get
id:
required
String
UUID of the individual account
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":1,"_id":"54ca85e9eb42170d0045d493","api":{"auth":"required","params":[{"_id":"54ca8707eb42170d0045d49b","required":true,"desc":"UUID of the user to update.","default":"","type":"string","name":"id"},{"_id":"54ca8707eb42170d0045d49a","required":true,"desc":"Email address for correspondence.","default":"","type":"string","name":"email"},{"_id":"54ca8707eb42170d0045d499","required":true,"desc":"Phone number to contact you.","default":"","type":"string","name":"phone"},{"_id":"54ca8707eb42170d0045d498","required":false,"desc":"Preferences for notifications (email, push, call, text, etc.)","default":"Important email correspondence only.","type":"object","name":"notification_preferences"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": \"79a277b3-c519-43f7-ae04-b1d4bdceae6b\",\n\t\"permissions\": [\n\t\t{\n\t\t\t\"account\": \"c8a188ee-f762-452e-82f4-f128530c372e\",\n\t\t\t\"permissions\": [\"read\"]\n\t\t}\n\t],\n\t\"email\": \"a@b.com\",\n\t\"phone\": \"800-555-1234\",\n\t\"notification_preferences\": {...},\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/individuals/:id"},"body":"This is used to update your own information, like preferences, contact information, etc.\n\nMissing fields will be interpreted as deletions, except for sub-resources (like `customers`).\n\nSome fields are read-only, and cannot be updated by this method, including:\n\n1. `permissions` -- these settings are managed in the `customer` endpoints.\n2. `id` -- this is immutable and can never change for your individual account.\n\nIn general, you can only update your own individual information, though in the future, you may be able to delegate editing permissions to others as well.[\n\nFor details on the `notification_preferences` field, see [Individuals: Get](doc:individuals-get).","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T19:11:37.376Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"54c935c60174630d00efa949","slug":"individuals-update","sync_unique":"","title":"Individuals: Update","type":"put","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}putIndividuals: Update
id:
required
String
UUID of the user to update.
email:
required
String
Email address for correspondence.
phone:
required
String
Phone number to contact you.
notification_preferences:
ObjectImportant email correspondence only.
Preferences for notifications (email, push, call, text, etc.)
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":4,"_id":"54c96bc769c3390d000339d0","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":""},"body":"A \"member\" is the actual business account: it holds information\nabout the business, transactions that have occurred.\nIn a sense, it is what holds the money and handles the money.\n\n(Not to be confused with individuals, which are associated\nwith a particular human with a set of credentials to login to the site. Individuals may have access to multiple member accounts with varying levels of access.)","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-28T23:07:51.690Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"54c935c60174630d00efa949","slug":"members","sync_unique":"","title":"Members","type":"basic","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}Members
{"__v":2,"_id":"54c96c0869c3390d000339d2","api":{"auth":"required","params":[{"_id":"54ca878ff4c2b70d00859889","required":true,"desc":"UUID of the customer (business) account to view.","default":"","type":"string","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": \"c8a188ee-f762-452e-82f4-f128530c372e\",\n\t\"owners\": [\"b4266683-a88b-456a-8a7c-c99496c73c04\"],\n \"transfer_id\": \"YHBRJB\",\n\t\"status\": \"pending\",\n\t\"accounts\": [\n\t\t{\n\t\t\t\"id\": \"d423b26a-8263-470f-835e-d74ed9aa4cb8\",\n\t\t\t\"kind\": \"checking\",\n\t\t\t\"name\": \"Primary Business Checking\"\n\t\t}\n\t],\n\t\"contact_info\": {...},\n \"available_balance\": \"12.34\",\n \"ledger_balance\": \"12.34\",\n \"created\": \"1422562257540\",\n \"updated\": \"1422562257540\",\n \"transactions\": [\n {\n \"id\": \"4d9779ba-1a99-4ba3-8e25-10ae5286882d\",\n \"account_id\": \"d423b26a-8263-470f-835e-d74ed9aa4cb8\",\n \"pending\": true,\n \"description\": \"Some transaction\",\n \"created\": 1422564788964,\n \"transaction_type\": \"wire_transfer\",\n \"amount\": \"-12.34\",\n \"wire_transfer\": {}\n }\n ]\n}","name":""},{"status":403,"language":"text","code":"Customer was not found, or you do not have permission to view it.","name":""}]},"url":"/members/:id"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-28T23:08:56.412Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"54c935c60174630d00efa949","slug":"members-get","sync_unique":"","title":"Members: Get","type":"get","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}getMembers: Get
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":1,"_id":"54ca931bdd5cf30d00c35239","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":""},"body":"Seed transfers, or intra-seed transfers, are transfers from one seed customer to another. By simply knowing the other customer's transfer ID -- a short identifier that every customer has, like `YHBRJB` -- you can instantly and safely transfer money from your account to theirs.\n\nSince Seed transfers occur instantly and atomically, they cannot be canceled.\n\nCurrently, we only support sending money *from* your account to another account.","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T20:07:55.621Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"project":"54c935c60174630d00efa949","slug":"seed-transfers","sync_unique":"","title":"Seed Transfers","type":"basic","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}Seed Transfers
{"__v":0,"_id":"54ca93ffdd5cf30d00c3523c","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"status\": \"success\",\n \"id\": \"7ad06383-9672-4577-a797-3a21c31ec3d7\",\n \"amount\": \"12.34\",\n \"to_transfer_id\": \"YHBRJB\",\n \"created\": 1422562257540\n}","name":""},{"status":400,"language":"json","code":"{\n\t\"error\": \"Transfer id / amount / description invalid.\"\n}","name":""}]},"auth":"required","params":[{"_id":"54ca93ffdd5cf30d00c3523f","required":true,"desc":"The transfer ID (short id) to transfer to","default":"","type":"string","name":"to_transfer_id"},{"_id":"54ca93ffdd5cf30d00c3523e","required":true,"desc":"Decimal amount of US dollars, as a string, i.e., \"12.34\"","default":"","type":"string","name":"amount"},{"_id":"54ca93ffdd5cf30d00c3523d","required":false,"desc":"Description to give the transfer, so that the other person knows how to identify it. By default it will include wither your short transfer ID, or some other string you specify.","default":"Seed transfer from customer XYZ","type":"string","name":"description"}],"url":"/transfers/seed"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T20:11:43.063Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":10,"project":"54c935c60174630d00efa949","slug":"seed-transfers-create","sync_unique":"","title":"Seed Transfers: Create","type":"post","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}postSeed Transfers: Create
to_transfer_id:
required
String
The transfer ID (short id) to transfer to
amount:
required
String
Decimal amount of US dollars, as a string, i.e., "12.34"
description:
StringSeed transfer from customer XYZ
Description to give the transfer, so that the other person knows how to identify it. By default it will include wither your short transfer ID, or some other string you specify.
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":0,"_id":"54d3d14a87ea950d00f1bd75","api":{"auth":"required","params":[{"_id":"54d3d14a87ea950d00f1bd76","required":true,"desc":"ACH routing number of the financial institution you want information about","default":"","type":"string","name":"num"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"routing_number\": \"121140399\",\n \"office_code\": \"O\",\n \"servicing_frb_number\": \"121000374\",\n \"record_type_code\": \"1\",\n \"change_date\": \"110612\",\n \"new_routing_number\": \"000000000\",\n \"customer_name\": \"SILICON VALLEY BANK\",\n \"address\": \"3003 TASMAN DRIVE\",\n \"city\": \"SANTA CLARA\",\n \"state_code\": \"CA\",\n \"zipcode\": \"95054\",\n \"zipcode_extension\": \"0000\",\n \"telephone\": \"4086546363\",\n \"institution_status_code\": \"1\",\n \"data_view_code\": \"1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/ach/routing/:num"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-02-05T20:23:38.116Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":11,"project":"54c935c60174630d00efa949","slug":"ach-routing-number-information","sync_unique":"","title":"ACH Routing Number Information","type":"get","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}getACH Routing Number Information
num:
required
String
ACH routing number of the financial institution you want information about
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":2,"_id":"54c9c5d54574700d00f01839","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":""},"body":"ACH (Automated Clearing House), sometimes called EFT (Electronic Funds Transfer)\nor simply \"direct deposit\", is a way to transfer funds between bank accounts\nat different financial institutions, usually limited to the US. Generally transfers occur within 1 business day, though due to the way reversals happen, many financial institutions have an additional 1 or 2 business day hold to ensure that the transfer was successful.\n\nIf you want more information on how the ACH network works, there's a [great article at ZenPayroll](http://engineering.zenpayroll.com/how-ach-works-a-developer-perspective-part-1/) detailing all of the high-level and low-level details of it.","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T05:32:05.185Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":12,"project":"54c935c60174630d00efa949","slug":"ach-transfers","sync_unique":"","title":"ACH Transfers","type":"basic","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}ACH Transfers
{"__v":3,"_id":"54c9c6197a11f60d0022aa43","api":{"auth":"required","params":[{"_id":"54c9c65469c3390d00033a79","required":true,"desc":"ABA routing number for source.","default":"","type":"string","name":"from_routing"},{"_id":"54c9c67f7a11f60d0022aa45","required":true,"desc":"Account number for source.","default":"","type":"string","name":"from_account"},{"_id":"54ca884bf4c2b70d00859890","required":false,"desc":"Either `checking` or `savings`.","default":"checking","type":"string","name":"from_account_kind"},{"_id":"54ca884bf4c2b70d0085988f","required":true,"desc":"ABA routing number for the destination.","default":"","type":"string","name":"to_routing"},{"_id":"54ca884bf4c2b70d0085988e","required":true,"desc":"Account number for the source.","default":"","type":"string","name":"to_account"},{"_id":"54ca884bf4c2b70d0085988d","required":false,"desc":"Either `checking` or `savings`","default":"checking","type":"string","name":"to_account_kind"},{"_id":"54ca884bf4c2b70d0085988c","required":true,"desc":"Must be a positive decimal number in string format, e.g., `\"12.34\"`","default":"","type":"string","name":"amount"},{"_id":"54ca884bf4c2b70d0085988b","required":false,"desc":"Description of the transfer. May appear on the statements of the source and destination accounts.","default":"Seed transfer","type":"string","name":"description"}],"results":{"codes":[{"name":"","code":"{\n \"id\": \"45d4d3b8-7b83-41c7-98c0-a8002f70b3d9\",\n ...\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"Missing field, etc.\"\n}","language":"json","status":400}]},"url":"/transfers/ach"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T05:33:13.773Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":13,"project":"54c935c60174630d00efa949","slug":"ach-transfers-create","sync_unique":"","title":"ACH Transfers: Create","type":"post","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}postACH Transfers: Create
from_routing:
required
String
ABA routing number for source.
from_account:
required
String
Account number for source.
from_account_kind:
Stringchecking
Either `checking` or `savings`.
to_routing:
required
String
ABA routing number for the destination.
to_account:
required
String
Account number for the source.
to_account_kind:
Stringchecking
Either `checking` or `savings`
amount:
required
String
Must be a positive decimal number in string format, e.g., `"12.34"`
description:
StringSeed transfer
Description of the transfer. May appear on the statements of the source and destination accounts.
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":0,"_id":"54c9c6b74574700d00f0183d","api":{"auth":"required","params":[{"_id":"54c9c6b74574700d00f0183e","default":"","desc":"UUID of transfer to get information on.","name":"id","required":true,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": \"45d4d3b8-7b83-41c7-98c0-a8002f70b3d9\",\n ...\n}","name":""},{"status":403,"language":"text","code":"The transfer was not found, or you do not have permission to view it.","name":""},{"status":404,"language":"text","code":""}]},"url":"/transfers/ach/:id"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T05:35:51.372Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":14,"project":"54c935c60174630d00efa949","slug":"ach-transfers-get","sync_unique":"","title":"ACH Transfers: Get","type":"get","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}getACH Transfers: Get
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":0,"_id":"54c9c71369c3390d00033a7b","api":{"auth":"required","params":[{"_id":"54c9c71369c3390d00033a7c","default":"","desc":"UUID of the transfer to delete.","name":"id","required":true,"type":"string"}],"results":{"codes":[{"status":204,"language":"json","code":"{}","name":""},{"status":403,"language":"text","code":"Transfer was not found, or you do not have permission to delete it.","name":""},{"status":400,"language":"text","code":"Transfer could not be cancelled (too late)."},{"status":404,"language":"text","code":""}]},"url":"/transfers/ach/:id"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T05:37:23.793Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":15,"project":"54c935c60174630d00efa949","slug":"ach-transfers-cancel","sync_unique":"","title":"ACH Transfers: Cancel","type":"delete","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}deleteACH Transfers: Cancel
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":0,"_id":"54ca83a9f4c2b70d00859870","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"body":"US (domestic) wire transfers are a fast way to transfer funds between US institutions, similar to [ACH Transfers](doc:ach-transfers) in concept, but offer two advantages:\n\n1. **Speed**. Wire transfers can operate in near-real-time, so many transfers can happen the same day they are initiated.\n2. **Funds guarantee**. When the wire transfers happens, the funds are guaranteed by the banks, so there isn't normally any waiting or holding period after the funds hit your account.\n\nIn general, wire transfers are more expensive, as the network fees are higher. In addition, financial institutions at either end, as well as any intermediate ones, may charge additional fees.","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T19:02:01.085Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":16,"project":"54c935c60174630d00efa949","slug":"us-wire-transfers","sync_unique":"","title":"US Wire Transfers","type":"basic","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}US Wire Transfers
{"__v":1,"_id":"54ca84a6f4c2b70d00859874","api":{"auth":"required","params":[{"_id":"54ca84a6f4c2b70d0085987a","required":true,"desc":"","default":"","type":"string","name":"from_routing"},{"_id":"54ca84a6f4c2b70d00859879","required":true,"desc":"","default":"","type":"string","name":"from_account"},{"_id":"54ca84a6f4c2b70d00859878","required":false,"desc":"Sometimes required to correctly route the wire transfer.","default":"","type":"string","name":"memo"},{"_id":"54ca84a6f4c2b70d00859877","required":true,"desc":"","default":"","type":"string","name":"to_routing"},{"_id":"54ca84a6f4c2b70d00859876","required":true,"desc":"","default":"","type":"string","name":"to_account"},{"_id":"54ca84a6f4c2b70d00859875","required":true,"desc":"Decimal format of US dollars, like \"12.34\".","default":"","type":"string","name":"amount"},{"_id":"54d2b643dbd2730d00407445","default":"31 minutes from now","desc":"Run this wire transfer in the future at the specified time. The time should be specified as a timestamp in milliseconds since the UNIX epoch.","name":"schedule_for","required":false,"type":"int"},{"_id":"54d2b643dbd2730d00407444","required":true,"desc":"Address of the recipient","default":"","type":"string","name":"to_address"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": \"729261b2-7ef3-452a-b8a4-65af55730373\",\n \"status\": \"pending\",\n \"amount\": \"12.34\",\n ...\n}","name":""},{"status":400,"language":"json","code":"{\n \"error\": \"The amount field as invalid (e.g.)\"\n}","name":""},{"status":403,"language":"text","code":"Your account has not been fully activated or has wire transfers disabled."}]},"url":"/transfers/wire"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T19:06:14.841Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":17,"project":"54c935c60174630d00efa949","slug":"us-wire-transfers-create","sync_unique":"","title":"US Wire Transfers: Create","type":"post","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}postUS Wire Transfers: Create
from_routing:
required
String
from_account:
required
String
memo:
String
Sometimes required to correctly route the wire transfer.
to_routing:
required
String
to_account:
required
String
amount:
required
String
Decimal format of US dollars, like "12.34".
schedule_for:
Integer31 minutes from now
Run this wire transfer in the future at the specified time. The time should be specified as a timestamp in milliseconds since the UNIX epoch.
to_address:
required
String
Address of the recipient
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":0,"_id":"54ca84e5f4c2b70d0085987b","api":{"auth":"required","params":[{"_id":"54ca84e5f4c2b70d0085987c","default":"","desc":"UUID of the wire transfer to get information about.","name":"id","required":true,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": \"729261b2-7ef3-452a-b8a4-65af55730373\",\n \"status\": \"pending\",\n \"amount\": \"12.34\",\n ...\n}","name":""},{"status":403,"language":"json","code":"US wire transfer not found, or you do not have permission to view it.","name":""},{"status":404,"language":"text","code":""}]},"url":"/transfers/wire/:id"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T19:07:17.862Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":18,"project":"54c935c60174630d00efa949","slug":"us-wire-transfers-get","sync_unique":"","title":"US Wire Transfers: Get","type":"get","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}getUS Wire Transfers: Get
id:
required
String
UUID of the wire transfer to get information about.
Definition
{{ temp_api_url }}{{ page_api_url }}
Result Format
{"__v":0,"_id":"54ca855edd5cf30d00c351ec","api":{"auth":"required","params":[{"_id":"54ca855edd5cf30d00c351ed","default":"","desc":"UUID of the US wire transfer to cancel.","name":"id","required":true,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": \"729261b2-7ef3-452a-b8a4-65af55730373\",\n \"status\": \"cancelled\",\n \"amount\": \"12.34\",\n ...\n}","name":""},{"status":400,"language":"text","code":"Can no longer cancel this request (too late).","name":""},{"status":403,"language":"text","code":"US wire transfer could not be found, or you do not have permission to delete it."},{"status":404,"language":"text","code":""}]},"url":"/transfers/wire/:id"},"body":"","category":"54c95efb69c3390d000339a9","createdAt":"2015-01-29T19:09:18.207Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":19,"project":"54c935c60174630d00efa949","slug":"us-wire-transfers-cancel","sync_unique":"","title":"US Wire Transfers: Cancel","type":"delete","updates":[],"user":"54c9551169c3390d0003398c","version":"54c935c60174630d00efa94c"}deleteUS Wire Transfers: Cancel
Definition
{{ temp_api_url }}{{ page_api_url }}