POST api/Library/AddLoyaltyCard

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CardNumber	string	Required
Name	string	Required Matching regular expression pattern: ^[a-zA-Z\s'-]+$
Brand	string	Required
CardName	string	Required Matching regular expression pattern: ^[a-zA-Z\s'-]+$
ExpiryDate	date	Required
ReminderType	string	Required
FrontSideImageID	integer	Required
BackSideImageID	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "CardNumber": "sample string 1",
  "Name": "sample string 2",
  "Brand": "sample string 3",
  "CardName": "sample string 4",
  "ExpiryDate": "2026-01-13T18:27:13.79048+03:00",
  "ReminderType": "sample string 6",
  "FrontSideImageID": 7,
  "BackSideImageID": 8
}

application/xml, text/xml

Sample:

<LibraryModels.SaveUserLoyaltyCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <BackSideImageID>8</BackSideImageID>
  <Brand>sample string 3</Brand>
  <CardName>sample string 4</CardName>
  <CardNumber>sample string 1</CardNumber>
  <ExpiryDate>2026-01-13T18:27:13.79048+03:00</ExpiryDate>
  <FrontSideImageID>7</FrontSideImageID>
  <Name>sample string 2</Name>
  <ReminderType>sample string 6</ReminderType>
</LibraryModels.SaveUserLoyaltyCardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetLoyaltyCardListRequest

Name	Type	Additional information
LoyaltyCardList	Collection of LoyaltyCardtListModel	None.
success	boolean	None.
code	string	None.
message	string	None.
errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "LoyaltyCardList": [
    {
      "ID": 1,
      "CardNumber": "sample string 2",
      "Name": "sample string 3",
      "Brand": "sample string 4",
      "CardName": "sample string 5",
      "ExpiryDate": "2026-01-13T18:27:13.8060561+03:00",
      "ReminderType": "sample string 7",
      "FrontSideImageLocation": "sample string 8",
      "BackSideImageLocation": "sample string 9"
    },
    {
      "ID": 1,
      "CardNumber": "sample string 2",
      "Name": "sample string 3",
      "Brand": "sample string 4",
      "CardName": "sample string 5",
      "ExpiryDate": "2026-01-13T18:27:13.8060561+03:00",
      "ReminderType": "sample string 7",
      "FrontSideImageLocation": "sample string 8",
      "BackSideImageLocation": "sample string 9"
    }
  ],
  "success": true,
  "code": "sample string 2",
  "message": "sample string 3",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<LibraryModels.GetLoyaltyCardListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <code>sample string 2</code>
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <message>sample string 3</message>
  <success>true</success>
  <LoyaltyCardList>
    <LibraryModels.LoyaltyCardtListModel>
      <BackSideImageLocation>sample string 9</BackSideImageLocation>
      <Brand>sample string 4</Brand>
      <CardName>sample string 5</CardName>
      <CardNumber>sample string 2</CardNumber>
      <ExpiryDate>2026-01-13T18:27:13.8060561+03:00</ExpiryDate>
      <FrontSideImageLocation>sample string 8</FrontSideImageLocation>
      <ID>1</ID>
      <Name>sample string 3</Name>
      <ReminderType>sample string 7</ReminderType>
    </LibraryModels.LoyaltyCardtListModel>
    <LibraryModels.LoyaltyCardtListModel>
      <BackSideImageLocation>sample string 9</BackSideImageLocation>
      <Brand>sample string 4</Brand>
      <CardName>sample string 5</CardName>
      <CardNumber>sample string 2</CardNumber>
      <ExpiryDate>2026-01-13T18:27:13.8060561+03:00</ExpiryDate>
      <FrontSideImageLocation>sample string 8</FrontSideImageLocation>
      <ID>1</ID>
      <Name>sample string 3</Name>
      <ReminderType>sample string 7</ReminderType>
    </LibraryModels.LoyaltyCardtListModel>
  </LoyaltyCardList>
</LibraryModels.GetLoyaltyCardListRequest>