Skip to main content
Start a new voucher session — groups multiple vouchers under a single context.
POST /api/v1/vouchers/sessions/session-open A session groups multiple vouchers together for multi-payment flows like split payments or multi-currency checkouts. Each voucher in the session is independent (own code, lifecycle, settlement), but they share the session for tracking and coordination.

Parameters

Body

NameTypeRequiredDescription
codestringYesThe context code shared by the payer. 6 characters.
typeenumYesSession type — always SESSION_DEFAULT
payeeInfoobjectNoAdditional payee information

Request example

curl --request POST 'https://payments.bleepay.com/api/v1/vouchers/sessions/session-open' \
  --header 'Authorization: Bearer <payee_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "A1B2C3",
    "type": "SESSION_DEFAULT"
  }'

Response

Response schema

FieldTypeDescription
idstringUnique session identifier (e.g. ses_xyz)
codestringSession code
statusstringSession status — OPEN
typestringSession type
createdAtstringISO 8601 creation timestamp

Example response

{
  "id": "ses_xyz",
  "code": "D4E5F6",
  "status": "OPEN",
  "type": "SESSION_DEFAULT",
  "createdAt": "2026-06-09T12:00:00.000Z"
}

Error responses

StatusCodeDescription
400invalid_codeThe context code is invalid or expired
401unauthorizedMissing or invalid bearer token