POST vouchers/generate-qr

Request Information

URI Parameters

None.

Body Parameters

GenerateVoucherQRRequest
NameDescriptionTypeAdditional information
VoucherReference

string

Required

UserId

string

Required

ExpiryMinutes

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "VoucherReference": "sample string 1",
  "UserId": "sample string 2",
  "ExpiryMinutes": 3
}

application/xml, text/xml

Sample:
<GenerateVoucherQRRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <ExpiryMinutes>3</ExpiryMinutes>
  <UserId>sample string 2</UserId>
  <VoucherReference>sample string 1</VoucherReference>
</GenerateVoucherQRRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GenerateVoucherQRRequest'.

Response Information

Resource Description

GenerateVoucherQRResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Transaction

VoucherQRTransaction

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Transaction": {
    "Id": 1,
    "DateCreated": "2026-03-26T03:52:04.8178632+02:00",
    "LastModified": "2026-03-26T03:52:04.8178632+02:00",
    "VoucherId": 4,
    "VoucherReference": "sample string 5",
    "TransactionNumber": "sample string 6",
    "GeneratedAt": "2026-03-26T03:52:04.8178632+02:00",
    "ExpiresAt": "2026-03-26T03:52:04.8178632+02:00",
    "IsActive": true,
    "IsUsed": true,
    "UsedAt": "2026-03-26T03:52:04.8178632+02:00",
    "UsedByUserId": "sample string 11",
    "TransactionType": "sample string 12",
    "Amount": 1.0,
    "StoreName": "sample string 13",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "Altitude": "sample string 14",
    "QRCodeData": "VCH|sample string 5|sample string 6|20260326035204",
    "IsValid": false,
    "TimeRemaining": "00:00:00",
    "FormattedTimeRemaining": "Expired"
  }
}

application/xml, text/xml

Sample:
<GenerateVoucherQRResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Transaction>
    <Altitude>sample string 14</Altitude>
    <Amount>1</Amount>
    <DateCreated>2026-03-26T03:52:04.8178632+02:00</DateCreated>
    <ExpiresAt>2026-03-26T03:52:04.8178632+02:00</ExpiresAt>
    <GeneratedAt>2026-03-26T03:52:04.8178632+02:00</GeneratedAt>
    <Id>1</Id>
    <IsActive>true</IsActive>
    <IsUsed>true</IsUsed>
    <LastModified>2026-03-26T03:52:04.8178632+02:00</LastModified>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <StoreName>sample string 13</StoreName>
    <TransactionNumber>sample string 6</TransactionNumber>
    <TransactionType>sample string 12</TransactionType>
    <UsedAt>2026-03-26T03:52:04.8178632+02:00</UsedAt>
    <UsedByUserId>sample string 11</UsedByUserId>
    <VoucherId>4</VoucherId>
    <VoucherReference>sample string 5</VoucherReference>
  </Transaction>
</GenerateVoucherQRResponse>