latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-042131317.4 KB

c56aa8f7d9f2

Payments

List payments

The List payments endpoint returns a list of payments for a given company's connection.

Payments contain details of all payments made by customers to the company.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/connections/{connectionId}/data/commerce-payments

Query parameters

pageinteger
Example:1

Page number. Read more.

pageSizeinteger
Example:100

Number of records to return in a page. Read more.

querystring

Codat query string. Read more.

orderBystring
Example:-modifiedDate

Field to order results by. Read more.

Response

OK

Payments required— unresolved $ref