Checkalt Clearingworks IR API Specifications - OpenAPI 3.1 (5.03.2)

Download OpenAPI specification:Download

This is the Open API specifications for the Clearingworks IR product.

AR Posting

The AR Posting Service provides a query for the AR Posting data for a given merchant and time range. The AR Posting data represents the information used to post payments to the merchant's ERP or accounting system, generally including the date the payment was processed, the customer's account number and applied payment amount. The information included in a given date range is the AR Posting data that was marked for inclusion in the AR Model for that date range and matches to the information included in reports and extracts for that same date range.

Get AR posting data

Get AR Posting data for the given business unit

SecurityJWT
Request
Request Body schema:
billerBusUnitId
string

Biller ID of the business unit

busUnitId
required
integer <int32>

Business Unit

busUnitName
string

Business Unit name

externalBusUnitId
string

External ID of the business unit

required
object

Transaction Commit Date

Responses
200

Success

400

Bad request

500

Internal Server Error

post/cw/posting/arPostingData
Request samples
{
  • "billerBusUnitId": "string",
  • "busUnitId": 0,
  • "busUnitName": "string",
  • "externalBusUnitId": "string",
  • "transactionCommitDate": {
    }
}
Response samples
{
  • "rows": [
    ],
  • "totalCount": 0
}