BANK ACCOUNTS

Add

Add a bank account for check or ACH payments. Review the returned account details, then use Confirm to complete the submission.

By adding a bank account through this method, you are agreeing to the following terms: I approve this information, including the signature is correct, and take responsibility for any inaccurate information provided. I also acknowledge that fees may apply if the sub-account requires special printing.

Class: bank accounts

Method: add

POST/bank-accounts/add

Parameters

  • client_id*
  • akey*
  • name_on_checks - The name to be printed on checks (populating this field will enable Checks for this bank account)
  • address_on_checks - Address printed on checks. Separate lines with the | character
  • address* - The bank account holder's first address line
  • address2 - The bank account holder's second address line, if applicable
  • city* - The bank account holder's city
  • state* - The bank account holder's state
  • zip* - The bank account holder's zip code
  • account_number* - Bank account number
  • routing_number* - Bank routing number
  • bank_name* - Bank name
  • bank_address - Bank address. Separate address lines with the | character
  • bank_fractional_code - Bank fractional code (required for checks only)
  • currency - Currency code. Defaults to USD; use CAD for Canadian bank accounts (checks only)
  • sig2_threshold - This is used to set a threshold, where if a payment reaches this threshold, a second signature is used only then, otherwise if set a second signature is used all of the time
  • only_use_sig2_threshold - This is set to 1 or 0, indicating enabled or disabled, and enforces the threshold above
  • account_alias* - Account alias displayed in the system
  • email_address - Email address for individual alerts and verification links
  • alert_email_address - Set to 1 to send individual verification emails directly to users, or 0 to disable them
  • return_address - Custom return address. Separate lines with the | character
  • starting_check_number - Starting check number
  • sig_file - Signature image sent as a multipart upload. Use an image containing only the signature on a white background (only required for Checks)
  • sig_file2 - Optional second signature image. Without the threshold settings above, this signature is printed on every check
  • name_on_account - Name on bank account. This field will be automatically set to name on checks if not provided.
  • ach_company_id - ACH Company/Tax ID (populating this field will enable ACH for this bank account)
  • ach_originating_dfi - Originating DFI number (required only if enabling ACH)
  • ach_receiving_dfi - Receiving DFI Number (required only if enabling ACH)
  • purchase_order  - Purchase order reference included on invoices when provided
  • notify_sent_email_address  - Email address for payment sent notifications specific to this bank account
  • notify_on_payments_sent  - Set to 1 to use the account-specific payment notification email, or 2 to disable it
  • logo_file  - Logo printed at the top right of the check stub for this account. Send a clear image with a white background as a multipart upload. Accepted formats: Bitmap, JPG and PNG

JSON response

JSONResponse example
{
  "bank_account": {
    "id": "22982",
    "date_submitted": 1563317623,
    "signature_assigned": true,
    "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": "12345678912334",
    "routing_number": "98765432196",
    "bank_name": "Example Commercial Bank",
    "bank_address": "500 Financial Plaza|Denver, CO 80202",
    "bank_fractional_code": "123/456-78",
    "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": "1234567890",
    "ach_originating_dfi": "12345678",
    "ach_receiving_dfi": "12345678",
    "checks_enabled": true,
    "ach_enabled": true,
    "confirmed": false,
    "purchase_order": "",
    "notify_on_payments_sent": true,
    "notify_sent_email_address": "payments@example.com",
    "proof_approved": false,
    "logo_assigned": true
  }
}

XML response

XMLResponse example
<wmc-response status="1">
	<bankaccount id='13991'>
		<bankaccount_id>13991</bankaccount_id>
		<submit_ts>1446043376</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>12345678912314</account_number>
		<routing_number>987654321100</routing_number>
		<bank_name>Example Commercial Bank</bank_name>
		<bank_address>500 Financial Plaza|Denver, CO 80202</bank_address>
		<bank_fractional_code>123/456-78</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>1</signature_assigned>
		<signature2_assigned>0</signature2_assigned>
		<confirmed>1</confirmed>
		<logo_assigned>1</logo_assigned>
	</bankaccount>
</wmc-response>

Search documentation