WebsiteStatusSupportPostman workspacePricingDocumentation hub survey
API reference
RSS feedSign up

Create or update webhook endpoints

post
https://sandbox-payouts.peachpayments.com/api/merchants//webhook

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 32 and 32

A unique merchant ID provided by Peach Payments.

Body Params

Request payload to set or clear webhook endpoints.

uri | null

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

uri | null

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

webhookOptions
object

Optional toggles for which events are sent to the payouts webhook URL. Omitted flags default to payout status updates enabled and float allocation updates disabled.

Responses

Updated 19 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago