GET vouchers/user/{userId}?type={type}

Request Information

URI Parameters

Name	Description	Type	Additional information
userId		string	Required
type		VoucherType	Default value is All

Body Parameters

None.

Response Information

Resource Description

Collection of Voucher

Name	Type	Additional information
Id	integer	None.
DateCreated	date	None.
LastModified	date	None.
AmountAvailable	decimal number	None.
ExpiryDate	date	None.
Message	string	None.
Active	boolean	None.
Paid	boolean	None.
UserId	string	None.
AmountPaid	decimal number	None.
AmountRequested	decimal number	None.
FromUserId	string	None.
EmailAddress	string	None.
TransactionReference	string	None.
UserTransactionReference	string	None.
CellNo	string	None.
Redeemed	boolean	None.
Header	string	None.
HeaderId	integer	None.
CustomHeader	boolean	None.
AmountSpent	decimal number	None.
AmountPayable	decimal number	None.
NetcashFees	decimal number	None.
SunfireFees	decimal number	None.
TransactionDate	date	None.
TempId	string	None.
PrintVoucher	boolean	None.
Schedule	boolean	None.
ScheduleDateTime	date	None.
Sent	boolean	None.
DateTimeSent	date	None.
RecipientName	string	None.
VoucherNo	string	None.
MallId	string	None.
SenderName	string	None.
SenderEmail	string	None.
SenderPhone	string	None.
RecipientEmail	string	None.
RecipientPhone	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "DateCreated": "2026-03-26T03:50:29.7225877+02:00",
    "LastModified": "2026-03-26T03:50:29.7225877+02:00",
    "AmountAvailable": 1.0,
    "ExpiryDate": "2026-03-26T03:50:29.7225877+02:00",
    "Message": "sample string 2",
    "Active": true,
    "Paid": true,
    "UserId": "sample string 3",
    "AmountPaid": 1.0,
    "AmountRequested": 1.0,
    "FromUserId": "sample string 4",
    "EmailAddress": "sample string 5",
    "TransactionReference": "sample string 6",
    "UserTransactionReference": "sample string 7",
    "CellNo": "sample string 8",
    "Redeemed": true,
    "Header": "sample string 9",
    "HeaderId": 1,
    "CustomHeader": true,
    "AmountSpent": 1.0,
    "AmountPayable": 1.0,
    "NetcashFees": 1.0,
    "SunfireFees": 1.0,
    "TransactionDate": "2026-03-26T03:50:29.72517+02:00",
    "TempId": "sample string 10",
    "PrintVoucher": true,
    "Schedule": true,
    "ScheduleDateTime": "2026-03-26T03:50:29.72517+02:00",
    "Sent": true,
    "DateTimeSent": "2026-03-26T03:50:29.7257031+02:00",
    "RecipientName": "sample string 14",
    "VoucherNo": "sample string 15",
    "MallId": "sample string 16",
    "SenderName": "sample string 17",
    "SenderEmail": "sample string 18",
    "SenderPhone": "sample string 19",
    "RecipientEmail": "sample string 20",
    "RecipientPhone": "sample string 21"
  },
  {
    "Id": 1,
    "DateCreated": "2026-03-26T03:50:29.7225877+02:00",
    "LastModified": "2026-03-26T03:50:29.7225877+02:00",
    "AmountAvailable": 1.0,
    "ExpiryDate": "2026-03-26T03:50:29.7225877+02:00",
    "Message": "sample string 2",
    "Active": true,
    "Paid": true,
    "UserId": "sample string 3",
    "AmountPaid": 1.0,
    "AmountRequested": 1.0,
    "FromUserId": "sample string 4",
    "EmailAddress": "sample string 5",
    "TransactionReference": "sample string 6",
    "UserTransactionReference": "sample string 7",
    "CellNo": "sample string 8",
    "Redeemed": true,
    "Header": "sample string 9",
    "HeaderId": 1,
    "CustomHeader": true,
    "AmountSpent": 1.0,
    "AmountPayable": 1.0,
    "NetcashFees": 1.0,
    "SunfireFees": 1.0,
    "TransactionDate": "2026-03-26T03:50:29.72517+02:00",
    "TempId": "sample string 10",
    "PrintVoucher": true,
    "Schedule": true,
    "ScheduleDateTime": "2026-03-26T03:50:29.72517+02:00",
    "Sent": true,
    "DateTimeSent": "2026-03-26T03:50:29.7257031+02:00",
    "RecipientName": "sample string 14",
    "VoucherNo": "sample string 15",
    "MallId": "sample string 16",
    "SenderName": "sample string 17",
    "SenderEmail": "sample string 18",
    "SenderPhone": "sample string 19",
    "RecipientEmail": "sample string 20",
    "RecipientPhone": "sample string 21"
  }
]

application/xml, text/xml

Sample:

<ArrayOfVoucher xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Voucher>
    <Active>true</Active>
    <AmountAvailable>1</AmountAvailable>
    <AmountPaid>1</AmountPaid>
    <AmountPayable>1</AmountPayable>
    <AmountRequested>1</AmountRequested>
    <AmountSpent>1</AmountSpent>
    <CellNo>sample string 8</CellNo>
    <CustomHeader>true</CustomHeader>
    <DateCreated>2026-03-26T03:50:29.7225877+02:00</DateCreated>
    <DateTimeSent>2026-03-26T03:50:29.7257031+02:00</DateTimeSent>
    <EmailAddress>sample string 5</EmailAddress>
    <ExpiryDate>2026-03-26T03:50:29.7225877+02:00</ExpiryDate>
    <FromUserId>sample string 4</FromUserId>
    <Header>sample string 9</Header>
    <HeaderId>1</HeaderId>
    <Id>1</Id>
    <LastModified>2026-03-26T03:50:29.7225877+02:00</LastModified>
    <MallId>sample string 16</MallId>
    <Message>sample string 2</Message>
    <NetcashFees>1</NetcashFees>
    <Paid>true</Paid>
    <PrintVoucher>true</PrintVoucher>
    <RecipientEmail>sample string 20</RecipientEmail>
    <RecipientName>sample string 14</RecipientName>
    <RecipientPhone>sample string 21</RecipientPhone>
    <Redeemed>true</Redeemed>
    <Schedule>true</Schedule>
    <ScheduleDateTime>2026-03-26T03:50:29.72517+02:00</ScheduleDateTime>
    <SenderEmail>sample string 18</SenderEmail>
    <SenderName>sample string 17</SenderName>
    <SenderPhone>sample string 19</SenderPhone>
    <Sent>true</Sent>
    <SunfireFees>1</SunfireFees>
    <TempId>sample string 10</TempId>
    <TransactionDate>2026-03-26T03:50:29.72517+02:00</TransactionDate>
    <TransactionReference>sample string 6</TransactionReference>
    <UserId>sample string 3</UserId>
    <UserTransactionReference>sample string 7</UserTransactionReference>
    <VoucherNo>sample string 15</VoucherNo>
  </Voucher>
  <Voucher>
    <Active>true</Active>
    <AmountAvailable>1</AmountAvailable>
    <AmountPaid>1</AmountPaid>
    <AmountPayable>1</AmountPayable>
    <AmountRequested>1</AmountRequested>
    <AmountSpent>1</AmountSpent>
    <CellNo>sample string 8</CellNo>
    <CustomHeader>true</CustomHeader>
    <DateCreated>2026-03-26T03:50:29.7225877+02:00</DateCreated>
    <DateTimeSent>2026-03-26T03:50:29.7257031+02:00</DateTimeSent>
    <EmailAddress>sample string 5</EmailAddress>
    <ExpiryDate>2026-03-26T03:50:29.7225877+02:00</ExpiryDate>
    <FromUserId>sample string 4</FromUserId>
    <Header>sample string 9</Header>
    <HeaderId>1</HeaderId>
    <Id>1</Id>
    <LastModified>2026-03-26T03:50:29.7225877+02:00</LastModified>
    <MallId>sample string 16</MallId>
    <Message>sample string 2</Message>
    <NetcashFees>1</NetcashFees>
    <Paid>true</Paid>
    <PrintVoucher>true</PrintVoucher>
    <RecipientEmail>sample string 20</RecipientEmail>
    <RecipientName>sample string 14</RecipientName>
    <RecipientPhone>sample string 21</RecipientPhone>
    <Redeemed>true</Redeemed>
    <Schedule>true</Schedule>
    <ScheduleDateTime>2026-03-26T03:50:29.72517+02:00</ScheduleDateTime>
    <SenderEmail>sample string 18</SenderEmail>
    <SenderName>sample string 17</SenderName>
    <SenderPhone>sample string 19</SenderPhone>
    <Sent>true</Sent>
    <SunfireFees>1</SunfireFees>
    <TempId>sample string 10</TempId>
    <TransactionDate>2026-03-26T03:50:29.72517+02:00</TransactionDate>
    <TransactionReference>sample string 6</TransactionReference>
    <UserId>sample string 3</UserId>
    <UserTransactionReference>sample string 7</UserTransactionReference>
    <VoucherNo>sample string 15</VoucherNo>
  </Voucher>
</ArrayOfVoucher>