POST vouchers/purchase

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SenderUserId	string	Required
RecipientCellNumber	string	Required
RecipientUserId	string	None.
RecipientEmail	string	None.
RecipientName	string	None.
Amount	decimal number	Required Range: inclusive between 0,01 and 7,92281625142643E+28
Message	string	None.
Header	string	None.
HeaderId	integer	None.
CustomHeader	boolean	None.
PrintVoucher	boolean	None.
Schedule	boolean	None.
ScheduleDateTime	date	None.
ExpiryDate	date	None.
UserTransactionReference	string	Max length: 100

Request Formats

application/json, text/json

Sample:

{
  "SenderUserId": "sample string 1",
  "RecipientCellNumber": "sample string 2",
  "RecipientUserId": "sample string 3",
  "RecipientEmail": "sample string 4",
  "RecipientName": "sample string 5",
  "Amount": 6.0,
  "Message": "sample string 7",
  "Header": "sample string 8",
  "HeaderId": 1,
  "CustomHeader": true,
  "PrintVoucher": true,
  "Schedule": true,
  "ScheduleDateTime": "2026-03-26T03:51:43.1246772+02:00",
  "ExpiryDate": "2026-03-26T03:51:43.1246772+02:00",
  "UserTransactionReference": "sample string 12"
}

application/xml, text/xml

Sample:

<VoucherPurchaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Amount>6</Amount>
  <CustomHeader>true</CustomHeader>
  <ExpiryDate>2026-03-26T03:51:43.1246772+02:00</ExpiryDate>
  <Header>sample string 8</Header>
  <HeaderId>1</HeaderId>
  <Message>sample string 7</Message>
  <PrintVoucher>true</PrintVoucher>
  <RecipientCellNumber>sample string 2</RecipientCellNumber>
  <RecipientEmail>sample string 4</RecipientEmail>
  <RecipientName>sample string 5</RecipientName>
  <RecipientUserId>sample string 3</RecipientUserId>
  <Schedule>true</Schedule>
  <ScheduleDateTime>2026-03-26T03:51:43.1246772+02:00</ScheduleDateTime>
  <SenderUserId>sample string 1</SenderUserId>
  <UserTransactionReference>sample string 12</UserTransactionReference>
</VoucherPurchaseRequest>

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 'VoucherPurchaseRequest'.

Response Information

Resource Description

VoucherPurchaseResponse

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Voucher	Voucher	None.
ErrorCode	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Voucher": {
    "Id": 1,
    "DateCreated": "2026-03-26T03:51:43.1246772+02:00",
    "LastModified": "2026-03-26T03:51:43.1246772+02:00",
    "AmountAvailable": 1.0,
    "ExpiryDate": "2026-03-26T03:51:43.1246772+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:51:43.1246772+02:00",
    "TempId": "sample string 10",
    "PrintVoucher": true,
    "Schedule": true,
    "ScheduleDateTime": "2026-03-26T03:51:43.1246772+02:00",
    "Sent": true,
    "DateTimeSent": "2026-03-26T03:51:43.1246772+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"
  },
  "ErrorCode": "sample string 3"
}

application/xml, text/xml

Sample:

<VoucherPurchaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <ErrorCode>sample string 3</ErrorCode>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <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:51:43.1246772+02:00</DateCreated>
    <DateTimeSent>2026-03-26T03:51:43.1246772+02:00</DateTimeSent>
    <EmailAddress>sample string 5</EmailAddress>
    <ExpiryDate>2026-03-26T03:51:43.1246772+02:00</ExpiryDate>
    <FromUserId>sample string 4</FromUserId>
    <Header>sample string 9</Header>
    <HeaderId>1</HeaderId>
    <Id>1</Id>
    <LastModified>2026-03-26T03:51:43.1246772+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:51:43.1246772+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:51:43.1246772+02:00</TransactionDate>
    <TransactionReference>sample string 6</TransactionReference>
    <UserId>sample string 3</UserId>
    <UserTransactionReference>sample string 7</UserTransactionReference>
    <VoucherNo>sample string 15</VoucherNo>
  </Voucher>
</VoucherPurchaseResponse>