Skip to main content
Reserve a voucher within an open session.
POST /api/v1/vouchers/sessions/:sessionId/reserve-voucher Works the same as the standalone reserve-voucher endpoint, but scoped to a session. Each voucher reserved in a session is independent — with its own code, lifecycle, and settlement — but tracked together under the session.

Parameters

Path

NameTypeRequiredDescription
sessionIdstringYesThe session ID

Body

No body parameters required. The context is derived from the session.

Request example

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

Response

Response schema

FieldTypeDescription
idstringUnique voucher identifier
codestring6-digit voucher code
statusstringVoucher status — RESERVED
expiresAtstringISO 8601 expiry timestamp

Example response

{
  "id": "vch_482916",
  "code": "482916",
  "status": "RESERVED",
  "expiresAt": "2026-06-09T12:02:00.000Z"
}

Error responses

StatusCodeDescription
400session_closedCannot reserve in a closed session
401unauthorizedMissing or invalid bearer token
404not_foundSession not found

Next steps

After reserving, redeem the voucher to set the payment terms.