v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Payments

List pending ACH settlements

Retrieves pending ACH settlements for a specific platform. Used by the platform to reconcile the daily ACH settlement window.

get/payments/settlements

Query parameters

start_dateinteger
Example:1777722086

Inclusive start of the query window as a Unix timestamp in seconds. Defaults to 2 days ago.

end_dateinteger
Example:1777895286

Inclusive end of the query window as a Unix timestamp in seconds. Defaults to now.

platform_codestring required
Example:DEMO01

Platform code to fetch pending settlements for.

pagenumber

Filter for a specific page (pagination)

sizenumber

Filter for the amount of pending ACH transaction objects returned

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved paginated list of pending ACH settlements with optional filters: platform_code, start_date, end_date.

request_idstring uuid

Request identifier echoed back from the request.

pagenumber
page_sizenumber
countnumber

Example response

{
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "message": [
    {
      "processing_window_date": "2026-05-04T00:00:00.000Z",
      "trade_id": "0f34533e-2114-469d-b505-c850d776e061",
      "participant_code": "ABCDEF",
      "amount": "12.01"
    }
  ],
  "page": 1,
  "page_size": 200,
  "count": 10
}