Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Webhooks

Query current webhook endpoints

Returns the configured webhook endpoints for payouts and bank account verification notifications.

get/merchants/{merchantId}/webhook

Path parameters

merchantIdstring required

A unique merchant ID provided by Peach Payments in hexadecimal format.

Example:d0bf5a6a909111f0aabf02d14af18cff

A unique merchant ID provided by Peach Payments.

Response

The configured webhook endpoints for the merchant.

webhookEndpointstring

Payouts status notification endpoint. Empty string if not configured.

banvEndpointstring

Bank account verification update notification endpoint. Empty string if not configured.

Example response

{
  "webhookEndpoint": "https://merchant.example.com/webhooks/payouts",
  "banvEndpoint": "https://merchant.example.com/webhooks/banv",
  "webhookOptions": {
    "floatAllocationUpdates": false,
    "payoutStatusUpdates": true
  }
}