PayeesListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/basiq/main/json-schema/basiq-payees-list-response-schema.json",
  "title": "PayeesListResponse",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/basiq-payees-openapi.json#/components/schemas/PayeesListResponse",
  "type": "object",
  "required": [
    "type",
    "data",
    "links"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Always 'list'."
    },
    "count": {
      "type": "integer",
      "description": "The total number of payees available."
    },
    "size": {
      "type": "integer",
      "description": "The number of payees returned in this response."
    },
    "data": {
      "type": "array",
      "description": "Array of payee objects.",
      "items": {
        "$ref": "#/$defs/PayeeSummary"
      }
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string",
          "description": "A link to the current query."
        },
        "next": {
          "type": "string",
          "description": "A link to the next page of results, if available."
        }
      }
    }
  },
  "$defs": {
    "PayeeSummary": {
      "type": "object",
      "required": [
        "type",
        "id",
        "payeeType",
        "links"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Always 'payee'."
        },
        "id": {
          "type": "string",
          "description": "The unique identifier for the payee."
        },
        "nickname": {
          "type": "string",
          "description": "A user-defined nickname for the payee."
        },
        "description": {
          "type": "string",
          "description": "A description of the payee."
        },
        "payeeType": {
          "type": "string",
          "description": "The type of payee.",
          "enum": [
            "domestic",
            "biller",
            "international",
            "digitalWallet"
          ]
        },
        "connectionId": {
          "type": "string",
          "description": "The connection ID associated with this payee."
        },
        "createdDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time when the payee was created."
        },
        "links": {
          "type": "object",
          "properties": {
            "self": {
              "type": "string",
              "description": "A link to the payee details."
            }
          }
        }
      }
    }
  }
}