{"_id":"5571d32c6d8908230061f3ca","editedParams2":true,"githubsync":"","project":"556dd000d0f4740d00380dfd","user":"550e28af11e8d00d00b803f2","editedParams":true,"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":1,"parentDoc":null,"category":{"_id":"5571c4ed6d8908230061f39e","__v":4,"pages":["5571cc1c6d8908230061f3ae","5571d32c6d8908230061f3ca","5571d7368956493700aae1c5","5582eaa081672a3900bb4fcc"],"project":"556dd000d0f4740d00380dfd","version":"556dd000d0f4740d00380e00","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-05T15:49:01.606Z","from_sync":false,"order":5,"slug":"transactions","title":"Transactions"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-05T16:49:48.719Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"id\": 2,\n    \"account\": \"6YA01234\",\n    \"action\": \"WITHDRAWAL\",\n    \"type\": \"ACH\",\n    \"achProfile\": 2,\n    \"amount\": 123.12,\n    \"status\": \"PENDING\",\n    \"createdAt\": 1428937583,\n    \"updatedAt\": 1433513183,\n    \"apexStatus\": \"OPEN\"\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"language":"http","code":"POST /v2/funding/transactions HTTP/1.1\nAuthorization: Basic XXX\nContent-Type: application/json; charset=utf-8\nAccept: application/json\nConnection: close\nContent-Length: 77\n\n{\"action\":\"withdrawal\",\"amount\":\"123.12\",\"account\":\"6YA01234\",\"type\":\"ACH\", \"ipAddress\": \"192.168.4.2\" }\n"}]},"method":"post","auth":"required","params":[{"_id":"5571d25b1cd8283500a8b48a","ref":"","in":"body","required":true,"desc":"Account for the transaction","default":"","type":"string","name":"account"},{"_id":"5571d25b1cd8283500a8b489","ref":"","in":"body","required":true,"desc":"Set to `WITHDRAWAL`.","default":"WITHDRAWAL","type":"string","name":"action"},{"_id":"5571d25b1cd8283500a8b488","ref":"","in":"body","required":true,"desc":"Type of the transaction.  At this time only `ACH` is permitted.","default":"","type":"string","name":"type"},{"_id":"5571d25b1cd8283500a8b487","ref":"","in":"body","required":true,"desc":"Amount of the deposit","default":"","type":"double","name":"amount"},{"_id":"5571d25b1cd8283500a8b486","ref":"","in":"body","required":false,"desc":"ACH Profile Id, required for ACH transactions","default":"","type":"string","name":"achProfile"},{"_id":"5894e2e30d6b0c0f00add3c6","ref":"","in":"body","required":true,"desc":"IP address of the CUSTOMER who requested the transaction","default":"","type":"string","name":"ipAddress"},{"_id":"5894e2e30d6b0c0f00add3c5","ref":"","in":"header","required":true,"desc":"Authorization is required for this API.  Please use a valid credentials.","default":"Basic XXX","type":"string","name":"Authorization"}],"url":"/funding/transactions"},"isReference":true,"order":4,"body":"Create a withdrawal transaction.","excerpt":"Create a withdrawal into an account using the Tradier Advisor API","slug":"create-a-withdrawal","type":"endpoint","title":"Create a Withdrawal"}

postCreate a Withdrawal

Create a withdrawal into an account using the Tradier Advisor API

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

account:
required
string
Account for the transaction
action:
required
stringWITHDRAWAL
Set to `WITHDRAWAL`.
type:
required
string
Type of the transaction. At this time only `ACH` is permitted.
amount:
required
double
Amount of the deposit
achProfile:
string
ACH Profile Id, required for ACH transactions
ipAddress:
required
string
IP address of the CUSTOMER who requested the transaction

Headers

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

Examples


Result Format


Documentation

Create a withdrawal transaction.