Cancel Refund Session

Cancel a refund session before funds are sent.

POST /api/v1/widgets/refund-sessions/:sessionId/cancel-session

Cancels a refund session. Only sessions in CREATED or PENDING status can be cancelled.

Parameters

Path

Name	Type	Required	Description
sessionId	string	Yes	The refund session ID to cancel

Body

No body parameters required.

Request example

curl --request POST 'https://payments.bleepay.com/api/v1/widgets/refund-sessions/ref_a1b2c3d4e5f6/cancel-session' \
  --header 'Authorization: Bearer <business_token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Response

Response schema

Field	Type	Description
paymentStatus	string	Updated status — CANCELLED

Example response

{
  "paymentStatus": "CANCELLED"
}

Error responses

Status	Code	Description
400	cannot_cancel	Session is already confirmed or expired
401	unauthorized	Missing or invalid authentication
404	not_found	Refund session not found