Pay: webhooks

List webhook endpoints

GET/v1/webhook_endpoints
Authentication
API key (Authorization: Bearer)
Required scope
pay:read

Responses#

200Endpoints of the key's environment.
Object fields
  • dataarray of objectrequired
    Fields of each item
    • idstring · uuid
    • objectstring
      Values webhook_endpoint
    • environmentstring
      Values test live
    • urlstring
    • event_typesarray of string
      Values invoice.created invoice.confirming invoice.paid invoice.underpaid invoice.overpaid invoice.expired invoice.paid_late invoice.canceled invoice.reverted invoice.held sweep.succeeded sweep.failed refund.succeeded refund.pending merchant.payout_change_requested merchant.payout_changed merchant.frozen merchant.kyb_updated
    • statusstring
      Values enabled disabled
    • created_atstring · date-time
    • disabled_atstring · date-timenullable
  • has_morebooleanrequired
  • next_cursorstringrequirednullable
4xx · 5xxError.

Standard error format: see Errors.