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": "4c2374e7-08f2-4c8e-92c3-20da8668131b",
  • "salesChannelId": "68d5524a-8744-48ad-a869-4d86f894ffd0",
  • "orderId": "d7373e95-f854-4127-8a05-8d79785f8669",
  • "orderNumber": "PSKCABC123",
  • "certificateReferenceNumber": "AAAA1111",
  • "issuedOnUtc": "2025-05-01T13:58:56.0106594Z",
  • "currentBalance": {
    },
  • "startingBalance": {
    },
  • "voucherProduct": {
    },
  • "validFromUtc": "2025-05-01T13:58:56.0106594Z",
  • "validToUtc": "2026-05-01T13:58:56.0106594Z",
  • "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.

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
{
  • "notes": "We would like a table by the window, please. Celebrating an anniversary.",
  • "bookingDate": "2025-08-01",
  • "bookingTime": "19:30:00",
  • "bookingReference": "CONF-XY-778899"
}

Response samples

Content type
application/json
{
  • "id": "a55ce161-d4d0-4c09-b39c-d816382f7609",
  • "salesChannelId": "5712ad91-88f1-421d-b2ae-cdc7e9db4bbd",
  • "orderId": "5eb332f9-0fb4-4576-a8ed-1d2331813ee4",
  • "orderNumber": "PSKCABC123",
  • "certificateReferenceNumber": "AAAA1111",
  • "issuedOnUtc": "2025-05-01T13:58:56.0156005Z",
  • "currentBalance": {
    },
  • "startingBalance": {
    },
  • "voucherProduct": {
    },
  • "validFromUtc": "2025-05-01T13:58:56.0156005Z",
  • "validToUtc": "2026-05-01T13:58:56.0156005Z",
  • "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": "9105f05f-c9e3-4250-8788-eed07748738e",
  • "salesChannelId": "7368d47f-7554-42e3-8f12-6b1ab6affe59",
  • "orderId": "cc7916b6-b3f5-40ed-8f17-15978386f0d2",
  • "orderNumber": "PSKCABC123",
  • "certificateReferenceNumber": "AAAA1111",
  • "issuedOnUtc": "2025-05-01T13:58:56.0178027Z",
  • "currentBalance": {
    },
  • "startingBalance": {
    },
  • "voucherProduct": {
    },
  • "validFromUtc": "2025-05-01T13:58:56.0178027Z",
  • "validToUtc": "2026-05-01T13:58:56.0178027Z",
  • "extensionDays": 90,
  • "redemptions": [
    ],
  • "isExpired": false,
  • "isRedeemable": true,
  • "isInvalidated": false,
  • "invalidationReason": "",
  • "personalMessage": {
    },
  • "extendedValidityUtc": "0001-01-01T00:00:00",
  • "isBooked": true,
  • "bookingInfo": {
    },
  • "redemptionStatus": "PartiallyRedeemed"
}