For the complete documentation index, see llms.txt. This page is also available as Markdown.

Delete Portal


v2 DELETE console.bayar.cash/api/v2/portals/{portal_id} v3 DELETE api.console.bayar.cash/v3/portals/{portal_id}


Delete an existing portal by its ID. Once deleted, the portal can no longer be used to create payment intents.

Notes: A portal that already has transactions cannot be deleted. On v2 the request will return a validation error in that case.

Example of sending DELETE request with cURL.

curl -X DELETE https://api.console.bayar.cash/v3/portals/prt_PGMo1q \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <Personal_Access_Token>'

Example of JSON structured response.

{
    "success": true
}

Last updated