Skip to main content
Discard an unused voucher — releases it from the reserved state.
POST /api/v1/vouchers/:voucherId/discard-voucher Discards a voucher that is no longer needed. The voucher must be in RESERVED or REDEEMED status. Once discarded, the voucher cannot be used. This endpoint accepts both resource-based and registered user tokens.

Parameters

Path

NameTypeRequiredDescription
voucherIdstringYesThe voucher ID to discard

Body

No body parameters required.

Request example

curl --request POST 'https://payments.bleepay.com/api/v1/vouchers/vch_482916/discard-voucher' \
  --header 'Authorization: Bearer <payee_token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Response

Response schema

Returns the updated voucher object with a discarded status.

Error responses

StatusCodeDescription
400already_resolvedA resolved voucher cannot be discarded
401unauthorizedMissing or invalid bearer token
404not_foundVoucher not found