POST loyalty/{cardNumber}/status

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cardNumber

string

Required

Body Parameters

LoyaltyRequest
NameDescriptionTypeAdditional information
company

string

None.

companyUsername

string

None.

companyPassword

string

None.

requestUser

string

None.

requestPassword

string

None.

Request Formats

application/json, text/json

Sample:
{
  "company": "sample string 1",
  "companyUsername": "sample string 2",
  "companyPassword": "sample string 3",
  "requestUser": "sample string 4",
  "requestPassword": "sample string 5"
}

application/xml, text/xml

Sample:
<LoyaltyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loyalty.Core.Contracts">
  <company>sample string 1</company>
  <companyPassword>sample string 3</companyPassword>
  <companyUsername>sample string 2</companyUsername>
  <requestPassword>sample string 5</requestPassword>
  <requestUser>sample string 4</requestUser>
</LoyaltyRequest>

Response Information

Resource Description

CardStatus
NameDescriptionTypeAdditional information
cardNumber

string

None.

accountActive

boolean

None.

cardExists

boolean

None.

requirePin

boolean

None.

profileExists

boolean

None.

seriesActive

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "cardNumber": "sample string 1",
  "accountActive": true,
  "cardExists": true,
  "requirePin": true,
  "profileExists": true,
  "seriesActive": true
}

application/xml, text/xml

Sample:
<CardStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Loyalty.Core.Contracts">
  <accountActive>true</accountActive>
  <cardExists>true</cardExists>
  <cardNumber>sample string 1</cardNumber>
  <profileExists>true</profileExists>
  <requirePin>true</requirePin>
  <seriesActive>true</seriesActive>
</CardStatus>