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

Payments required— unresolved $ref

Changes

Changed in 12 of the 53 revisions of this API.5223

Feb 13, 20248ba9a6a9b56a9See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Oct 23, 2023638d28ff67734See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
Oct 17, 20232d6130f9134f1See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Oct 9, 2023a38e98c5cae612See the full diff
- ▲
  the //// response's property type changed from no type to object for status
  response-property-type-changed
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
Sep 1, 2023aa7afdde930821See the full diff
- ▲
  the //// response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property ///// from the response with the status
  response-required-property-removed
- ●
  removed the optional property ///// from the response with the status
  response-optional-property-removed
Jul 6, 2023f5898440c7ad1See the full diff
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
Jul 4, 2023494a393d5cec1See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
May 31, 2023da0aba4733ac1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 25, 2023be0826c6d38f4See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
May 19, 2023753db470ad5a1See the full diff
- ○
  the query request parameter page became optional
  request-parameter-became-optional

Full history (12 revisions)