PAYMENTS

Add

Create a check or ACH payment. Review the returned payment details, then call Confirm with the payment ID to release it for processing.

Class: payments

Method: add

POST/payments/add

Check payments (method_id = 2)

International USPS Priority and Express services do not have the same delivery times or price rates as domestic mail. Pricing will vary per service. Delivery times for these services going international are listed below:

USPS Priority International = 6-10 days
USPS Express International = 3-5 days

Parameters

  • client_id*
  • akey*
  • method_id* - numeric id representing a method of payment
  • payee* - name of payee, 48 characters max length
  • amount* - amount of payment (xxx.xx). This is entered with no currency symbols; just numbers and decimals
  • address* - payee street address, 120 characters max length if no address2 is provided, if address2 is provided, there is a 60 character limit on this and address2 fields
  • address2
  • city* - payee city
  • country* - payee country
  • logo_file - name of client's logo file stored on the system
  • memo - information placed on the stub of the check or the memo line of the check depending upon client setup
  • notes - internal notes to pass to the system along with the payment
  • payee_email - payee email (optional)
  • payment_type - indicates the type of payment, e.g. Bill Payment, Commission, etc
  • postage_code (one of the following numeric values)
    • 1 - USPS First Class
    • 2 - USPS Priority
    • 3 - USPS Priority + Delivery Confirmation
    • 4 - USPS Priority + Signature Confirmation
    • 5 - FedEx Express 2 Day
    • 6 - FedEx Express Overnight
    • 8 - USPS Overnight
    • 9 - USPS Certified Mail
    • 10 - FedEx Priority Overnight
  • reference* - reference
  • state* - payee state
  • taxid - SSN or tax identification number
  • trans_id* - Your transaction ID for identifying the payment in reports
  • zip* - Payee ZIP or postal code. Use five digits or ZIP+4 format for US addresses
  • check_num - Optional check number, up to 10 digits and non-negative. Leave blank or omit the field to generate a check number automatically
  • bank_account_id - Bank account ID or alias to fund the check. If omitted, the default bank account is used
  • mail_to_payee - if you populate this field it will replace the payee name in the address for mailing
  • expedite_request - Set to 1 to request processing after the 9:00 AM cutoff and before 11:00 AM. Expedited processing is not guaranteed
  • date_to_send - Requested send date in MM/DD/YYYY format. Requires future-dated payments to be enabled on your account. Dates that fall on a non-working day move to the next working day. Contact support to enable this feature

Parameters

To include a PDF insert with a check, provide the following parameters:

  • insert_include* - Set to 1 to include a PDF insert
  • insert_file* - PDF file sent as a multipart upload using the field name 'insert_file'
  • insert_print* - Select the insert print format using one of the following values
    • black_white - Print using Black & White
    • black_white_duplex - Print using Black & White Duplex
    • color - Print using Color
    • color_duplex - Print using Color Duplex

JSON response

JSONResponse example
{
  "payment": {
    "date_submitted": 1563231463,
    "date_updated": null,
    "date_sent": null,
    "confirmed": false,
    "deleted": false,
    "payee": "Harbor Office Supply LLC",
    "amount": "69.00",
    "date_to_send": 1563231463,
    "id": 5812931,
    "method": {
      "id": 2,
      "name": "Check"
    },
    "status": {
      "id": 1,
      "name": "Pending Release"
    },
    "fee": "0.00",
    "postage_fee": "0.00",
    "extra_fee": "0.00",
    "address": "1250 Market Street",
    "check_num": "0",
    "city": "Denver",
    "trans_id": "PAY-2026-001042",
    "country": "US",
    "memo": "Payment for invoice INV-2026-1042",
    "postage_code": {
      "id": "1",
      "name": "USPS First Class"
    },
    "reference": "INV-2026-1042",
    "state": "CO",
    "zip": "80202"
  }
}

XML response

XMLResponse example
<wmc-response status="1">
	<payment id='1310350' status='0'>
		<payment_id>1310350</payment_id>
		<client_id>1</client_id>
		<client>Northstar Supply Co.</client>
		<company_name>Northstar Supply Co.</company_name>
		<status_id>0</status_id>
		<method_id>2</method_id>
		<submit_ts>1378508396</submit_ts>
		<date_submitted>1378508396</date_submitted>
		<date_updated></date_updated>
		<date_exported></date_exported>
		<date_sent></date_sent>
		<confirmed>0</confirmed>
		<deleted>0</deleted>
		<payee>Harbor Office Supply LLC</payee>
		<amount>69.00</amount>
		<pay>1</pay>
		<id>1310350</id>
		<address>1250 Market Street</address>
		<address2></address2>
		<insert_file></insert_file>
		<check_num>0</check_num>
		<city>Denver</city>
		<trans_id>PAY-2026-001042</trans_id>
		<country>US</country>
		<first_name></first_name>
		<insert_color>0</insert_color>
		<last_name></last_name>
		<logo_file></logo_file>
		<memo>Payment for invoice INV-2026-1042</memo>
		<memo2></memo2>
		<notes></notes>
		<payee_email></payee_email>
		<payment_type></payment_type>
		<postage_code>1</postage_code>
		<reference>INV-2026-1042</reference>
		<ref>INV-2026-1042</ref>
		<taxid></taxid>
		<state>CO</state>
		<tracking></tracking>
		<zip>80202</zip>
		<fee>0.00</fee>
		<postage_fee>0.00</postage_fee>
		<extra_fee>0.00</extra_fee>
	</payment>
</wmc-response>

ACH payments (method_id = 1)

Parameters

  • client_id*
  • akey*
  • method_id* - numeric id representing a method of payment
  • payee* - name of payee
  • amount* - amount of payment (xxx.xx). This is entered with no currency symbols; just numbers and decimals
  • acct_class* - Personal / Corporate
  • acct_name - name on account
  • acct_num* - account num
  • acct_route* - the 9-digit routing number of the receiving bank to which the payment is being sent
  • acct_type* - Checking / Savings
  • address* - payee street address
  • address2
  • bank_name* - bank name
  • city* - payee city
  • country* - payee country
  • first_name - payment recipient's first name
  • last_name - payment recipient's last name
  • notes - internal notes to pass to the system along with the payment
  • payee_email - payee email (optional)
  • payment_type - free-form text field to indicate the type of payment, e.g. Bill Payment, Rebate, Commission, etc
  • reference* - reference info printed on check stub or memo line or tagged on wire transfer
  • state* - payee state
  • taxid - SSN or tax identification number
  • trans_id* - Your transaction ID for identifying the payment in reports
  • zip* - payee zip / postal code
  • bank_account_id - Bank account ID or alias to fund the ACH payment. If omitted, the default bank account is used
  • expedite_request - Set to 1 to request processing after the 9:00 AM cutoff and before 11:00 AM. Expedited processing is not guaranteed

JSON response

JSONResponse example
{
  "payment": {
    "date_submitted": 1563231735,
    "date_updated": null,
    "date_sent": null,
    "confirmed": false,
    "deleted": false,
    "payee": "Harbor Office Supply LLC",
    "amount": "69.00",
    "date_to_send": 1563231735,
    "id": 5812978,
    "method": {
      "id": 1,
      "name": "ACH"
    },
    "status": {
      "id": 1,
      "name": "Pending Release"
    },
    "fee": "0.00",
    "postage_fee": "0.00",
    "extra_fee": "0.00",
    "acct_class": "Personal",
    "acct_num": "123456789",
    "acct_route": "987654321",
    "acct_type": "Checking",
    "address": "1250 Market Street",
    "bank_name": "Example Commercial Bank",
    "city": "Denver",
    "trans_id": "PAY-2026-001042",
    "country": "US",
    "is_credit": "No",
    "reference": "INV-2026-1042",
    "state": "CO",
    "zip": "80202",
    "bank_account_id": "1"
  }
}

XML response

XMLResponse example
<wmc-response status="1">
	<payment id='1309160' status='0'>
		<payment_id>1309160</payment_id>
		<client_id>1</client_id>
		<client>Northstar Supply Co.</client>
		<company_name>Northstar Supply Co.</company_name>
		<status_id>0</status_id>
		<method_id>1</method_id>
		<submit_ts>1378433857</submit_ts>
		<date_submitted>1378433857</date_submitted>
		<date_updated></date_updated>
		<date_exported></date_exported>
		<date_sent></date_sent>
		<confirmed>0</confirmed>
		<deleted>0</deleted>
		<payee>Harbor Office Supply LLC</payee>
		<amount>300.00</amount>
		<pay>1</pay>
		<id>1309160</id>
		<acct_class>Personal</acct_class>
		<acct_num>123456789</acct_num>
		<acct_route>036001808</acct_route>
		<acct_type>Checking</acct_type>
		<address>1250 Market Street</address>
		<address2></address2>
		<bank_name>Example Commercial Bank</bank_name>
		<city>Denver</city>
		<trans_id>PAY-2026-001042</trans_id>
		<country>US</country>
		<first_name></first_name>
		<last_name></last_name>
		<acct_name></acct_name>
		<notes></notes>
		<payee_email></payee_email>
		<payment_type></payment_type>
		<reference>INV-2026-1042</reference>
		<ref>INV-2026-1042</ref>
		<taxid></taxid>
		<state>CO</state>
		<zip>80202</zip>
		<fee>0.00</fee>
		<postage_fee>0.00</postage_fee>
		<extra_fee>0.00</extra_fee>
	</payment>
</wmc-response>

Search documentation