Get Settlement Details

Overview

The "Settlement Details" API endpoint offers detailed insights into individual payment items for a specific settlement. It is crucial for software applications to provide detailed breakdowns of settlement activity.

🚧
Get settled
You need a SettlementID from the Get Settlements endpoint before making requests to this service.

Features

Detailed Transaction Breakdown: Provides a comprehensive list of individual payment items within a settlement.
Efficient Reconciliation: Enhances the reconciliation process within your software application, reducing the need for external tools.
Financial Clarity and Accuracy: Assists in maintaining precise financial records by linking payment details with settlements.

Fields and Values

All API requests should include fields detailed in the General Implementation Rules

📘
Unlike other API endpoints, you don't need to pass in specific Merchant API credentials to interact with this endpoint
More format details can be found on the API Reference page

Request Fields

The following values are specific to retrieving settlement report details:

Field Name	Usage	Field Value Format Constraints	Max Length
Command	Required	Set to ECheckReports.GetSettlementItems	-
SettlementID	Required	Unique identifier for the settlement to be queried.	50
PageSize	Optional	Number of items per page (up to 500 max)	3
PageNumber	Optional	Page number for the report	3

Request Sample

{
  "ProviderID": "99",
  "Provider_GateID": "test",
  "Provider_GateKey": "test",
  "Command": "ECheckReports.GetSettlementItems",
  "CommandVersion": "2.0",
  "SettlementID": "64b7811c-f631-4bc6-9eaf-d2f45356cf9e",
  "PageNumber": "1",
  "PageSize": "500"
}

Response Fields

The ResponseData field in the API response will contain a nested JSON object where the parent object is a slightly modified Settlement object that contains all of the summary details of the settlement, some paging information, and an array of SettlementItems object showing relevant details of the payments that make up the settlement.

Parent Object Fields

Field Name	Type/Format	Description
SettlementID	String (UUID format)	Unique identifier for the specific settlement
MerchantID	String	ACHQ merchant account identifier
SettlementType	String	Type of settlement (e.g., ACH Debits, ACH Credits)
Amount	Decimal	Total amount of the settlement
PaymentDirection	String ("Credit" or "Debit")	Indicates funds transfer direction
ItemCount	Integer	Number of payment items in the settlement
BankDescriptorID	String	Funds transfer ID on the bank statement
PageNumber	Integer	Page number of the returned items
PageSize	Integer	Number of items per page in the response
SettlementItems	JSON Array	Array of individual SettlementItems objects

SettlementItems Object Fields

Field Name	Type/Format	Description
Transact_ReferenceID	String	Unique ID for the payment item
CustomerName	String	Customer name associated with the payment
Company	String	Company name associated with the payment
ProcessDate	String (ISO 8601 Date)	Date of Federal Reserve processing
SameDayACH	Boolean	Indicates if processed as Same-Day ACH
Amount	Decimal	Amount of the payment
PaymentDirection	String	Direction of payment (FromCustomer or ToCustomer)
Description	String	Description of the payment
MerchantReferenceID	String	Internal identifier for the payment
Provider_TransactionID	String	Identifier assigned by Platform Provider

👍
Payments all the way down
Use Transact_ReferenceID/MerchantReferenceID /Provider_TransactionID to correlate settlement items to existing payment records in your database

Response Sample

{
  "CommandStatus": "Approved",
  "Description": "Command Successful. Approved.",
  "ErrorInformation": null,
  "ExpressVerify": {
    "Status": null,
    "Code": null,
    "Description": null
  },
  "ResponseData": {
    "SettlementID": "3d5608cd-af70-4009-83d2-7234f1a6d72b",
    "MerchantID":" 2001",
    "SettlementType": "Settlement for ACH Debits",
    "Amount": 52874.72,
    "PaymentDirection": "Credit",
    "ItemCount": 21,
    "BankDescriptorID": null,
    "PageNumber": 1,
    "PageSize": 2,
    "SettlementItems": [
      {
        "Transact_ReferenceID": "18127667",
        "CustomerName": "Alberta Smith",
        "Company": null,
        "ProcessDate": "2023-11-20T00:00:00",
        "SameDayACH": false,
        "Amount": 623.67,
        "PaymentDirection": "FromCustomer",
        "Description": null,
        "MerchantReferenceID": "8c01e663-0490-408e-9760-0deb081c12ed",
        "Provider_TransactionID": null
      },
      {
        "Transact_ReferenceID": "18147421",
        "CustomerName": "John Doe",
        "Company": null,
        "ProcessDate": "2023-11-20T00:00:00",
        "SameDayACH": false,
        "Amount": 291.67,
        "PaymentDirection": "FromCustomer",
        "Description": null,
        "MerchantReferenceID": "e9f2c35e-1004-409f-8d16-b5891e3b2c62",
        "Provider_TransactionID": null
      }
    ]
  },
  "ACHQToken": null,
  "Provider_TransactionID": null,
  "TransAct_ReferenceID": "19064342"
}

👍
Full API reference here

Get Settlement Details

Overview

🚧
Get settled

Features

Fields and Values

📘
Unlike other API endpoints, you don't need to pass in specific Merchant API credentials to interact with this endpoint

Request Fields

Request Sample

Response Fields

Parent Object Fields

SettlementItems Object Fields

👍
Payments all the way down

Response Sample

👍
Full API reference here

Overview

🚧Get settled

Features

Fields and Values

📘Unlike other API endpoints, you don't need to pass in specific Merchant API credentials to interact with this endpoint

Request Fields

Request Sample

Response Fields

Parent Object Fields

SettlementItems Object Fields

👍Payments all the way down

Response Sample

👍Full API reference here

🚧
Get settled

📘
Unlike other API endpoints, you don't need to pass in specific Merchant API credentials to interact with this endpoint

👍
Payments all the way down

👍
Full API reference here