POST api/cardService/v1/order

Request Information

URI Parameters

None.

Body Parameters

OrderCardRequestModel
NameDescriptionTypeAdditional information
ProductCode

string

Required

Title

string

None.

FirstName

string

Required

LastName

string

Required

Address1

string

Required

Address2

string

None.

Address3

string

None.

City

string

None.

State

string

None.

PostCode

string

Required

ISOCountryCode

string

None.

CardholderId

string

None.

RecipientEmail

string

None.

Dob

string

None.

Language

string

None.

SecondSurname

string

None.

NameOnCard

string

None.

CardDesign

string

None.

ReplacedCardProxyId

string

None.

AdditionalCardEmbossData

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ProductCode": "sample string 1",
  "Title": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "Address3": "sample string 7",
  "City": "sample string 8",
  "State": "sample string 9",
  "PostCode": "sample string 10",
  "ISOCountryCode": "sample string 11",
  "CardholderId": "sample string 12",
  "RecipientEmail": "sample string 13",
  "Dob": "sample string 14",
  "Language": "sample string 15",
  "SecondSurname": "sample string 16",
  "NameOnCard": "sample string 17",
  "CardDesign": "sample string 18",
  "ReplacedCardProxyId": "sample string 19",
  "AdditionalCardEmbossData": "sample string 20"
}

application/xml, text/xml

Sample:
<OrderCardRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels">
  <AdditionalCardEmbossData>sample string 20</AdditionalCardEmbossData>
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <Address3>sample string 7</Address3>
  <CardDesign>sample string 18</CardDesign>
  <CardholderId>sample string 12</CardholderId>
  <City>sample string 8</City>
  <Dob>sample string 14</Dob>
  <FirstName>sample string 3</FirstName>
  <ISOCountryCode>sample string 11</ISOCountryCode>
  <Language>sample string 15</Language>
  <LastName>sample string 4</LastName>
  <NameOnCard>sample string 17</NameOnCard>
  <PostCode>sample string 10</PostCode>
  <ProductCode>sample string 1</ProductCode>
  <RecipientEmail>sample string 13</RecipientEmail>
  <ReplacedCardProxyId>sample string 19</ReplacedCardProxyId>
  <SecondSurname>sample string 16</SecondSurname>
  <State>sample string 9</State>
  <Title>sample string 2</Title>
</OrderCardRequestModel>

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>