Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Webhooks

Create or update webhook endpoints

Create, update, or remove pre-configured webhook endpoints for payouts and bank account verification notifications, and configure which notification types are sent to the payouts webhook URL.

post/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.

Request body

webhookEndpointstring uri

Payouts status notification endpoint. Set to a valid URL to create/update; set to null to remove; omit to leave unchanged.

banvEndpointstring uri

Bank account verification update notification endpoint. Set to a valid URL to create/update; set to null to remove; omit to leave unchanged.

Example request

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

Response

Endpoints updated.

webhookEndpointstring

Echoes the current payouts endpoint (empty string if removed or not configured). Present only if included in the request.

banvEndpointstring

Echoes the current BANV endpoint (empty string if removed or not configured). Present only if included in the request.

Example response

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