---
updatedAt: 2026-06-08T11:05:39.000Z
agentTools:
  projectIndex: https://developer.pay.nl/llms.txt
---

# ClearingLineTypes

A Pay. clearing contains multiple clearing lines which are grouped. This API returns all groups that we have available, including a description of the clearing lines that can appear in that group

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "PAY. Global Management System API's",
    "description": "A restful journey to your payments.",
    "termsOfService": "https://www.pay.nl/en/terms-conditions",
    "contact": {
      "email": "support@pay.nl"
    },
    "version": "v2.0"
  },
  "servers": [
    {
      "url": "https://rest.pay.nl/v2",
      "description": "PAY. API server"
    }
  ],
  "paths": {
    "/clearinglinetypes": {
      "get": {
        "tags": [
          "Core Data"
        ],
        "summary": "ClearingLineTypes",
        "description": "A Pay. clearing contains multiple clearing lines which are grouped. This API returns all groups that we have available, including a description of the clearing lines that can appear in that group",
        "responses": {
          "200": {
            "description": "Ok.",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "total",
                    "clearingDataGroups",
                    "_links"
                  ],
                  "properties": {
                    "total": {
                      "type": "integer"
                    },
                    "clearingDataGroups": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ClearingDataGroup"
                      }
                    },
                    "_links": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Link"
                      }
                    }
                  },
                  "type": "object"
                },
                "examples": {
                  "success": {
                    "$ref": "#/components/examples/ClearingLineTypesResponse200Successful"
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "405": {
            "$ref": "#/components/responses/MethodNotAllowed"
          },
          "406": {
            "$ref": "#/components/responses/NotAcceptable"
          },
          "429": {
            "$ref": "#/components/responses/RateLimiting"
          },
          "500": {
            "description": "An internal error occurred"
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ClearingDataGroup": {
        "required": [
          "id",
          "name",
          "translations",
          "clearingLineTypes",
          "createdAt",
          "modifiedAt",
          "deletedAt"
        ],
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "translations": {
            "$ref": "#/components/schemas/Universal/properties/translations"
          },
          "clearingLineTypes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LineType"
            }
          },
          "createdAt": {
            "$ref": "#/components/schemas/Universal/properties/createdAt"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Universal/properties/modifiedAt"
          },
          "deletedAt": {
            "$ref": "#/components/schemas/Universal/properties/deletedAt"
          }
        },
        "type": "object"
      },
      "LineType": {
        "required": [
          "id",
          "name",
          "translations",
          "createdAt",
          "modifiedAt",
          "deletedAt"
        ],
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "translations": {
            "$ref": "#/components/schemas/Universal/properties/translations"
          },
          "createdAt": {
            "$ref": "#/components/schemas/Universal/properties/createdAt"
          },
          "modifiedAt": {
            "$ref": "#/components/schemas/Universal/properties/modifiedAt"
          },
          "deletedAt": {
            "$ref": "#/components/schemas/Universal/properties/deletedAt"
          }
        },
        "type": "object"
      },
      "Link": {
        "required": [
          "href",
          "rel",
          "type"
        ],
        "properties": {
          "href": {
            "description": "",
            "type": "string",
            "readOnly": true,
            "example": "",
            "nullable": false
          },
          "rel": {
            "description": "",
            "type": "string",
            "readOnly": true,
            "example": "",
            "nullable": false
          },
          "type": {
            "description": "",
            "type": "string",
            "readOnly": true,
            "example": "",
            "nullable": false
          }
        },
        "type": "object"
      },
      "Universal": {
        "properties": {
          "translations": {
            "description": "Object containing all the translations with the property name in which the corresponds with a property on the object itself.",
            "type": "object",
            "uniqueItems": true,
            "example": "\n    \"translations\": {\n      \"name\": {\n        ...\n      },\n      \"description\": {\n        ...\n      }\n    }\n",
            "nullable": true,
            "additionalProperties": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            }
          },
          "requiredFields": {
            "description": "The required fields of the payment method.",
            "type": "array",
            "items": {
              "properties": {
                "fieldName": {
                  "type": "string"
                },
                "mandatory": {
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "createdAt": {
            "description": "The creation date time presented in the correct ISO-8601 (a.k.a. ATOM) notation",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2016-06-04T08:15:00+01:00",
            "nullable": false
          },
          "createdBy": {
            "description": "The reference to an account or token whom created the entity",
            "type": "string",
            "pattern": "^A(T)?(-\\d{4}){2}$",
            "readOnly": true,
            "example": "A-1234-4321",
            "nullable": false
          },
          "modifiedAt": {
            "description": "The modification date time presented in the correct ISO-8601 (a.k.a. ATOM) notation",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2016-06-04T08:15:00+01:00",
            "nullable": true
          },
          "modifiedBy": {
            "description": "The reference to an account or token whom modified the entity",
            "type": "string",
            "pattern": "^A(T)?(-\\d{4}){2}$",
            "readOnly": true,
            "example": "A-1234-4321",
            "nullable": true
          },
          "deletedAt": {
            "description": "The deletion date time presented in the correct ISO-8601 (a.k.a. ATOM) notation. Can be empty (null)",
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "example": "2016-06-04T08:15:00+01:00",
            "nullable": true
          },
          "deletedBy": {
            "description": "The reference to an account or token whom deleted the entity",
            "type": "string",
            "pattern": "^A(T)?(-\\d{4}){2}$",
            "readOnly": true,
            "example": "A-1234-4321",
            "nullable": true
          }
        },
        "type": "object"
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Unauthorized. Supplied credentials are invalid"
      },
      "Forbidden": {
        "description": "Forbidden. Supplied credentials have no rights"
      },
      "MethodNotAllowed": {
        "description": "Used HTTP method is not allowed"
      },
      "NotAcceptable": {
        "description": "Not acceptable. The supplied content type in the accept parameter in the header is not supported"
      },
      "RateLimiting": {
        "description": "Rate limit reached."
      }
    },
    "examples": {
      "ClearingLineTypesResponse200Successful": {
        "summary": "Get clearing line types",
        "value": {
          "total": 1,
          "clearingDataGroups": [
            {
              "id": 1,
              "name": "Transaction processing",
              "translations": {
                "name": {
                  "nl_NL": "Transactionverwerking",
                  "en_GB": "Transaction processing"
                }
              },
              "clearingLineTypes": [
                {
                  "id": "10",
                  "name": "iDeal",
                  "translations": {
                    "name": {
                      "nl_NL": "iDeal",
                      "en_GB": "iDeal"
                    }
                  },
                  "createdAt": "2022-03-18T14:35:21+02:00",
                  "modifiedAt": "2022-03-18T15:24:52+02:00",
                  "deletedAt": null
                }
              ],
              "createdAt": "2022-03-18T14:35:21+02:00",
              "modifiedAt": "2022-03-18T15:24:52+02:00",
              "deletedAt": null
            }
          ],
          "_links": [
            {
              "url": "/clearinglinetypes",
              "rel": "self",
              "type": "GET"
            }
          ]
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "tags": [
    {
      "name": "Core Data",
      "description": ""
    }
  ],
  "externalDocs": {
    "description": "Official PAY. documentation",
    "url": "https://docs.pay.nl"
  }
}
```