PAYMENTS

Get Payment List

Retrieve a paginated list of payments, including status and tracking information. Combine the available filters to locate payments by date, recipient, bank account, reference, or other criteria.

Class: payments

Method: get-payment-list

POST/payments/get-payment-list

Parameters

  • client_id*
  • akey*
  • page - Page number to retrieve. Defaults to 1
  • per_page - Number of results per page, up to a maximum of 50
  • address - Address to filter by (likeness search)
  • amount - Amount to filter by, numeric/decimal only
  • bank_account_id - Bank Account ID to filter by, numeric only
  • check_num - Check Number to filter by, numeric only
  • trans_id - Client Transaction ID to filter by (likeness search)
  • date_submitted - used to filter by an exact Date Submitted (singular, mm/dd/yyyy format)
  • date_submitted_from - used in combination with the to field for a Date Submitted range filter (mm/dd/yyyy format)
  • date_submitted_to - used in combination with the from field for a Date Submitted range filter (mm/dd/yyyy format)
  • date_sent - used to filter by an exact Date Sent (singular, mm/dd/yyyy format)
  • date_sent_from - used in combination with the to field for a Date Sent range filter (mm/dd/yyyy format)
  • date_sent_to - used in combination with the from field for a Date Sent range filter (mm/dd/yyyy format)
  • date_updated - used to filter by an exact Date Updated (singular, mm/dd/yyyy format)
  • date_updated_from - used in combination with the to field for a Date Updated range filter (mm/dd/yyyy format)
  • date_updated_to - used in combination with the from field for a Date Updated range filter (mm/dd/yyyy format)
  • method_id - Method ID to filter by, numeric only
    • 1 - ACH
    • 2 - Check
  • notes - Notes to filter by (likeness search)
  • payee - Payee to filter by (likeness search)
  • payment_id / id - Payment ID to filter by, numeric only
  • postage_code - Postage Code to filter by, numeric only
    • 1 - USPS First Class
    • 2 - USPS Priority
    • 3 - USPS Priority + Delivery Confirmation
    • 5 - FedEx Express 2 Day
    • 6 - FedEx Express Overnight
    • 8 - USPS Overnight
    • 9 - USPS Certified Mail
    • 10 - FedEx Priority Overnight
  • reference - Reference to filter by (likeness search)
  • status_id - Status ID to filter by, numeric only
    • 1 - Pending Release
    • 2 - Released
    • 3 - Processing
    • 4 - Sent Out
    • 5 - Posted / Cashed
    • 6 - Returned
    • 7 - Cancelled
    • 8 - Reissued

Combine filters to narrow the results. Use the pagination information returned in the response to retrieve additional pages.

JSON response

JSONResponse example
{
  "page_data": {
    "page": "1",
    "page_count": 1,
    "per_page": 50,
    "payment_count": "2"
  },
  "payments": [
    {
      "id": "1",
      "date_submitted": 1583336318,
      "date_updated": 1583339204,
      "date_sent": 1583339203,
      "confirmed": true,
      "deleted": false,
      "payee": "Harbor Office Supply LLC",
      "amount": "1.00",
      "method": {
        "id": "2",
        "name": "Check"
      },
      "status": {
        "id": "4",
        "name": "Sent Out"
      },
      "trans_id": "PAY-2026-001042",
      "check_num": "1",
      "reference": "INV-2026-1042",
      "address": "1250 Market Street",
      "city": "Denver",
      "state": "CO",
      "zip": "80202",
      "country": "US",
      "postage_code": {
        "id": "1",
        "name": "USPS First Class"
      },
      "bank_account_id": "1"
    },
    {
      "id": "1",
      "date_submitted": 1583336318,
      "date_updated": 1583339204,
      "date_sent": 1583339203,
      "confirmed": true,
      "deleted": false,
      "payee": "Summit Logistics LLC",
      "amount": "2.00",
      "method": {
        "id": "2",
        "name": "Check"
      },
      "status": {
        "id": "4",
        "name": "Sent Out"
      },
      "trans_id": "PAY-2026-001043",
      "check_num": "2",
      "reference": "INV-2026-1043",
      "address": "4800 Innovation Drive",
      "city": "Denver",
      "state": "CO",
      "zip": "80202",
      "country": "US",
      "postage_code": {
        "id": "3",
        "name": "USPS Priority + Delivery Confirmation"
      },
      "bank_account_id": "1",
      "tracking": "123456789"
    }
  ]
}

XML response

XMLResponse example
<wmc-response status="1">
	<page_data>
		<page>1</page>
		<page_count>1</page_count>
		<per_page>50</per_page>
		<payment_count>2</payment_count>
	</page_data>
	<payments>
		<payment id='1' status='4'>
			<payment_id>1</payment_id>
			<client_id>1</client_id>
			<client>Northstar Supply Co.</client>
			<company_name>Northstar Supply Co.</company_name>
			<status_id>4</status_id>
			<status>Sent Out</status>
			<method_id>2</method_id>
			<submit_ts>1583336318</submit_ts>
			<date_submitted>1583336318</date_submitted>
			<date_updated>1583336318</date_updated>
			<date_sent>1583339203</date_sent>
			<confirmed>1</confirmed>
			<deleted>0</deleted>
			<payee>Harbor Office Supply LLC</payee>
			<amount>1.00</amount>
			<trans_id>PAY-2026-001042</trans_id>
			<check_num>1</check_num>
			<reference>INV-2026-1042</reference>
			<address>1250 Market Street</address>
			<city>Denver</city>
			<state>CO</state>
			<zip>80202</zip>
			<country>US</country>
			<postage_code>1</postage_code>
			<bank_account_id>1</bank_account_id>
		</payment>
		<payment id='2' status='4'>
			<payment_id>2</payment_id>
			<client_id>1</client_id>
			<client>Northstar Supply Co.</client>
			<company_name>Northstar Supply Co.</company_name>
			<status_id>4</status_id>
			<status>Sent Out</status>
			<method_id>2</method_id>
			<submit_ts>1583336318</submit_ts>
			<date_submitted>1583336318</date_submitted>
			<date_updated>1583336318</date_updated>
			<date_sent>1583339203</date_sent>
			<confirmed>1</confirmed>
			<deleted>0</deleted>
			<payee>Summit Logistics LLC</payee>
			<amount>2.00</amount>
			<trans_id>PAY-2026-001043</trans_id>
			<check_num>2</check_num>
			<reference>INV-2026-1043</reference>
			<address>4800 Innovation Drive</address>
			<city>Denver</city>
			<state>CO</state>
			<zip>80202</zip>
			<country>US</country>
			<postage_code>3</postage_code>
			<bank_account_id>1</bank_account_id>
			<tracking>123456789</tracking>
		</payment>
	</payments>
</wmc-response>

Search documentation