Tenant API - Payment Webhooks

Lists all the partner's defined payment webhooks.

This endpoint returns a list of all the payment webhooks that are defined for the partner in question.

get/v2/webhooks/payments

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v2/webhooks/payments
  • Auth: none declared

Response

List of defined webhooks.

idstring uuid

The ID of the current webhook definition.

urlstring url

The target URL that Kivra will try to deliver to. The hostname in the URL must not be in a restricted domain (like for example example.org or local). The hostname also must resolve to at least one IPv4 address, and must not resolve to any addresses in an IPv4 range reserved by IANA.

cid_filterstring

The client key filter for this webhook configuration.

tkey_filterstring

The tenant key filter for this webhook cofiguration.

typesstring[]

A list of the types of payments that should trigger webhooks.

eventsstring[]

A list of the payment events that should trigger webhooks. Not all events are meaningful for all payment types.

secretstring base64

The newly created secret after a webhook definition was added or modified. The secret is a 256-bit random number that will be used to sign webhook payloads from Kivra. If a secret already exists when a new one is added (that is, when a webhook definition is modified rather han created), payloads will be signed with both the existing and the new secrets for the next 72 hours. For security reasons, this field will be missing in reponses to API calls that do not result in the creation of a new secret.

created_atstring date-time

The time when this definition was created.

Changes

No recorded changes to this operation across all 1 revision of this API.