Get Payee Invitation Status

v1.0.0

Use v4 instead

Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.

Input

{
  "type": "object",
  "properties": {
    "invitationStatus": {
      "type": "string"
    },
    "page": {
      "type": "integer",
      "format": "int32"
    },
    "pageSize": {
      "type": "integer",
      "format": "int32"
    },
    "payeeId": {
      "type": "string",
      "format": "uuid"
    },
    "payorId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "payorId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "List Payees Invitation Status Object",
  "properties": {
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "invitationStatus",
          "payeeId"
        ],
        "properties": {
          "gracePeriodEndDate": {
            "type": "string",
            "format": "date"
          },
          "invitationStatus": {
            "type": "string",
            "description": "Payee invitation status. One of the following values: ACCEPTED, PENDING, DECLINED"
          },
          "payeeId": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    },
    "links": {
      "type": "array",
      "items": {
        "properties": {
          "href": {
            "type": "string"
          },
          "rel": {
            "type": "string"
          }
        }
      }
    },
    "page": {
      "properties": {
        "numberOfElements": {
          "type": "integer"
        },
        "page": {
          "type": "integer"
        },
        "pageSize": {
          "type": "integer"
        },
        "totalElements": {
          "type": "integer"
        },
        "totalPages": {
          "type": "integer"
        }
      }
    }
  }
}