Skip to main content
API docs by Redocly

Partner API (v1)

Download OpenAPI specification:Download

SKChase Partner API

VoucherCertificate

Retrieves a voucher certificate

Authorizations:
OAuth2
path Parameters
referenceNumber
required
string

The unique reference number of the voucher certificate to retrieve.

Responses

Response samples

Content type
application/json
{
  • "id": "8a6e4fdf-0926-495c-ad79-7acbb1d7e06a",
  • "salesChannelId": "90237141-77b9-4dd0-99f1-b0ea1498f468",
  • "orderId": "169317fd-9949-4bb3-8852-617d6b56d3cf",
  • "orderNumber": "PSKCABC123",
  • "certificateReferenceNumber": "ABCD1234",
  • "issuedOnUtc": "2025-05-09T14:15:09.4456416Z",
  • "currentBalance": {
    },
  • "startingBalance": {
    },
  • "voucherProduct": {
    },
  • "validFromUtc": "2025-05-09T14:15:09.4456416Z",
  • "validToUtc": "2026-05-09T14:15:09.4456416Z",
  • "extensionDays": 90,
  • "redemptions": [
    ],
  • "isExpired": false,
  • "isRedeemable": true,
  • "isInvalidated": false,
  • "invalidationReason": "",
  • "personalMessage": {
    },
  • "extendedValidityUtc": "0001-01-01T00:00:00",
  • "isBooked": true,
  • "bookingInfo": {
    },
  • "redemptionStatus": "PartiallyRedeemed"
}

Creates a booking

Authorizations:
OAuth2
path Parameters
referenceNumber
required
string

The unique reference number of the voucher certificate to book.

Request Body schema: application/json

The request object containing details necessary to book the voucher certificate.

guestFirstName
string or null
guestLastName
string or null
notes
string or null
bookingDate
string or null <date>
bookingTime
string or null <time>
bookingReference
string or null

Responses

Request samples

Content type
application/json
{
  • "guestFirstName": "John",
  • "guestLastName": "Doe",
  • "notes": "We would like a table by the window, please. Celebrating an anniversary.",
  • "bookingDate": "2025-08-09",
  • "bookingTime": "19:30:00",
  • "bookingReference": "CONF-XY-778899"
}

Response samples

Content type
application/json
{
  • "id": "93297a8d-703c-4212-880f-dca1a99263de",
  • "salesChannelId": "ea31f89b-b327-434e-95d0-5e1caae3c325",
  • "orderId": "ffae10f8-fa35-41b3-8421-b6c815208ac7",
  • "orderNumber": "PSKCABC123",
  • "certificateReferenceNumber": "ABCD1234",
  • "issuedOnUtc": "2025-05-09T14:15:09.448417Z",
  • "currentBalance": {
    },
  • "startingBalance": {
    },
  • "voucherProduct": {
    },
  • "validFromUtc": "2025-05-09T14:15:09.448417Z",
  • "validToUtc": "2026-05-09T14:15:09.448417Z",
  • "extensionDays": 90,
  • "redemptions": [
    ],
  • "isExpired": false,
  • "isRedeemable": true,
  • "isInvalidated": false,
  • "invalidationReason": "",
  • "personalMessage": {
    },
  • "extendedValidityUtc": "0001-01-01T00:00:00",
  • "isBooked": true,
  • "bookingInfo": {
    },
  • "redemptionStatus": "PartiallyRedeemed"
}

Cancels a booking

Authorizations:
OAuth2
path Parameters
referenceNumber
required
string

The unique reference number of the voucher certificate whose booking is to be canceled.

Responses

Response samples

Content type
application/json
{
  • "id": "61e8d478-1f2b-497b-b422-f0e4c9f0a83f",
  • "salesChannelId": "22fc55c6-3fce-4eb9-9204-fdddb15cf975",
  • "orderId": "e8046be9-0ac4-4ac0-a3e1-07e594a3c989",
  • "orderNumber": "PSKCABC123",
  • "certificateReferenceNumber": "ABCD1234",
  • "issuedOnUtc": "2025-05-09T14:15:09.4509468Z",
  • "currentBalance": {
    },
  • "startingBalance": {
    },
  • "voucherProduct": {
    },
  • "validFromUtc": "2025-05-09T14:15:09.4509468Z",
  • "validToUtc": "2026-05-09T14:15:09.4509468Z",
  • "extensionDays": 90,
  • "redemptions": [
    ],
  • "isExpired": false,
  • "isRedeemable": true,
  • "isInvalidated": false,
  • "invalidationReason": "",
  • "personalMessage": {
    },
  • "extendedValidityUtc": "0001-01-01T00:00:00",
  • "isBooked": true,
  • "bookingInfo": {
    },
  • "redemptionStatus": "PartiallyRedeemed"
}