v1

latestOpenAPI 3.0.32026-07-24164965.8 KB
api

Contract List

An endpoint to list the details of all applications for a given merchant. If external_contract_uuid is supplied, other filters will be ignored. If start_date or end_date are supplied, they must be supplied together. If confirmed_start_date or confirmed_end_date are supplied, they must be supplied together.

get/api/checkout/v1/applications/

Query parameters

confirmed_end_datestring date

the contract confirm end date to filter by

confirmed_start_datestring date

the contract confirm start date to filter by

end_datestring date

the end date to filter by

external_contract_uuidstring uuid

The external contract uuid associated to the application

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

start_datestring date

the start date to filter by

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}