{"_id":"565ceef9c23e2f0d00383db0","parentDoc":null,"category":{"_id":"55e4e0753325e60d007fbee6","__v":7,"pages":["55e9e598bc521e2b006a0f5e","55e9e5bcc62aa02f00822994","56093be58aedf50d0004d015","56093c2a6d8c440d000c7a6f","56093cadc5cff70d007d014a","56093ccf6d8c440d000c7a70","565ceef9c23e2f0d00383db0"],"project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-31T23:17:09.371Z","from_sync":false,"order":7,"slug":"banks","title":"Banks"},"user":"55dd080d0efd5821000d53b3","version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"__v":58,"githubsync":"","project":"55dd0853d2d97337001800e2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-01T00:51:05.863Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Adding and verifying banks\",\n  \"body\": \"Adding and verifying banks is done through the bank resource. Funds can be withdrawn using a verified bank.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Payment with a bank on file\",\n  \"body\": \"Use the [Create a payment (authenticated)](doc:create-a-payment-secure) endpoint to create a payment with a bank on file by providing a bankId. This feature is available depending on your plan.\"\n}\n[/block]\n## Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Specification\",\n    \"0-0\": \"nameOnAccount\",\n    \"1-0\": \"accountType\",\n    \"3-0\": \"accountNumber\",\n    \"8-0\": \"amounts\",\n    \"4-0\": \"routingNumber\",\n    \"5-0\": \"currency\",\n    \"6-0\": \"country\",\n    \"9-0\": \"billingAddress\",\n    \"10-0\": \"meta\",\n    \"0-1\": \"**Type**: String\\n**Length**: 0-256 characters\\n**Example**: \\\"Jessica Lin\\\"\\n**Description**: The name on the bank account.\",\n    \"1-1\": \"**Type**: String\\n**Values**: \\\"checking\\\" or \\\"savings\\\"\",\n    \"3-1\": \"**Type**: String\\n**Length**: 1-32 characters\\n**Example**: \\\"000123456789\\\"\\n**Description**: The account number for the bank account.\",\n    \"4-1\": \"**Type**: String\\n**Format**: Valid 9 digit US Routing Number\\n**Example**: \\\"110000000\\\"\\n**Description**: The routing number for the bank account.\",\n    \"5-1\": \"**Type**: String\\n**Format**: ISO4217 currency code\\n**Example**: \\\"USD\\\"\\n**Description**: The currency for the bank account.\",\n    \"6-1\": \"**Type**: String\\n**Format**: ISO 3166-1 alpha-3\\n**Example**: \\\"USA\\\"\\n**Description**: The country where this bank account is located.\",\n    \"8-1\": \"**Type**: Array of Integer Strings as pennies\\n**Length**: 2\\n**Example**: [\\\"32\\\", \\\"45\\\"]\\n**Description**: The two drop amounts that were deposited into the user's bank.\",\n    \"9-1\": \"**Type**: JSON Object\\n**Format**: [Address](doc:address) \\n**Description**: The billing address for the bank.\",\n    \"10-1\": \"**Type**: JSON Object\\n**Format**: [Meta](doc:meta) \\n**Description**: An optional object to store custom data for the Bank.\",\n    \"7-0\": \"isDefault\",\n    \"7-1\": \"**Type**: Boolean\\n**Example**: true\\n**Description**: If true, the Bank will be used as the default Merchant bank for automated withdrawals.\",\n    \"2-0\": \"accountHolderType\",\n    \"2-1\": \"**Type**: String\\n**Values**: \\\"individual\\\" or \\\"company\\\"\\n**Description**: The type of entity that holds this bank account.\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]\n## Response\n\nWith the exception of accountNumber, all Request parameters will also be returned in the Response. The bank account number will never be returned in responses. The last four digits of the bank account number is returned instead. The following additional parameters may also be included in responses.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"object\",\n    \"2-0\": \"last4\",\n    \"3-0\": \"fingerprint\",\n    \"4-0\": \"dropped\",\n    \"5-0\": \"verified\",\n    \"6-0\": \"status\",\n    \"7-0\": \"created\",\n    \"8-0\": \"lastUpdated\",\n    \"0-1\": \"The unique identifier for the bank.\",\n    \"1-1\": \"Will have value \\\"bank\\\" indicating that the object is a bank response.\",\n    \"2-1\": \"The last four digits of the bank account.\",\n    \"3-1\": \"A unique hash given to the bank that uniquely identifies the bank account characteristics.\",\n    \"7-1\": \"The date the bank was created.\",\n    \"8-1\": \"The date the bank was last updated.\",\n    \"6-1\": \"The current status of the bank account. One of: \\\"created\\\", \\\"active\\\", \\\"disabled\\\"\",\n    \"4-1\": \"Set to true when the bank account has been two dropped.\",\n    \"5-1\": \"Set to true when the bank account has been two drop verified.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"nameOnAccount\\\": \\\"Jessica Lin\\\",\\n  \\\"accountType\\\": \\\"checking\\\",\\n  \\\"accountNumber\\\": \\\"000123456789\\\",\\n  \\\"routingNumber\\\": \\\"110000000\\\",\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"country\\\": \\\"USA\\\",\\n  \\\"isDefault\\\": true,\\n  \\\"amounts\\\": [\\\"32\\\", \\\"45\\\"],\\n  \\\"meta\\\": {\\n    \\\"clientCustomerId\\\": \\\"14f3c86236714b508c58f9956831fb6b\\\"\\n  },\\n  \\\"billingAddress\\\": {\\n    \\\"street1\\\": \\\"923 test account st\\\",\\n    \\\"street2\\\": \\\"9g\\\",\\n    \\\"city\\\": \\\"santa cruz\\\",\\n    \\\"state\\\": \\\"CA\\\",\\n    \\\"postalCode\\\": \\\"90040\\\",\\n    \\\"country\\\": \\\"USA\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Bank Request\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"nameOnAccount\\\": \\\"Jessica Lin\\\",\\n  \\\"routingNumber\\\": \\\"110000000\\\",\\n  \\\"accountNumber\\\": \\\"000123456789\\\",\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"accountType\\\": \\\"checking\\\",\\n  \\\"isDefault\\\": true,\\n  \\\"billingAddress\\\": {\\n    \\\"street1\\\": \\\"923 test account st\\\",\\n    \\\"street2\\\": \\\"9g\\\",\\n    \\\"city\\\": \\\"santa cruz\\\",\\n    \\\"state\\\": \\\"CA\\\",\\n    \\\"postalCode\\\": \\\"90040\\\",\\n    \\\"country\\\": \\\"USA\\\"\\n  },\\n  \\\"meta\\\": {\\n    \\\"clientCustomerId\\\": \\\"14f3c86236714b508c58f9956831fb6b\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Bank Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"the-bank-resource","type":"basic","title":"Bank resource"}
[block:callout] { "type": "success", "title": "Adding and verifying banks", "body": "Adding and verifying banks is done through the bank resource. Funds can be withdrawn using a verified bank." } [/block] [block:callout] { "type": "info", "title": "Payment with a bank on file", "body": "Use the [Create a payment (authenticated)](doc:create-a-payment-secure) endpoint to create a payment with a bank on file by providing a bankId. This feature is available depending on your plan." } [/block] ## Request [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Specification", "0-0": "nameOnAccount", "1-0": "accountType", "3-0": "accountNumber", "8-0": "amounts", "4-0": "routingNumber", "5-0": "currency", "6-0": "country", "9-0": "billingAddress", "10-0": "meta", "0-1": "**Type**: String\n**Length**: 0-256 characters\n**Example**: \"Jessica Lin\"\n**Description**: The name on the bank account.", "1-1": "**Type**: String\n**Values**: \"checking\" or \"savings\"", "3-1": "**Type**: String\n**Length**: 1-32 characters\n**Example**: \"000123456789\"\n**Description**: The account number for the bank account.", "4-1": "**Type**: String\n**Format**: Valid 9 digit US Routing Number\n**Example**: \"110000000\"\n**Description**: The routing number for the bank account.", "5-1": "**Type**: String\n**Format**: ISO4217 currency code\n**Example**: \"USD\"\n**Description**: The currency for the bank account.", "6-1": "**Type**: String\n**Format**: ISO 3166-1 alpha-3\n**Example**: \"USA\"\n**Description**: The country where this bank account is located.", "8-1": "**Type**: Array of Integer Strings as pennies\n**Length**: 2\n**Example**: [\"32\", \"45\"]\n**Description**: The two drop amounts that were deposited into the user's bank.", "9-1": "**Type**: JSON Object\n**Format**: [Address](doc:address) \n**Description**: The billing address for the bank.", "10-1": "**Type**: JSON Object\n**Format**: [Meta](doc:meta) \n**Description**: An optional object to store custom data for the Bank.", "7-0": "isDefault", "7-1": "**Type**: Boolean\n**Example**: true\n**Description**: If true, the Bank will be used as the default Merchant bank for automated withdrawals.", "2-0": "accountHolderType", "2-1": "**Type**: String\n**Values**: \"individual\" or \"company\"\n**Description**: The type of entity that holds this bank account." }, "cols": 2, "rows": 11 } [/block] ## Response With the exception of accountNumber, all Request parameters will also be returned in the Response. The bank account number will never be returned in responses. The last four digits of the bank account number is returned instead. The following additional parameters may also be included in responses. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "id", "1-0": "object", "2-0": "last4", "3-0": "fingerprint", "4-0": "dropped", "5-0": "verified", "6-0": "status", "7-0": "created", "8-0": "lastUpdated", "0-1": "The unique identifier for the bank.", "1-1": "Will have value \"bank\" indicating that the object is a bank response.", "2-1": "The last four digits of the bank account.", "3-1": "A unique hash given to the bank that uniquely identifies the bank account characteristics.", "7-1": "The date the bank was created.", "8-1": "The date the bank was last updated.", "6-1": "The current status of the bank account. One of: \"created\", \"active\", \"disabled\"", "4-1": "Set to true when the bank account has been two dropped.", "5-1": "Set to true when the bank account has been two drop verified." }, "cols": 2, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "{\n\t\"nameOnAccount\": \"Jessica Lin\",\n \"accountType\": \"checking\",\n \"accountNumber\": \"000123456789\",\n \"routingNumber\": \"110000000\",\n \"currency\": \"USD\",\n \"country\": \"USA\",\n \"isDefault\": true,\n \"amounts\": [\"32\", \"45\"],\n \"meta\": {\n \"clientCustomerId\": \"14f3c86236714b508c58f9956831fb6b\"\n },\n \"billingAddress\": {\n \"street1\": \"923 test account st\",\n \"street2\": \"9g\",\n \"city\": \"santa cruz\",\n \"state\": \"CA\",\n \"postalCode\": \"90040\",\n \"country\": \"USA\"\n }\n}", "language": "json", "name": "Bank Request" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"nameOnAccount\": \"Jessica Lin\",\n \"routingNumber\": \"110000000\",\n \"accountNumber\": \"000123456789\",\n \"currency\": \"USD\",\n \"accountType\": \"checking\",\n \"isDefault\": true,\n \"billingAddress\": {\n \"street1\": \"923 test account st\",\n \"street2\": \"9g\",\n \"city\": \"santa cruz\",\n \"state\": \"CA\",\n \"postalCode\": \"90040\",\n \"country\": \"USA\"\n },\n \"meta\": {\n \"clientCustomerId\": \"14f3c86236714b508c58f9956831fb6b\"\n }\n}", "language": "json", "name": "Bank Response" } ], "sidebar": true } [/block]