Upload Labeled Batch

Suggest Edits

---

Overview

Uploads a batch of checks using a bank token. This endpoint allows you to submit multiple check payment requests in a single batch operation.

---

Resource Access

Production (api.ahrvo.network)

POST https://api.ahrvo.network/banking/echecks/apiServices/uploadChecks.php?UploadLabeledBatch

Staging (gateway.ahrvo.network)

POST https://gateway.ahrvo.network/banking/echecks/apiServices/uploadChecks.php?UploadLabeledBatch

---

Arguments

Attribute	Mandatory / Optional
merchantUploadRequestID	Mandatory
bankToken	Mandatory
paymentList	Mandatory
paymentList[].FirstName	Mandatory
paymentList[].LastName	Mandatory
paymentList[].Address	Mandatory
paymentList[].City	Mandatory
paymentList[].StateCode	Conditional¹
paymentList[].State	Conditional²
paymentList[].Zip	Mandatory
paymentList[].CountryCode	Mandatory
paymentList[].Amount	Mandatory
paymentList[].SendBy	Mandatory
paymentList[].Company	Optional
paymentList[].RefID	Optional
paymentList[].Phone	Conditional³
paymentList[].PrintOnCheckName	Optional
paymentList[].CheckNumber	Optional
paymentList[].CheckPaymentDate	Optional
paymentList[].Memo	Optional
paymentList[].MessageOnCheck	Optional
paymentList[].MerchantTransID	Optional
paymentList[].DocumentToken	Optional

^{¹ Required for US and Canada.
² Required except for US and Canada.
³ Required for FedEx and USPS deliveries.}

---

Example Request

curl -X POST https://gateway.ahrvo.network/banking/echecks/apiServices/uploadChecks.php?UploadLabeledBatch \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {jwtToken}" \
  -H "x-api-key: {apiKey}" \
  -d '{
    "merchantUploadRequestID": "your-own-RequestID-123048",
    "bankToken": "token-from-GetBankList",
    "paymentList": [
      {
        "FirstName": "Amalthea",
        "LastName": "Tethys",
        "Address": "2600 Benjamin Franklin Pkwy",
        "City": "Philadelphia",
        "StateCode": "PA",
        "Zip": "19130-2302",
        "CountryCode": "US",
        "Amount": "120.05",
        "SendBy": "Mail",
        "RefID": "REF-1502367",
        "Phone": "1234567890",
        "Memo": "Refund for Payment#1230",
        "MerchantTransID": "your-own-transaction-id-001"
      }
    ]
  }'

---

Example Response

{
  "batchID": 320851,
  "errorCode": 0,
  "errorMessage": "",
  "serviceFeeSubTotal": "240.25",
  "federalTax": "0.00",
  "provincialTax": "0.00",
  "serviceFeeGrandTotal": "240.25",
  "uploadedChecksInfo": [
    {
      "Company": "",
      "FirstName": "Amalthea",
      "LastName": "Tethys",
      "CheckNumber": "1001",
      "RefID": "REF-1502367",
      "MerchantTransID": "mtid-50021",
      "CheckTransID": "15208880",
      "BundleID": "320851-1",
      "Amount": "120.05",
      "CheckPaymentDate": "2025-05-25",
      "SendBy": "Mail",
      "UploadErrorCode": "0",
      "UploadErrorMessage": "",
      "UploadStatus": "Accepted",
      "ServiceFee": "1.99"
    }
  ]
}

---

API Documentation

---