PAYMENTS

Cancel Check

Request cancellation of a check using its payment ID.

Class: payments

Method: cancel-check

POST/payments/cancel-check

Parameters

  • client_id*
  • akey*
  • id* - Unique ID of the check to cancel

Note: The response varies by payment type.

JSON response

JSONResponse example
{
  "payment": {
    "date_submitted": 1553795750,
    "date_updated": 1563232509,
    "date_sent": null,
    "confirmed": true,
    "deleted": false,
    "payee": "Harbor Office Supply LLC",
    "amount": "202.00",
    "date_to_send": 1553795750,
    "id": 5222041,
    "method": {
      "id": 2,
      "name": "Check"
    },
    "status": {
      "id": 7,
      "name": "Cancelled"
    },
    "fee": "0.65",
    "postage_fee": "1.20",
    "extra_fee": "0.00",
    "postage_code": {
      "id": "1",
      "name": "USPS First Class"
    },
    "check_num": "54321",
    "reference": "INV-2026-1042",
    "address": "1250 Market Street",
    "address2": "",
    "city": "Denver",
    "state": "CO",
    "zip": "80202",
    "country": "US",
    "memo": "Payment for invoice INV-2026-1042",
    "insert_pdf_filename": "",
    "taxid": "",
    "logo_file": "northstar-logo.bmp"
  }
}

XML response

XMLResponse example
<wmc-response status="1">
	<payment id='1791977' status='6'>
		<payment_id>1791977</payment_id>
		<client_id>1</client_id>
		<client>Northstar Supply Co.</client>
		<company_name>Northstar Supply Co.</company_name>
		<status_id>7</status_id>
		<status>Cancelled</status>
		<method_id>1</method_id>
		<submit_ts>1413894934</submit_ts>
		<date_submitted>1413894934</date_submitted>
		<date_updated>1413894968</date_updated>
		<date_exported></date_exported>
		<date_sent></date_sent>
		<confirmed>1</confirmed>
		<deleted>0</deleted>
		<payee>Harbor Office Supply LLC</payee>
		<amount>5.00</amount>
		<pay>1</pay>
		<checked_for_duplicates>0</checked_for_duplicates>
		<id>1791977</id>
		<trans_id>PAY-2026-001042</trans_id>
		<mail_to_payee>Harbor Office Supply LLC</mail_to_payee>
		<address>1250 Market Street</address>
		<address2>Suite 200</address2>
		<city>Denver</city>
		<state>CO</state>
		<zip>80202</zip>
		<country>US</country>
		<reference>INV-2026-1042</reference>
		<ref>INV-2026-1042</ref>
		<memo>Payment for invoice INV-2026-1042</memo>
		<payee>Summit Logistics LLC</payee>
		<amount>5.00</amount>
		<bank_name>Example Commercial Bank</bank_name>
		<acct_num>123</acct_num>
		<acct_route>321</acct_route>
		<fee>2.50</fee>
		<postage_fee>0.00</postage_fee>
		<extra_fee>0.00</extra_fee>
	</payment>
</wmc-response>

Search documentation