---
title: "List Payee Changes"
method: GET
path: "/v4/payees/deltas"
tags: ["Payees"]
---

# List Payee Changes

`GET /v4/payees/deltas`

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

## Query parameters

- `payorId` string, uuid, required
- `updatedSince` string, date-time, required
- `page` integer
- `pageSize` integer

## Response `200`

Details of Payee Changes

- PayeeDeltaResponseV4 — List Payee Changes Response Object
  - `page` PayeeDeltaResponseV3Page
    - `numberOfElements` integer
    - `totalElements` integer
    - `totalPages` integer
    - `page` integer
    - `pageSize` integer
  - `links` PayeeDeltaResponseV4Links[]
    - `rel` string
    - `href` string
  - `content` PayeeDeltaV4[]
    - `remoteId` string, required
    - `payeeId` string, uuid, required
    - `displayName` string
    - `dbaName` string
    - `email` string, email, nullable
    - `payeeCountry` string — 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.
    - `onboardedStatus` string — Payee onboarded status. One of the following value: CREATED, INVITED, REGISTERED, ONBOARDED

## Other responses

- `400` — Bad Request

## Changes

- **2022-06-27** `1e7a1734a45c` — 4 info
  - removed the `CREATED` enum value from the `content/items/onboardedStatus` response property for the response status `200`
  - removed the `INVITED` enum value from the `content/items/onboardedStatus` response property for the response status `200`
  - removed the `ONBOARDED` enum value from the `content/items/onboardedStatus` response property for the response status `200`
  - removed the `REGISTERED` enum value from the `content/items/onboardedStatus` response property for the response status `200`
- **2022-04-07** `da77064fe233` — 1 info
  - the `content/items/payeeCountry` response's property pattern `^[A-Z]{2}$` was added for the status `200`
- **2020-08-13** `75bb7af5ae63` — 1 info
  - endpoint added
- **2019-07-15** `ced8e167a97c` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v4/payees/deltas/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/25a3d8f6e24a?raw)