GET api/disbursement/getpayments/{clientId}/{fromDate}/{toDate}

Get ACH, Wire and Check payment information for a date range.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client Id	integer	Required
fromDate	From Date	date	Required
toDate	To Date	date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of PaymentInfo

Name	Description	Type	Additional information
VendorPaymentId	Payment Internal unique Id	integer	None.
VendorCode	Vendor Code	string	None.
VendorName	Vendor Name	string	None.
PaymentDate	Payment Date	date	None.
PaymentTotal	Paymetn Total	decimal number	None.
TransmitDate	Transmission Date	date	None.
AckDate	Last acknowledgment date	date	None.
SendDate	Send Date	date	None.
StatusDesc	Status description	string	None.
DCN	Document Control Number	string	None.
Details	Payment details	Collection of Detail	None.
ClientName	Client Name	string	None.
CompanyCode	Company Code	string	None.
CompanyName	Company Name	string	None.
PaymentMethodDesc	Payment Method Description - Wire, ACH, or Check	string	None.
Address1	Payee Address 1	string	None.
Address2	Payeee Address 2	string	None.
City	Payeee City	string	None.
State	Payee State	string	None.
Zip	Payee Zipcode	string	None.
Country	Payee Country	string	None.
AckList	Acknowledgement History and details	Collection of AckResponse	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "VendorPaymentId": 1,
    "VendorCode": "sample string 2",
    "VendorName": "sample string 3",
    "PaymentDate": "2026-09-21T02:47:03.954857-05:00",
    "PaymentTotal": 5.0,
    "TransmitDate": "2026-09-21T02:47:03.954857-05:00",
    "AckDate": "2026-09-21T02:47:03.954857-05:00",
    "SendDate": "2026-09-21T02:47:03.954857-05:00",
    "StatusDesc": "sample string 9",
    "DCN": "sample string 10",
    "Details": [
      {
        "InvoiceNumber": "sample string 1",
        "InvoiceDate": "2026-09-21T02:47:03.954857-05:00",
        "InvoiceAmount": 3.0,
        "DocumentId": 1,
        "DocumentTypeDesc": "sample string 4"
      },
      {
        "InvoiceNumber": "sample string 1",
        "InvoiceDate": "2026-09-21T02:47:03.954857-05:00",
        "InvoiceAmount": 3.0,
        "DocumentId": 1,
        "DocumentTypeDesc": "sample string 4"
      }
    ],
    "ClientName": "sample string 11",
    "CompanyCode": "sample string 12",
    "CompanyName": "sample string 13",
    "PaymentMethodDesc": "sample string 14",
    "Address1": "sample string 15",
    "Address2": "sample string 16",
    "City": "sample string 17",
    "State": "sample string 18",
    "Zip": "sample string 19",
    "Country": "sample string 20",
    "AckList": [
      {
        "RequestID": "sample string 1",
        "Severity": "sample string 2",
        "PaymentReferenceID": "sample string 3",
        "StatusDescription": "sample string 4",
        "AsOfDateTime": "2026-09-21T02:47:03.9598683-05:00",
        "SPReferenceID": "sample string 5",
        "AckRef": "sample string 6",
        "ACHRef": "sample string 7",
        "WireRef": "sample string 8",
        "SWIFTRef": "sample string 9",
        "FedRef": "sample string 10",
        "ErrorDescription": "sample string 11"
      },
      {
        "RequestID": "sample string 1",
        "Severity": "sample string 2",
        "PaymentReferenceID": "sample string 3",
        "StatusDescription": "sample string 4",
        "AsOfDateTime": "2026-09-21T02:47:03.9598683-05:00",
        "SPReferenceID": "sample string 5",
        "AckRef": "sample string 6",
        "ACHRef": "sample string 7",
        "WireRef": "sample string 8",
        "SWIFTRef": "sample string 9",
        "FedRef": "sample string 10",
        "ErrorDescription": "sample string 11"
      }
    ]
  },
  {
    "VendorPaymentId": 1,
    "VendorCode": "sample string 2",
    "VendorName": "sample string 3",
    "PaymentDate": "2026-09-21T02:47:03.954857-05:00",
    "PaymentTotal": 5.0,
    "TransmitDate": "2026-09-21T02:47:03.954857-05:00",
    "AckDate": "2026-09-21T02:47:03.954857-05:00",
    "SendDate": "2026-09-21T02:47:03.954857-05:00",
    "StatusDesc": "sample string 9",
    "DCN": "sample string 10",
    "Details": [
      {
        "InvoiceNumber": "sample string 1",
        "InvoiceDate": "2026-09-21T02:47:03.954857-05:00",
        "InvoiceAmount": 3.0,
        "DocumentId": 1,
        "DocumentTypeDesc": "sample string 4"
      },
      {
        "InvoiceNumber": "sample string 1",
        "InvoiceDate": "2026-09-21T02:47:03.954857-05:00",
        "InvoiceAmount": 3.0,
        "DocumentId": 1,
        "DocumentTypeDesc": "sample string 4"
      }
    ],
    "ClientName": "sample string 11",
    "CompanyCode": "sample string 12",
    "CompanyName": "sample string 13",
    "PaymentMethodDesc": "sample string 14",
    "Address1": "sample string 15",
    "Address2": "sample string 16",
    "City": "sample string 17",
    "State": "sample string 18",
    "Zip": "sample string 19",
    "Country": "sample string 20",
    "AckList": [
      {
        "RequestID": "sample string 1",
        "Severity": "sample string 2",
        "PaymentReferenceID": "sample string 3",
        "StatusDescription": "sample string 4",
        "AsOfDateTime": "2026-09-21T02:47:03.9598683-05:00",
        "SPReferenceID": "sample string 5",
        "AckRef": "sample string 6",
        "ACHRef": "sample string 7",
        "WireRef": "sample string 8",
        "SWIFTRef": "sample string 9",
        "FedRef": "sample string 10",
        "ErrorDescription": "sample string 11"
      },
      {
        "RequestID": "sample string 1",
        "Severity": "sample string 2",
        "PaymentReferenceID": "sample string 3",
        "StatusDescription": "sample string 4",
        "AsOfDateTime": "2026-09-21T02:47:03.9598683-05:00",
        "SPReferenceID": "sample string 5",
        "AckRef": "sample string 6",
        "ACHRef": "sample string 7",
        "WireRef": "sample string 8",
        "SWIFTRef": "sample string 9",
        "FedRef": "sample string 10",
        "ErrorDescription": "sample string 11"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
  <PaymentInfo>
    <AckDate>2026-09-21T02:47:03.954857-05:00</AckDate>
    <AckList>
      <PaymentInfo.AckResponse>
        <ACHRef>sample string 7</ACHRef>
        <AckRef>sample string 6</AckRef>
        <AsOfDateTime>2026-09-21T02:47:03.9598683-05:00</AsOfDateTime>
        <ErrorDescription>sample string 11</ErrorDescription>
        <FedRef>sample string 10</FedRef>
        <PaymentReferenceID>sample string 3</PaymentReferenceID>
        <RequestID>sample string 1</RequestID>
        <SPReferenceID>sample string 5</SPReferenceID>
        <SWIFTRef>sample string 9</SWIFTRef>
        <Severity>sample string 2</Severity>
        <StatusDescription>sample string 4</StatusDescription>
        <WireRef>sample string 8</WireRef>
      </PaymentInfo.AckResponse>
      <PaymentInfo.AckResponse>
        <ACHRef>sample string 7</ACHRef>
        <AckRef>sample string 6</AckRef>
        <AsOfDateTime>2026-09-21T02:47:03.9598683-05:00</AsOfDateTime>
        <ErrorDescription>sample string 11</ErrorDescription>
        <FedRef>sample string 10</FedRef>
        <PaymentReferenceID>sample string 3</PaymentReferenceID>
        <RequestID>sample string 1</RequestID>
        <SPReferenceID>sample string 5</SPReferenceID>
        <SWIFTRef>sample string 9</SWIFTRef>
        <Severity>sample string 2</Severity>
        <StatusDescription>sample string 4</StatusDescription>
        <WireRef>sample string 8</WireRef>
      </PaymentInfo.AckResponse>
    </AckList>
    <Address1>sample string 15</Address1>
    <Address2>sample string 16</Address2>
    <City>sample string 17</City>
    <ClientName>sample string 11</ClientName>
    <CompanyCode>sample string 12</CompanyCode>
    <CompanyName>sample string 13</CompanyName>
    <Country>sample string 20</Country>
    <DCN>sample string 10</DCN>
    <Details>
      <PaymentInfo.Detail>
        <DocumentId>1</DocumentId>
        <DocumentTypeDesc>sample string 4</DocumentTypeDesc>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:47:03.954857-05:00</InvoiceDate>
        <InvoiceNumber>sample string 1</InvoiceNumber>
      </PaymentInfo.Detail>
      <PaymentInfo.Detail>
        <DocumentId>1</DocumentId>
        <DocumentTypeDesc>sample string 4</DocumentTypeDesc>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:47:03.954857-05:00</InvoiceDate>
        <InvoiceNumber>sample string 1</InvoiceNumber>
      </PaymentInfo.Detail>
    </Details>
    <PaymentDate>2026-09-21T02:47:03.954857-05:00</PaymentDate>
    <PaymentMethodDesc>sample string 14</PaymentMethodDesc>
    <PaymentTotal>5</PaymentTotal>
    <SendDate>2026-09-21T02:47:03.954857-05:00</SendDate>
    <State>sample string 18</State>
    <StatusDesc>sample string 9</StatusDesc>
    <TransmitDate>2026-09-21T02:47:03.954857-05:00</TransmitDate>
    <VendorCode>sample string 2</VendorCode>
    <VendorName>sample string 3</VendorName>
    <VendorPaymentId>1</VendorPaymentId>
    <Zip>sample string 19</Zip>
  </PaymentInfo>
  <PaymentInfo>
    <AckDate>2026-09-21T02:47:03.954857-05:00</AckDate>
    <AckList>
      <PaymentInfo.AckResponse>
        <ACHRef>sample string 7</ACHRef>
        <AckRef>sample string 6</AckRef>
        <AsOfDateTime>2026-09-21T02:47:03.9598683-05:00</AsOfDateTime>
        <ErrorDescription>sample string 11</ErrorDescription>
        <FedRef>sample string 10</FedRef>
        <PaymentReferenceID>sample string 3</PaymentReferenceID>
        <RequestID>sample string 1</RequestID>
        <SPReferenceID>sample string 5</SPReferenceID>
        <SWIFTRef>sample string 9</SWIFTRef>
        <Severity>sample string 2</Severity>
        <StatusDescription>sample string 4</StatusDescription>
        <WireRef>sample string 8</WireRef>
      </PaymentInfo.AckResponse>
      <PaymentInfo.AckResponse>
        <ACHRef>sample string 7</ACHRef>
        <AckRef>sample string 6</AckRef>
        <AsOfDateTime>2026-09-21T02:47:03.9598683-05:00</AsOfDateTime>
        <ErrorDescription>sample string 11</ErrorDescription>
        <FedRef>sample string 10</FedRef>
        <PaymentReferenceID>sample string 3</PaymentReferenceID>
        <RequestID>sample string 1</RequestID>
        <SPReferenceID>sample string 5</SPReferenceID>
        <SWIFTRef>sample string 9</SWIFTRef>
        <Severity>sample string 2</Severity>
        <StatusDescription>sample string 4</StatusDescription>
        <WireRef>sample string 8</WireRef>
      </PaymentInfo.AckResponse>
    </AckList>
    <Address1>sample string 15</Address1>
    <Address2>sample string 16</Address2>
    <City>sample string 17</City>
    <ClientName>sample string 11</ClientName>
    <CompanyCode>sample string 12</CompanyCode>
    <CompanyName>sample string 13</CompanyName>
    <Country>sample string 20</Country>
    <DCN>sample string 10</DCN>
    <Details>
      <PaymentInfo.Detail>
        <DocumentId>1</DocumentId>
        <DocumentTypeDesc>sample string 4</DocumentTypeDesc>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:47:03.954857-05:00</InvoiceDate>
        <InvoiceNumber>sample string 1</InvoiceNumber>
      </PaymentInfo.Detail>
      <PaymentInfo.Detail>
        <DocumentId>1</DocumentId>
        <DocumentTypeDesc>sample string 4</DocumentTypeDesc>
        <InvoiceAmount>3</InvoiceAmount>
        <InvoiceDate>2026-09-21T02:47:03.954857-05:00</InvoiceDate>
        <InvoiceNumber>sample string 1</InvoiceNumber>
      </PaymentInfo.Detail>
    </Details>
    <PaymentDate>2026-09-21T02:47:03.954857-05:00</PaymentDate>
    <PaymentMethodDesc>sample string 14</PaymentMethodDesc>
    <PaymentTotal>5</PaymentTotal>
    <SendDate>2026-09-21T02:47:03.954857-05:00</SendDate>
    <State>sample string 18</State>
    <StatusDesc>sample string 9</StatusDesc>
    <TransmitDate>2026-09-21T02:47:03.954857-05:00</TransmitDate>
    <VendorCode>sample string 2</VendorCode>
    <VendorName>sample string 3</VendorName>
    <VendorPaymentId>1</VendorPaymentId>
    <Zip>sample string 19</Zip>
  </PaymentInfo>
</ArrayOfPaymentInfo>