{"_id":"5571a5b2dbb3632100974aee","category":{"_id":"5571a533dbb3632100974aed","pages":["5571a5b2dbb3632100974aee","5571abeb31433c190094096e","5571ae4cdbb3632100974b05","5581efc5a5474a0d00d94709"],"version":"556dd000d0f4740d00380e00","__v":4,"project":"556dd000d0f4740d00380dfd","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-05T13:33:39.781Z","from_sync":false,"order":2,"slug":"ach-profiles","title":"ACH Profiles"},"project":"556dd000d0f4740d00380dfd","version":{"_id":"556dd000d0f4740d00380e00","project":"556dd000d0f4740d00380dfd","__v":14,"createdAt":"2015-06-02T15:47:12.583Z","releaseDate":"2015-06-02T15:47:12.583Z","categories":["556dd001d0f4740d00380e01","556e17023f11b01900a36978","556eff53fc3aa80d00e1aa67","557078cf910c090d00c43414","557078dc9ea7860d008b24ed","5571a533dbb3632100974aed","5571c4ed6d8908230061f39e","5575b9b10b81dc230069c981","5580706cbe698419008f2ca7","55a4117d53611017004387d4","58502492f744712700462b20","588279ccd63d450f00e1aa58","59e76819193831002803721e","5a6899886b88e400403c3ce5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":11,"editedParams2":true,"parentDoc":null,"user":"550e28af11e8d00d00b803f2","editedParams":true,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-05T13:35:46.177Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"POST /public/accounts/6YA01234/achprofiles HTTP/1.1\nContent-Type: application/json; charset=utf-8\nHost: api.tradier.com\nAuthorization: Basic XXX\nConnection: close\n\n\n{\"bankRoutingNumber\":\"253177049\",\"bankAccount\":\"123123123123\",\"bankAccountType\":\"checking\",\"bankAccountOwnerName\":\"Jane Doe\",\"nickname\":\"Bank of America Checking\",\"ipAddress\":\"127.123.456.789\",\"method\":\"MICRO_DEPOSIT\"}\n"}]},"method":"post","results":{"codes":[{"language":"json","code":"{\n    \"id\": 4,\n    \"status\": \"PENDING\",\n  \t\"approvalMethod\": \"MICRO_DEPOSIT\",\n    \"bankRoutingNumber\": \"253177049\",\n    \"bankAccount\": \"********3123\",\n    \"bankAccountType\": \"checking\",\n    \"bankAccountOwnerName\": \"Jane Doe\",\n    \"nickname\": \"Bank of America Checking\",\n    \"ipAddress\": \"127.123.456.789\",\n    \"createdAt\": \"2015-03-20 20:14:34\",\n  \t\"updatedAt\": \"2015-05-21 15:17:37\",\n    \"achRelationshipId\": \"588a58c4e4b00a129b1d5dd6\"\n}","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"5571a98adbb3632100974af6","ref":"","in":"path","required":true,"desc":"Account the ACH relationship belongs to.","default":"","type":"string","name":"account"},{"_id":"5571aa4a47936d23006d3645","ref":"","in":"body","required":true,"desc":"Name on the bank account","default":"","type":"string","name":"bankAccountOwnerName"},{"_id":"5571aa4a47936d23006d3644","ref":"","in":"body","required":true,"desc":"One of: `checking` or `savings`","default":"","type":"string","name":"bankAccountType"},{"_id":"5571aa4a47936d23006d3643","ref":"","in":"body","required":true,"desc":"Bank account number.","default":"","type":"string","name":"bankAccount"},{"_id":"5571a908dbb3632100974af4","ref":"","in":"body","required":true,"desc":"Routing number.","default":"","type":"string","name":"bankRoutingNumber"},{"_id":"5891ff77f934360f0079cec1","ref":"","in":"body","required":true,"desc":"One of: `MICRO_DEPOSIT`, `PLAID`","default":"","type":"string","name":"method"},{"_id":"5571aa4a47936d23006d3642","ref":"","in":"body","required":true,"desc":"IP address of the account holder who submitted this request","default":"","type":"string","name":"ipAddress"},{"_id":"5571aa4a47936d23006d3641","ref":"","in":"body","required":false,"desc":"Nickname for this ACH relationship","default":"","type":"string","name":"nickname"},{"_id":"5890b705e379e51b001d8b26","ref":"","in":"header","required":true,"desc":"Authorization is required for this API.  Please use a valid credentials.","default":"Basic XXX","type":"string","name":"Authorization"},{"_id":"5a1f0c5de4433a001211795a","ref":"","in":"body","required":false,"desc":"Required for method `PLAID`","default":"","type":"string","name":"meta"}],"url":"/accounts/:account/achprofiles"},"isReference":true,"order":1,"body":"Submit an ACH profile for creation. ACH profiles are verified using micro deposits to the account.  Once submitted a call to the ACH profile verification endpoint is necessary for the customer to verify the micro deposit amounts.","excerpt":"Create a new ACH relationship within the Tradier Advisor API","slug":"create-an-ach-profile","type":"endpoint","title":"Create an ACH Profile"}

postCreate an ACH Profile

Create a new ACH relationship within the Tradier Advisor API

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account:
required
string
Account the ACH relationship belongs to.

Body Params

bankAccountOwnerName:
required
string
Name on the bank account
bankAccountType:
required
string
One of: `checking` or `savings`
bankAccount:
required
string
Bank account number.
bankRoutingNumber:
required
string
Routing number.
method:
required
string
One of: `MICRO_DEPOSIT`, `PLAID`
ipAddress:
required
string
IP address of the account holder who submitted this request
nickname:
string
Nickname for this ACH relationship
meta:
string
Required for method `PLAID`

Headers

Authorization:
required
stringBasic XXX
Authorization is required for this API. Please use a valid credentials.

Examples


Result Format


Documentation

Submit an ACH profile for creation. ACH profiles are verified using micro deposits to the account. Once submitted a call to the ACH profile verification endpoint is necessary for the customer to verify the micro deposit amounts.