POST api/cardService/v1/update-order

Request Information

URI Parameters

None.

Body Parameters

UpdateCardOrderRequestModel
NameDescriptionTypeAdditional information
OrderId

integer

Required

Paid

boolean

Required

PaymentRef

string

Required

SendConfirmation

boolean

Required

BillingName

string

None.

BillingAddress1

string

None.

BillingAddress2

string

None.

BillingCountry

string

None.

BillingPostcode

string

None.

Amount

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "OrderId": 1,
  "Paid": true,
  "PaymentRef": "sample string 3",
  "SendConfirmation": true,
  "BillingName": "sample string 5",
  "BillingAddress1": "sample string 6",
  "BillingAddress2": "sample string 7",
  "BillingCountry": "sample string 8",
  "BillingPostcode": "sample string 9",
  "Amount": 10.0
}

application/xml, text/xml

Sample:
<UpdateCardOrderRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels">
  <Amount>10</Amount>
  <BillingAddress1>sample string 6</BillingAddress1>
  <BillingAddress2>sample string 7</BillingAddress2>
  <BillingCountry>sample string 8</BillingCountry>
  <BillingName>sample string 5</BillingName>
  <BillingPostcode>sample string 9</BillingPostcode>
  <OrderId>1</OrderId>
  <Paid>true</Paid>
  <PaymentRef>sample string 3</PaymentRef>
  <SendConfirmation>true</SendConfirmation>
</UpdateCardOrderRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderCardResponseModel
NameDescriptionTypeAdditional information
Id

string

Required

IsSuccess

boolean

Required

ErrorCodes

Collection of string

Required

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "IsSuccess": true,
  "ErrorCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:
<OrderCardResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels">
  <ErrorCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorCodes>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 3</Message>
  <Id>sample string 1</Id>
</OrderCardResponseModel>