Get Contract Payments (Legacy)

GET 
/v1/open-api/contract-payment/:contractId

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

> ⚠️ Deprecated — use GET /v1/open-api/contract/{id}/payment instead.

This endpoint places the child resource under its own top-level path instead of nesting it under the parent contract's ID. It is kept for existing integrations and stays available until 12 Feb 2027; every response carries Deprecation: true, Sunset: Fri, 12 Feb 2027 00:00:00 GMT and a Link: </v1/open-api/contract/{id}/payment>; rel="successor-version" header.

List a contract's payments (newest first). Both page and size are required query parameters here (unlike the canonical endpoint, which defaults them); size has no upper bound enforced by this legacy endpoint, only the min 20 shown below.

Requires grant PERMISSION_OPEN_API_CONTRACT_PAYMENT:READ.

Request

Responses

200

Page of payments.

400

Validation error (400). Field-level failures are listed in errors[] and error is null; a malformed / unparsable JSON body is the inverse — error.messageCode is 3705 and errors[] is empty.

401

Invalid, revoked or expired token (401) — also returned when the connection was revoked or the company is blocked.

Produced by the authentication filter, so the body is a reduced envelope: no error, no requestId, and errors is null rather than []. Every cause yields the same fixed English message.

403

The token lacks the required permission:scope grant (403).

404

Resource not found (404).

429

Rate limit of 60 requests/minute exceeded (429). Like 401, this comes from the authentication filter: reduced envelope, fixed English message, no error object and no Retry-After header.