Create merchant withdrawal method
Creates a new saved withdrawal method for a merchant. Validates methodType against the platform catalog and details against the catalog entry’s field schema. New methods enter a cooling period (status "cooling") and become usable only after activatesAt.
Authorization
bearer In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://<api-host>/v1/merchant-withdrawal-methods" \ -H "Content-Type: application/json" \ -d '{ "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b", "methodType": "string", "label": "string", "details": { "property1": "string", "property2": "string" } }'{
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
"livemode": true,
"merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"methodType": "string",
"label": "string",
"details": {
"property1": "string",
"property2": "string"
},
"status": "cooling",
"activatesAt": "string",
"createdAt": "string",
"updatedAt": "string",
"deletedAt": null
}
}Update webhook endpoint
Updates mutable fields of a webhook endpoint (url, events, description, status, maxAttempts). Only fields included in the body are changed. Events, if provided, REPLACE the previous subscription set — no partial merge. Use `status: "disabled"` to pause deliveries without deleting the endpoint. Send `maxAttempts: null` to fall back to the platform default; `stripe_compat` endpoints ignore it and keep their own retry schedule.
Get merchant withdrawal method by ID
Returns the full details of a saved withdrawal method, including its catalog type, details, status, and cooling-period timestamp. Returns 404 if the method does not exist or is not visible to the caller.