VEvelopaymentsapi
Payee Invitation

Get Payee Invitation Status

Changed on

Use v4 instead

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

get/v3/payees/payors/{payorId}/invitationStatus

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

Path parameters

payorIdstring uuid required
Example:9ac75325-5dcd-42d5-b992-175d7e0a035e

The account owner Payor ID

Query parameters

payeeIdstring uuid
Example:2aa5d7e0-2ecb-403f-8494-1865ed0454e9

The UUID of the payee.

invitationStatusstring

The invitation status of the payees.

pageinteger
Example:1

Page number. Default is 1.

pageSizeinteger
Example:25

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

Response

Get Payees with Invitaion status - filters of payeeId and invitationStatus

Example response

{
  "links": [
    {
      "rel": "rel",
      "href": "href"
    },
    {
      "rel": "rel",
      "href": "href"
    }
  ],
  "page": {
    "numberOfElements": 0,
    "totalPages": 1,
    "pageSize": 5,
    "page": 5,
    "totalElements": 6
  },
  "content": [
    {
      "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
      "gracePeriodEndDate": "2019-01-20T00:00:00.000+0000",
      "invitationStatus": "invitationStatus"
    },
    {
      "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
      "gracePeriodEndDate": "2019-01-20T00:00:00.000+0000",
      "invitationStatus": "invitationStatus"
    }
  ]
}

Changes

  • 1e7a1734a45cRevision changes
    • breaking

      removed the enum value ACCEPTED from the query request parameter invitationStatus

    • breaking

      removed the enum value DECLINED from the query request parameter invitationStatus

    • breaking

      removed the enum value PENDING from the query request parameter invitationStatus

    • info

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

    • info

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

    • info

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

  • dd71433847a6Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated