POST vouchers/ucare/transact

Request Information

URI Parameters

None.

Body Parameters

UCareVoucherTransactionRequest
NameDescriptionTypeAdditional information
ReferenceCode

string

Required

UserId

string

Required

Amount

decimal number

Required

Range: inclusive between 0,01 and 7,92281625142643E+28

TransactionType

string

Required

Description

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ReferenceCode": "sample string 1",
  "UserId": "sample string 2",
  "Amount": 3.0,
  "TransactionType": "sample string 4",
  "Description": "sample string 5"
}

application/xml, text/xml

Sample:
<UCareVoucherTransactionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Amount>3</Amount>
  <Description>sample string 5</Description>
  <ReferenceCode>sample string 1</ReferenceCode>
  <TransactionType>sample string 4</TransactionType>
  <UserId>sample string 2</UserId>
</UCareVoucherTransactionRequest>

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

Response Information

Resource Description

UCareVoucherTransactionResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

NewBalance

decimal number

None.

TransactionId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "NewBalance": 3.0,
  "TransactionId": "sample string 4"
}

application/xml, text/xml

Sample:
<UCareVoucherTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Message>sample string 2</Message>
  <NewBalance>3</NewBalance>
  <Success>true</Success>
  <TransactionId>sample string 4</TransactionId>
</UCareVoucherTransactionResponse>