{"_id":"56c72b969e2b6c0d00048713","category":{"_id":"55909cb433090f0d004d25db","pages":["55909cb533090f0d004d25dd","56c72b77862f940d00564759","56c72b969e2b6c0d00048713","56e9fdb142c37a0e0020c460"],"project":"558b53f749dc4f0d00517de0","__v":4,"version":"55909cb433090f0d004d25d8","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-29T00:54:22.238Z","from_sync":false,"order":2,"slug":"account","title":"Basic API functions"},"version":{"_id":"55909cb433090f0d004d25d8","project":"558b53f749dc4f0d00517de0","forked_from":"558b53f749dc4f0d00517de3","__v":8,"createdAt":"2015-06-29T01:17:40.214Z","releaseDate":"2015-06-29T01:17:40.214Z","categories":["55909cb433090f0d004d25d9","55909cb433090f0d004d25da","55909cb433090f0d004d25db","55909cb433090f0d004d25dc","56c72c00197f9f1700c811db","56c72df5b3625c0d00422c9e","56e1b646150ed52d0062c652","56e9fe9779708c0e002b6026","57312dc94245100e001743f4","57646a570742400e00c04701","5894c96f4d9c7e27002e42ba"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"parentDoc":null,"__v":4,"user":"54eb883f4f94620d00789aaa","project":"558b53f749dc4f0d00517de0","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-19T14:49:58.488Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"id\": \"121pd02kt0rnb24nclsg4bglanimurqp\",\n  \"createdAt\": 1404177262332,\n  \"updatedAt\": 1404177262332,\n  \"loginAt\": 1404177262332,\n  \"rank\": 0,\n  \"blockscoreVerifiedAt\": null,\n  \"blockscoreFailedAt\": null,\n  \"profile\": {\n    \"firstName\": \"\",\n    \"lastName\": \"\",\n    \"locale\": \"EN_us\",\n    \"address\": {\n      \"street1\": null,\n      \"street2\": null,\n      \"city\": null,\n      \"state\": null,\n      \"postalCode\": null,\n      \"country\": \"USA\"\n    },\n    \"businessAccount\": true,\n    \"taxId\": null,\n    \"doingBusinessAs\": null,\n    \"website\": null,\n    \"dateOfBirth\": 1404177262332,\n    \"notifyEmail\": true,\n    \"notifyCellphone\": true,\n    \"notifyApnsDevice\": true,\n    \"mfaRequiredForPwChange\": false,\n    \"mfaRequiredForDcPurchase\": false,\n    \"mfaRequiredForSendingFunds\": false,\n    \"authyPhoneNumber\": null\n  },\n  \"paymentMethods\": [],\n  \"identities\": [\n    {\n      \"srn\": \"email:sam:::at:::doonstack.com\",\n      \"createdAt\": 1404177262332,\n      \"verifiedAt\": 1404177262332\n    }\n  ],\n  \"depositAddresses\": {\n    \"BTC\": \"1H9K67J9NcYtzmFGojR9cgM5ybxEddySwu\"\n  },\n  \"totalBalances\": {\n    \"USD\": 11.8934023,\n    \"BTC\": 265.112\n  },\n  \"availableBalances\": {\n    \"USD\": 10.8934023,\n    \"BTC\": 250.112\n  },\n  \"email\": \"[email protected]\",\n  \"cellphone\": \"+15234897342\"\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[],"url":"/account"},"isReference":false,"order":2,"body":"The account resource holds a whole host of information about your account. All of the information displayed in the Wyre dashboard can be found here. \n\nWhen checking your balance you should refer to the `availableBalance` object to see how much of a given currency you have available to Transfer.\n\n##Result Fields\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**id**\",\n    \"1-0\": \"**createdAt**\",\n    \"2-0\": \"**updatedAt**\",\n    \"3-0\": \"**loginAt**\",\n    \"4-0\": \"**rank**\",\n    \"5-0\": \"**blockscoreVerifiedAt**\",\n    \"6-0\": \"**blockscoreFailedAt**\",\n    \"7-0\": \"**profile**\",\n    \"8-0\": \"**paymentMethods**\",\n    \"9-0\": \"**identities**\",\n    \"10-0\": \"**depositAddresses**\",\n    \"11-0\": \"**totalBalances**\",\n    \"12-0\": \"**availableBalances**\",\n    \"13-0\": \"**email**\",\n    \"14-0\": \"**cellphone**\",\n    \"0-1\": \"An internal Wyre id corresponding to your account.\",\n    \"1-1\": \"Time at which the account was created.\",\n    \"2-1\": \"The last time the account was updated.\",\n    \"3-1\": \"The last time the account was logged in to.\",\n    \"4-1\": \"The account's rank. Used for things like limits on the accounts option to purchase digital currencies.\",\n    \"5-1\": \"Time at which the account's identity was verified if the account has been verified.\",\n    \"6-1\": \"Time at which the account's identity failed verification if the account has failed verification.\",\n    \"7-1\": \"A set of fields that the user has permission to modify.\",\n    \"8-1\": \"A list of payment methods available on the account to make digital currency purchases.\",\n    \"9-1\": \"An array of identities (cellphone numbers, email addresses) associated with the account. Each identity includes information about when they were created and when they were verified.\",\n    \"10-1\": \"A map of digital currency deposit addresses for the account.\",\n    \"11-1\": \"A map of the total amount of funds in the user's account. This is the sum of the pending balances and the available balances.\",\n    \"12-1\": \"A map of the total amount of funds available to be withdrawn immediately from the account. If you are performing a check to see if the account has sufficient funds before making a withdrawal, you should check this balance.\",\n    \"13-1\": \"The email tied to the account.\",\n    \"14-1\": \"The cellphone number tied to the account.\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 15\n}\n[/block]","excerpt":"","slug":"getting-your-account-and-checking-balances","type":"endpoint","title":"πŸ“‹  Account Details"}

getπŸ“‹ Account Details


Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

The account resource holds a whole host of information about your account. All of the information displayed in the Wyre dashboard can be found here. When checking your balance you should refer to the `availableBalance` object to see how much of a given currency you have available to Transfer. ##Result Fields [block:parameters] { "data": { "0-0": "**id**", "1-0": "**createdAt**", "2-0": "**updatedAt**", "3-0": "**loginAt**", "4-0": "**rank**", "5-0": "**blockscoreVerifiedAt**", "6-0": "**blockscoreFailedAt**", "7-0": "**profile**", "8-0": "**paymentMethods**", "9-0": "**identities**", "10-0": "**depositAddresses**", "11-0": "**totalBalances**", "12-0": "**availableBalances**", "13-0": "**email**", "14-0": "**cellphone**", "0-1": "An internal Wyre id corresponding to your account.", "1-1": "Time at which the account was created.", "2-1": "The last time the account was updated.", "3-1": "The last time the account was logged in to.", "4-1": "The account's rank. Used for things like limits on the accounts option to purchase digital currencies.", "5-1": "Time at which the account's identity was verified if the account has been verified.", "6-1": "Time at which the account's identity failed verification if the account has failed verification.", "7-1": "A set of fields that the user has permission to modify.", "8-1": "A list of payment methods available on the account to make digital currency purchases.", "9-1": "An array of identities (cellphone numbers, email addresses) associated with the account. Each identity includes information about when they were created and when they were verified.", "10-1": "A map of digital currency deposit addresses for the account.", "11-1": "A map of the total amount of funds in the user's account. This is the sum of the pending balances and the available balances.", "12-1": "A map of the total amount of funds available to be withdrawn immediately from the account. If you are performing a check to see if the account has sufficient funds before making a withdrawal, you should check this balance.", "13-1": "The email tied to the account.", "14-1": "The cellphone number tied to the account.", "h-0": "Field", "h-1": "Description" }, "cols": 2, "rows": 15 } [/block]