List Payee Changes

v1.0.0

Get a paginated response listing payee changes (updated since a particular time) to a limited set of fields:

dbaName
displayName
email
onboardedStatus
payeeCountry
payeeId
remoteId

Input

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "format": "int32"
    },
    "pageSize": {
      "type": "integer",
      "format": "int32"
    },
    "payorId": {
      "type": "string",
      "format": "uuid"
    },
    "updatedSince": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "payorId",
    "updatedSince"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "List Payee Changes Response Object",
  "properties": {
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "payeeId",
          "remoteId"
        ],
        "properties": {
          "dbaName": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "onboardedStatus": {
            "type": "string",
            "description": "Payee onboarded status. One of the following value: CREATED, INVITED, REGISTERED, ONBOARDED"
          },
          "payeeCountry": {
            "type": "string",
            "description": "Valid ISO 3166 2 character country code. See the <a href=\"https://www.iso.org/iso-3166-country-codes.html\" target=\"_blank\" a>ISO specification</a> for details."
          },
          "payeeId": {
            "type": "string",
            "format": "uuid"
          },
          "remoteId": {
            "type": "string"
          }
        }
      }
    },
    "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"
        }
      }
    }
  }
}