Sign in
Payees

List Payee Changes

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
get/v4/payees/deltas

Query parameters

payorIdstring uuid required

The Payor ID to find associated Payees

updatedSincestring date-time required

The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm

pageinteger
Example:1

Page number. Default is 1.

pageSizeinteger
Example:100

Page size. Default is 100. Max allowable is 1000.

Response

Details of Payee Changes

Example response

{
  "links": [
    {
      "rel": "first",
      "href": "http://api.sandbox.velopayments.com/v4/payees/deltas?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000"
    },
    {
      "rel": "first",
      "href": "http://api.sandbox.velopayments.com/v4/payees/deltas?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000"
    }
  ],
  "page": {
    "numberOfElements": 2,
    "totalPages": 1,
    "pageSize": 25,
    "page": 1,
    "totalElements": 2
  },
  "content": [
    {
      "payeeCountry": "US",
      "displayName": "Payee1",
      "onboardedStatus": "onboardedStatus",
      "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dbaName": "Payee DBA Name",
      "email": "payee1@example.com",
      "remoteId": "payee_1"
    },
    {
      "payeeCountry": "US",
      "displayName": "Payee1",
      "onboardedStatus": "onboardedStatus",
      "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dbaName": "Payee DBA Name",
      "email": "payee1@example.com",
      "remoteId": "payee_1"
    }
  ]
}

Changes

Changed in 5 of the 50 revisions of this API.17

  • b924ba134e091See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1e7a1734a45c4See the full diff
    • ○

      removed the CREATED enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INVITED enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the ONBOARDED enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the REGISTERED enum value from the // response property for the response status

      response-property-enum-value-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • da77064fe2331See the full diff
    • ○

      the // response's property pattern ^[A-Z]{2}$ was added for the status

      response-property-pattern-added

    This revision also has 76 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 75bb7af5ae631See the full diff
    • ○

      endpoint added

      endpoint-added

  • ced8e167a97c1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog