PAYMENTS

Confirm

Confirm a payment or an uploaded payment file. Review the submitted details before confirming. Additional options are available for bundling checks from an uploaded file.

Class: payments

Method: confirm

POST/payments/confirm

Parameters

  • client_id*
  • akey*
  • item* - Use 'single-PAYMENT ID' for a payment created with payments/add, or 'file-FILE ID' for a file uploaded with payments/upload. Replace the ID with the value returned by that request.

Bundle an uploaded file 

To send an uploaded check file as one package, include the following parameters in the confirmation request. These fields apply to checks only and are unnecessary when the uploaded file already supplies the bundling fields

  • bundle_opt_in* - Set to 1 to bundle the checks
  • bundle_mail_to*  - recipient field used in postage
  • bundle_address*  - address line 1 field used in postage
  • bundle_address_2*  - address line 2 field used in postage
  • bundle_city*  - city field used in postage
  • bundle_state*  - state field used in postage
  • bundle_zip*  - zip field used in postage
  • bundle_country*  - country field used in postage
  • bundle_check_contents*  - Use one of the following values
    • envelope - Select this value to have every check in this bundle enveloped
    • loose - Select this value to have every check in this bundle loose
  • bundle_postal_type  - Use one of the following values when required
    • usps_priority - send via USPS Priority, this is the default postage type if no postage type is provided
    • usps_priority_sig - send via USPS Priority (signature required) - this is not available for International mailing
    • usps_overnight - send via USPS Overnight (express)
    • fedex_2day - send via FedEx Express 2 Day
    • fedex_overnight - send via FedEx Express Overnight
    • fedex_priority_overnight - send via FedEx Priority Overnight
  • bundle_custom_account_number  - Your FedEx account number, when using your own shipping account
  • bundle_custom_alert_email  - if opting to use your own FedEx account number, you may also send an alert email address in this field
  • bundle_custom_alert_email2  - if opting to use your own FedEx account number, you may also send a second alert email address in this field
  • bundle_custom_alert_email3  - if opting to use your own FedEx account number, you may also send a third alert email address in this field
  • bundle_custom_recipient_phone  - Optional custom recipient phone number (printed on the shipping label)
  • bundle_custom_customer_reference  - Optional custom customer reference (printed on the shipping label)
  • bundle_custom_sender_contact  - Optional custom sender contact (printed on the shipping label)
  • bundle_custom_sender_company  - Optional custom sender company (printed on the shipping label)
  • bundle_custom_sender_address  - Optional custom sender address (printed on the shipping label)
  • bundle_custom_sender_city  - Optional custom sender city (printed on the shipping label)
  • bundle_custom_sender_state  - Optional custom sender state (printed on the shipping label)
  • bundle_custom_sender_zip  - Optional custom sender zip (printed on the shipping label)
  • bundle_custom_sender_phone  - Optional custom sender phone number (printed on the shipping label)

JSON response

JSONResponse example
{
  "payments": [
    {
      "date_submitted": 1563234091,
      "date_updated": null,
      "date_sent": null,
      "confirmed": true,
      "deleted": false,
      "payee": "Harbor Office Supply LLC",
      "amount": "1.00",
      "date_to_send": 1563234091,
      "id": 5813096,
      "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": 1563234091,
      "date_updated": null,
      "date_sent": null,
      "confirmed": true,
      "deleted": false,
      "payee": "Summit Logistics LLC",
      "amount": "1.00",
      "date_to_send": 1563234091,
      "id": 5813097,
      "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">
	<payments>
		<payment id='1309164' status='0'>
			<payment_id>1309164</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>5</method_id>
			<submit_ts>1378436261</submit_ts>
			<date_submitted>1378436261</date_submitted>
			<date_updated></date_updated>
			<date_exported></date_exported>
			<date_sent></date_sent>
			<confirmed>1</confirmed>
			<deleted>0</deleted>
			<payee>Harbor Office Supply LLC</payee>
			<amount>555.55</amount>
			<pay>1</pay>
			<id>1309164</id>
			<acct_num>123456789</acct_num>
			<acct_route>036001808</acct_route>
			<additional_info></additional_info>
			<address>1250 Market Street</address>
			<address2></address2>
			<bank_country>US</bank_country>
			<bank_name>Example Commercial Bank</bank_name>
			<bank_route></bank_route>
			<acct_name>Jordan Morgan</acct_name>
			<branch_info></branch_info>
			<city>Denver</city>
			<trans_id>PAY-2026-001042</trans_id>
			<corr_bank_acct></corr_bank_acct>
			<corr_bank_city></corr_bank_city>
			<corr_bank_country></corr_bank_country>
			<corr_bank_name></corr_bank_name>
			<corr_bank_swift></corr_bank_swift>
			<country>US</country>
			<first_name></first_name>
			<iban></iban>
			<last_name></last_name>
			<notes></notes>
			<payee_email></payee_email>
			<payment_type></payment_type>
			<reference>INV-2026-1042</reference>
			<ref>INV-2026-1042</ref>
			<sort_code></sort_code>
			<taxid></taxid>
			<state>CO</state>
			<swift_code></swift_code>
			<zip>80202</zip>
			<fee>0.00</fee>
			<postage_fee>0.00</postage_fee>
			<extra_fee>0.00</extra_fee>
		</payment>
		<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>1</confirmed>
			<deleted>0</deleted>
			<payee>Summit Logistics 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>4800 Innovation Drive</address>
			<address2></address2>
			<bank_name>Example Commercial Bank</bank_name>
			<city>Denver</city>
			<trans_id>PAY-2026-001043</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-1043</reference>
			<ref>INV-2026-1043</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>
		<payment id='1309163' status='0'>
			<payment_id>1309163</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>3</method_id>
			<submit_ts>1378435790</submit_ts>
			<date_submitted>1378435790</date_submitted>
			<date_updated></date_updated>
			<date_exported></date_exported>
			<date_sent></date_sent>
			<confirmed>1</confirmed>
			<deleted>0</deleted>
			<payee>Cedar Ridge Consulting LLC</payee>
			<amount>550.00</amount>
			<pay>1</pay>
			<id>1309163</id>
			<trans_id>PAY-2026-001044</trans_id>
			<first_name></first_name>
			<last_name></last_name>
			<notes></notes>
			<payee_email></payee_email>
			<payment_type></payment_type>
			<taxid></taxid>
			<fee>0.00</fee>
			<postage_fee>0.00</postage_fee>
			<extra_fee>0.00</extra_fee>
		</payment>
	</payments>
</wmc-response>

Search documentation