v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Merchants

Clearing:AllLines

A Pay. clearing contains multiple clearing lines. This API returns all clearing lines for a specified period. If you are a partner and you have rights to your merchants you can retrieve the clearing lines also for your merchants

get/clearinglines

Query parameters

limitinteger

Limit the returned records. If not supplied we will default to 100 records

pageinteger

Indicate which page you want in your result set. If not supplied we will default to page 1

eqstring date

Get results that equal the given value

gtstring date

Get results that are greater than the given value

gtestring date

Get results that are greater than or equal to the given value

ltstring date

Get results that are less than the given value

ltestring date

Get results that are less than or equal to the given value

Indicate in which period the transactions are done

{
  "eq": "1999-02-15",
  "gt": "1999-02-15",
  "gte": "1999-02-15",
  "lt": "1999-02-15",
  "lte": "1999-02-15"
}
eqstring date

Get results that equal the given value

gtstring date

Get results that are greater than the given value

gtestring date

Get results that are greater than or equal to the given value

ltstring date

Get results that are less than the given value

ltestring date

Get results that are less than or equal to the given value

Indicate for which period you want to retrieve the clearing lines

{
  "eq": "1999-02-15",
  "gt": "1999-02-15",
  "gte": "1999-02-15",
  "lt": "1999-02-15",
  "lte": "1999-02-15"
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

If you are a partner you can indicate for which merchants you want to retrieve the clearing lines. If you do not supply a merchant we will return the clearing lines for all your merchants

{
  "eq": "M-1234-4321",
  "neq": "M-1234-4321"
}
eqinteger

Get results that equal the given value

You can indicate which lineType you want to retrieve. See for more information the BillingLineTypes API (https://developer.pay.nl/reference/get_billinglinetypes)

{
  "eq": 10
}
eqinteger

Get results that equal the given value

You can indicate for which turnover group you want to retrieve the clearing lines. If not supplied we will return the clearing lines for all turnover groups

eqinteger

Get results that equal the given value

A clearing line has a state. By providing a state you will only retrieve clearing lines in that state

eqinteger

Get results that equal the given value

A clearing line is available on a clearing. By providing a clearing ID you will only retrieve clearing lines for that clearing

Response

Ok.

totalinteger required
countinteger required