VEvelopaymentsapi
Webhooks

List the details about the webhooks for the given payor.

Changed on

List the details about the webhooks for the given payor.

get/v1/webhooks

Request

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

Query parameters

pageinteger

Page number. Default is 1.

pageSizeinteger

The number of results to return in a page

payorIdstring uuid required

The Payor ID

Response

Webhook response

Example response

{
  "links": [
    {
      "rel": "first",
      "href": "https://api.sandbox.velopayments.com/v1/resources?page=1&pageSize=3&sort=lastLoadedAt:asc"
    },
    {
      "rel": "first",
      "href": "https://api.sandbox.velopayments.com/v1/resources?page=1&pageSize=3&sort=lastLoadedAt:asc"
    }
  ],
  "page": {
    "numberOfElements": 10,
    "totalPages": 10,
    "pageSize": 10,
    "page": 10,
    "totalElements": 10
  },
  "content": [
    {
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "authorizationHeader": "authorizationHeader",
      "categories": [
        null,
        null
      ],
      "webhookUrl": "webhookUrl",
      "enabled": true
    },
    {
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "authorizationHeader": "authorizationHeader",
      "categories": [
        null,
        null
      ],
      "webhookUrl": "webhookUrl",
      "enabled": true
    }
  ]
}

Changes

  • b924ba134e09Revision 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

    • warning

      added the new funding enum value to 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

    • 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/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated