PAYMENTS

Upload

Upload a check or ACH payment file using your configured file mapping. Review the returned records and file ID, then call Confirm to release the payments for processing.

Class: payments

Method: upload

POST/payments/upload

Parameters

  • client_id*
  • akey*
  • method_id* - payment method identifier (2 = Check, 1 = ACH)
  • userfile* - File sent as a multipart upload
  • expedite_request - Set to 1 to request processing after the 9:00 AM cutoff and before 11:00 AM. Expedited processing is not guaranteed
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

The response depends on the payment type. These examples contain two checks. Use the returned file_id value in JSON or the fileid attribute on the XML wmc-response element to identify the file when confirming it.

Check Inserts

Choose a single PDF insert for all checks, or multiple inserts matched by filename. For multiple inserts, support must configure a payment file column to map each check to its PDF filename. Use the following parameters:

  • insert_include* - Set to "single" to include the same PDF with all checks, or "multiple" to match uploaded PDFs using the configured filename column
  • insert_file_single - PDF insert for all checks, sent as a multipart upload
  • insert_file_multiple - PDF inserts matched to the configured filename column. Send multipart files using indexed field names such as insert_file_multiple[0] and insert_file_multiple[1]
  • 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

A payment file can contain up to 5,000 payments. Files above this limit are rejected. Divide larger batches into separate files and upload each file individually.

JSON response

JSONResponse example
{
  "file_id": 63899,
  "payments": [
    {
      "date_submitted": 1563233940,
      "date_updated": null,
      "date_sent": null,
      "confirmed": false,
      "deleted": false,
      "payee": "Harbor Office Supply LLC",
      "amount": "1.00",
      "date_to_send": 1563233940,
      "id": 5813088,
      "method": {
        "id": 2,
        "name": "Check"
      },
      "status": {
        "id": 1,
        "name": "Pending Release"
      },
      "fee": "0.00",
      "postage_fee": "0.00",
      "extra_fee": "0.00",
      "postage_code": {
        "id": "1",
        "name": "USPS First Class"
      },
      "check_num": "10001",
      "reference": "INV-2026-1042",
      "address": "1250 Market Street",
      "address2": "Suite 200",
      "city": "Denver",
      "state": "CO",
      "zip": "80202",
      "country": "US",
      "memo": ""
    },
    {
      "date_submitted": 1563233940,
      "date_updated": null,
      "date_sent": null,
      "confirmed": false,
      "deleted": false,
      "payee": "Summit Logistics LLC",
      "amount": "1.00",
      "date_to_send": 1563233940,
      "id": 5813089,
      "method": {
        "id": 2,
        "name": "Check"
      },
      "status": {
        "id": 1,
        "name": "Pending Release"
      },
      "fee": "0.00",
      "postage_fee": "0.00",
      "extra_fee": "0.00",
      "postage_code": {
        "id": "1",
        "name": "USPS First Class"
      },
      "check_num": "10002",
      "reference": "INV-2026-1043",
      "address": "4800 Innovation Drive",
      "address2": "Suite 300",
      "city": "Denver",
      "state": "CO",
      "zip": "80202",
      "country": "US",
      "memo": ""
    }
  ]
}

XML response

XMLResponse example
<wmc-response status="1" fileid="13840">
	<payments>
		<payment id='1899463' status='0'>
			<payment_id>1899463</payment_id>
			<client_id>1</client_id>
			<client>Northstar Supply Co.</client>
			<company_name>Northstar Supply Co.</company_name>
			<status_id>0</status_id>
			<status>Pending Release</status>
			<method_id>2</method_id>
			<submit_ts>1420204037</submit_ts>
			<date_submitted>1420204037</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>1.50</amount>
			<pay>1</pay>
			<checked_for_duplicates>0</checked_for_duplicates>
			<id>1899463</id>
			<postage_code>1</postage_code>
			<reference>INV-2026-1042</reference>
			<ref>INV-2026-1042</ref>
			<address>1250 Market Street</address>
			<city>Denver</city>
			<state>CO</state>
			<zip>80202</zip>
			<country>US</country>
			<taxid></taxid>
			<memo>Payment for invoice INV-2026-1042</memo>
			<trans_id></trans_id>
			<fee>0.00</fee>
			<postage_fee>0.00</postage_fee>
			<extra_fee>0.00</extra_fee>
		</payment>
		<payment id='1899464' status='0'>
			<payment_id>1899464</payment_id>
			<client_id>1</client_id>
			<client>Northstar Supply Co.</client>
			<company_name>Northstar Supply Co.</company_name>
			<status_id>0</status_id>
			<status>Pending Release</status>
			<method_id>2</method_id>
			<submit_ts>1420204037</submit_ts>
			<date_submitted>1420204037</date_submitted>
			<date_updated></date_updated>
			<date_exported></date_exported>
			<date_sent></date_sent>
			<confirmed>0</confirmed>
			<deleted>0</deleted>
			<payee>Summit Logistics LLC</payee>
			<amount>2.00</amount>
			<pay>1</pay>
			<checked_for_duplicates>0</checked_for_duplicates>
			<id>1899464</id>
			<postage_code>1</postage_code>
			<reference>INV-2026-1043</reference>
			<ref>INV-2026-1043</ref>
			<address>4800 Innovation Drive</address>
			<city>Denver</city>
			<state>CO</state>
			<zip>80202</zip>
			<country>US</country>
			<taxid></taxid>
			<memo>Payment for invoice INV-2026-1043</memo>
			<trans_id></trans_id>
			<fee>0.00</fee>
			<postage_fee>0.00</postage_fee>
			<extra_fee>0.00</extra_fee>
		</payment>
	</payments>
</wmc-response>

Search documentation