BANK ACCOUNTS

Get List

Retrieve your bank accounts. Use action_required to limit the results to accounts that need attention, such as a missing signature or a returned account.

Class: bank accounts

Method: get-list

POST/bank-accounts/get-list

Parameters

  • client_id*
  • akey*
  • action_required - Set this to 1 or 0, indicating true or false
  • sub_client_id - Filter by sub client ID
  • account_number - Filter by account number
  • routing_number - Filter by routing number

JSON response

JSONResponse example
{
  "bank_accounts": [
    {
      "id": "22988",
      "date_submitted": 1563318284,
      "signature_assigned": false,
      "signature2_assigned": false,
      "alias": "Operating Account",
      "alert_email_address": false,
      "email_address": "",
      "name_on_checks": "Northstar Supply Co.",
      "address_on_checks": "1800 Meridian Avenue|Suite 200|Denver, CO 80202",
      "account_address": "1800 Meridian Avenue",
      "account_address2": "Suite 200",
      "account_city": "Denver",
      "account_state": "CO",
      "account_zip": "80202",
      "account_number": "12345671426347",
      "routing_number": "43217842",
      "bank_name": "Example Commercial Bank",
      "bank_address": "500 Financial Plaza|Denver, CO 80202",
      "bank_fractional_code": "123-45/67",
      "currency": "USD",
      "custom_return_address": "",
      "micro_deposits_sent": false,
      "returned": false,
      "return_reason": "",
      "verified": true,
      "active": true,
      "name_on_account": "Northstar Supply Co.",
      "ach_company_id": "",
      "ach_originating_dfi": "",
      "ach_receiving_dfi": "",
      "checks_enabled": true,
      "ach_enabled": false,
      "confirmed": false,
      "purchase_order": "",
      "notify_on_payments_sent": false,
      "notify_sent_email_address": "",
      "proof_approved": false
    },
    {
      "id": "22989",
      "date_submitted": 1563318284,
      "signature_assigned": false,
      "signature2_assigned": false,
      "alias": "Payroll Account",
      "alert_email_address": false,
      "email_address": "",
      "name_on_checks": "Northstar Supply Co.",
      "address_on_checks": "1800 Meridian Avenue|Suite 200|Denver, CO 80202",
      "account_address": "1800 Meridian Avenue",
      "account_address2": "Suite 300",
      "account_city": "Denver",
      "account_state": "CO",
      "account_zip": "80202",
      "account_number": "12345671423538",
      "routing_number": "43219158",
      "bank_name": "Example Commercial Bank",
      "bank_address": "500 Financial Plaza|Denver, CO 80202",
      "bank_fractional_code": "123-45/67",
      "currency": "USD",
      "custom_return_address": "",
      "micro_deposits_sent": false,
      "returned": false,
      "return_reason": "",
      "verified": true,
      "active": true,
      "name_on_account": "Northstar Supply Co.",
      "ach_company_id": "",
      "ach_originating_dfi": "",
      "ach_receiving_dfi": "",
      "checks_enabled": true,
      "ach_enabled": false,
      "confirmed": false,
      "purchase_order": "",
      "notify_on_payments_sent": false,
      "notify_sent_email_address": "",
      "proof_approved": false
    },
    {
      "id": "22990",
      "date_submitted": 1563318284,
      "signature_assigned": false,
      "signature2_assigned": false,
      "alias": "Vendor Payments Account",
      "alert_email_address": false,
      "email_address": "",
      "name_on_checks": "Northstar Supply Co.",
      "address_on_checks": "1800 Meridian Avenue|Suite 200|Denver, CO 80202",
      "account_address": "1800 Meridian Avenue",
      "account_address2": "Suite 400",
      "account_city": "Denver",
      "account_state": "CO",
      "account_zip": "80202",
      "account_number": "12345671424201",
      "routing_number": "43216600",
      "bank_name": "Example Commercial Bank",
      "bank_address": "500 Financial Plaza|Denver, CO 80202",
      "bank_fractional_code": "123-45/67",
      "currency": "USD",
      "custom_return_address": "",
      "micro_deposits_sent": false,
      "returned": false,
      "return_reason": "",
      "verified": true,
      "active": true,
      "name_on_account": "Northstar Supply Co.",
      "ach_company_id": "",
      "ach_originating_dfi": "",
      "ach_receiving_dfi": "",
      "checks_enabled": true,
      "ach_enabled": false,
      "confirmed": false,
      "purchase_order": "",
      "notify_on_payments_sent": false,
      "notify_sent_email_address": "",
      "proof_approved": false
    }
  ]
}

XML response

XMLResponse example
<wmc-response status="1">
	<bankaccounts>
		<bankaccount id='14009'>
			<bankaccount_id>14009</bankaccount_id>
			<submit_ts>1446043631</submit_ts>
			<alias>Operating Account</alias>
			<alert_email_address>0</alert_email_address>
			<email_address></email_address>
			<name_on_checks>Northstar Supply Co.</name_on_checks>
			<address_on_checks>1800 Meridian Avenue|Suite 200|Denver, CO 80202</address_on_checks>
			<account_address>1800 Meridian Avenue</account_address>
			<account_address2>Suite 200</account_address2>
			<account_city>Denver</account_city>
			<account_state>CO</account_state>
			<account_zip>80202</account_zip>
			<account_number>1234567142850</account_number>
			<routing_number>43213310</routing_number>
			<bank_name>Example Commercial Bank</bank_name>
			<bank_address>500 Financial Plaza|Denver, CO 80202</bank_address>
			<bank_fractional_code>123-45/67</bank_fractional_code>
			<custom_return_address></custom_return_address>
			<micro_deposits_sent>0</micro_deposits_sent>
			<returned>0</returned>
			<return_reason></return_reason>
			<verified>0</verified>
			<active>1</active>
			<signature_assigned>0</signature_assigned>
			<signature2_assigned>0</signature2_assigned>
			<confirmed>1</confirmed>
		</bankaccount>
		<bankaccount id='14010'>
			<bankaccount_id>14010</bankaccount_id>
			<submit_ts>1446043631</submit_ts>
			<alias>Payroll Account</alias>
			<alert_email_address>0</alert_email_address>
			<email_address></email_address>
			<name_on_checks>Northstar Supply Co.</name_on_checks>
			<address_on_checks>1800 Meridian Avenue|Suite 200|Denver, CO 80202</address_on_checks>
			<account_address>1800 Meridian Avenue</account_address>
			<account_address2>Suite 300</account_address2>
			<account_city>Denver</account_city>
			<account_state>CO</account_state>
			<account_zip>80202</account_zip>
			<account_number>12345671425210</account_number>
			<routing_number>43214492</routing_number>
			<bank_name>Example Commercial Bank</bank_name>
			<bank_address>500 Financial Plaza|Denver, CO 80202</bank_address>
			<bank_fractional_code>123-45/67</bank_fractional_code>
			<custom_return_address></custom_return_address>
			<micro_deposits_sent>0</micro_deposits_sent>
			<returned>0</returned>
			<return_reason></return_reason>
			<verified>0</verified>
			<active>1</active>
			<signature_assigned>0</signature_assigned>
			<signature2_assigned>0</signature2_assigned>
			<confirmed>1</confirmed>
		</bankaccount>
		<bankaccount id='14011'>
			<bankaccount_id>14011</bankaccount_id>
			<submit_ts>1446043631</submit_ts>
			<alias>Vendor Payments Account</alias>
			<alert_email_address>0</alert_email_address>
			<email_address></email_address>
			<name_on_checks>Northstar Supply Co.</name_on_checks>
			<address_on_checks>1800 Meridian Avenue|Suite 200|Denver, CO 80202</address_on_checks>
			<account_address>1800 Meridian Avenue</account_address>
			<account_address2>Suite 400</account_address2>
			<account_city>Denver</account_city>
			<account_state>CO</account_state>
			<account_zip>80202</account_zip>
			<account_number>1234567142883</account_number>
			<routing_number>43215420</routing_number>
			<bank_name>Example Commercial Bank</bank_name>
			<bank_address>500 Financial Plaza|Denver, CO 80202</bank_address>
			<bank_fractional_code>123-45/67</bank_fractional_code>
			<custom_return_address></custom_return_address>
			<micro_deposits_sent>0</micro_deposits_sent>
			<returned>0</returned>
			<return_reason></return_reason>
			<verified>0</verified>
			<active>1</active>
			<signature_assigned>0</signature_assigned>
			<signature2_assigned>0</signature2_assigned>
			<confirmed>1</confirmed>
		</bankaccount>
	</bankaccounts>
</wmc-response>

Search documentation