v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
Payees

List Payee Changes

Use v4 instead

Get a paginated response listing payee changes.

get/v3/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/v3/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/v3/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"
    }
  ]
}