POST api/Lunchbox/FinalizeApplePay?phoneNumber={phoneNumber}&lunchcartId={lunchcartId}&authOnly={authOnly}&notifyAsPush={notifyAsPush}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
phoneNumber

string

Required

lunchcartId

string

None.

authOnly

boolean

Default value is False

notifyAsPush

boolean

Default value is False

Body Parameters

ApplePayResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

ResponseCode

string

None.

ResponseMessage

string

None.

AuthCode

string

None.

HostReferenceNumber

string

None.

TaskId

string

None.

TransactionId

string

None.

ProcessedAmount

decimal number

None.

CardType

string

None.

MaskedCardNumber

string

None.

BillingAddress

Address

None.

EmailAddress

string

None.

RawRequest

string

None.

RawResponse

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ResponseCode": "sample string 2",
  "ResponseMessage": "sample string 3",
  "AuthCode": "sample string 4",
  "HostReferenceNumber": "sample string 5",
  "TaskId": "sample string 6",
  "TransactionId": "sample string 7",
  "ProcessedAmount": 8.0,
  "CardType": "sample string 9",
  "MaskedCardNumber": "sample string 10",
  "BillingAddress": {
    "AddressId": 1,
    "CrossStreetInstructions": "sample string 2",
    "IsVirtualCafe": true,
    "AddressHash": "sample string 4",
    "BuildingHash": "sample string 5",
    "TypeName": "sample string 6",
    "TypeValue": 1,
    "CellId": "sample string 7",
    "IsEcafe": true,
    "ParkingFlag": 9,
    "ContactFirstName": "sample string 10",
    "FriendlyAddress": "sample string 11",
    "FriendlyAddressHtml": "sample string 12",
    "FriendlyContactDisplay": "sample string 13",
    "ContactLastName": "sample string 14",
    "ContactPhone": "sample string 15",
    "ContactPhoneExt": "sample string 16",
    "ContactEmail": "sample string 17",
    "ContactCompany": "sample string 18",
    "StreetAddress": "sample string 19",
    "City": "sample string 20",
    "State": "sample string 21",
    "Zip": "sample string 22",
    "ZipExtendedFour": "sample string 23",
    "Suite": "sample string 24",
    "Floor": "sample string 25",
    "Telephone": "sample string 26",
    "TelephoneExt": "sample string 27",
    "LinkedCC": true,
    "LinkedTermAccount": true,
    "Favorite": true,
    "BuildingActive": true,
    "AddressActive": true,
    "PriorityPickupStatus": 33,
    "ValidationResponse": true,
    "ValidationResponseMessage": "sample string 35",
    "IsLunchStop": true,
    "LunchStopId": 37,
    "LunchStopName": "sample string 38",
    "LunchStopStatus": 39,
    "IsLocked": true,
    "IsPickupLocation": true,
    "IsCustomerDefaultLocation": true
  },
  "EmailAddress": "sample string 11",
  "RawRequest": "sample string 12",
  "RawResponse": "sample string 13"
}

text/html

Sample:
{"Success":true,"ResponseCode":"sample string 2","ResponseMessage":"sample string 3","AuthCode":"sample string 4","HostReferenceNumber":"sample string 5","TaskId":"sample string 6","TransactionId":"sample string 7","ProcessedAmount":8.0,"CardType":"sample string 9","MaskedCardNumber":"sample string 10","BillingAddress":{"AddressId":1,"CrossStreetInstructions":"sample string 2","IsVirtualCafe":true,"AddressHash":"sample string 4","BuildingHash":"sample string 5","TypeName":"sample string 6","TypeValue":1,"CellId":"sample string 7","IsEcafe":true,"ParkingFlag":9,"ContactFirstName":"sample string 10","FriendlyAddress":"sample string 11","FriendlyAddressHtml":"sample string 12","FriendlyContactDisplay":"sample string 13","ContactLastName":"sample string 14","ContactPhone":"sample string 15","ContactPhoneExt":"sample string 16","ContactEmail":"sample string 17","ContactCompany":"sample string 18","StreetAddress":"sample string 19","City":"sample string 20","State":"sample string 21","Zip":"sample string 22","ZipExtendedFour":"sample string 23","Suite":"sample string 24","Floor":"sample string 25","Telephone":"sample string 26","TelephoneExt":"sample string 27","LinkedCC":true,"LinkedTermAccount":true,"Favorite":true,"BuildingActive":true,"AddressActive":true,"PriorityPickupStatus":33,"ValidationResponse":true,"ValidationResponseMessage":"sample string 35","IsLunchStop":true,"LunchStopId":37,"LunchStopName":"sample string 38","LunchStopStatus":39,"IsLocked":true,"IsPickupLocation":true,"IsCustomerDefaultLocation":true},"EmailAddress":"sample string 11","RawRequest":"sample string 12","RawResponse":"sample string 13"}

application/xml, text/xml

Sample:
<ApplePayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Specialtys.DTO">
  <AuthCode>sample string 4</AuthCode>
  <BillingAddress>
    <AddressActive>true</AddressActive>
    <AddressHash>sample string 4</AddressHash>
    <AddressId>1</AddressId>
    <BuildingActive>true</BuildingActive>
    <BuildingHash>sample string 5</BuildingHash>
    <CellId>sample string 7</CellId>
    <City>sample string 20</City>
    <ContactCompany>sample string 18</ContactCompany>
    <ContactEmail>sample string 17</ContactEmail>
    <ContactFirstName>sample string 10</ContactFirstName>
    <ContactLastName>sample string 14</ContactLastName>
    <ContactPhone>sample string 15</ContactPhone>
    <ContactPhoneExt>sample string 16</ContactPhoneExt>
    <CrossStreetInstructions>sample string 2</CrossStreetInstructions>
    <Favorite>true</Favorite>
    <Floor>sample string 25</Floor>
    <FriendlyAddress>sample string 11</FriendlyAddress>
    <FriendlyAddressHtml>sample string 12</FriendlyAddressHtml>
    <FriendlyContactDisplay>sample string 13</FriendlyContactDisplay>
    <IsCustomerDefaultLocation>true</IsCustomerDefaultLocation>
    <IsEcafe>true</IsEcafe>
    <IsLocked>true</IsLocked>
    <IsLunchStop>true</IsLunchStop>
    <IsPickupLocation>true</IsPickupLocation>
    <IsVirtualCafe>true</IsVirtualCafe>
    <LinkedCC>true</LinkedCC>
    <LinkedTermAccount>true</LinkedTermAccount>
    <LunchStopId>37</LunchStopId>
    <LunchStopName>sample string 38</LunchStopName>
    <LunchStopStatus>39</LunchStopStatus>
    <ParkingFlag>9</ParkingFlag>
    <PriorityPickupStatus>33</PriorityPickupStatus>
    <State>sample string 21</State>
    <StreetAddress>sample string 19</StreetAddress>
    <Suite>sample string 24</Suite>
    <Telephone>sample string 26</Telephone>
    <TelephoneExt>sample string 27</TelephoneExt>
    <TypeName>sample string 6</TypeName>
    <TypeValue>1</TypeValue>
    <ValidationResponse>true</ValidationResponse>
    <ValidationResponseMessage>sample string 35</ValidationResponseMessage>
    <Zip>sample string 22</Zip>
    <ZipExtendedFour>sample string 23</ZipExtendedFour>
  </BillingAddress>
  <CardType>sample string 9</CardType>
  <EmailAddress>sample string 11</EmailAddress>
  <HostReferenceNumber>sample string 5</HostReferenceNumber>
  <MaskedCardNumber>sample string 10</MaskedCardNumber>
  <ProcessedAmount>8</ProcessedAmount>
  <RawRequest>sample string 12</RawRequest>
  <RawResponse>sample string 13</RawResponse>
  <ResponseCode>sample string 2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Success>true</Success>
  <TaskId>sample string 6</TaskId>
  <TransactionId>sample string 7</TransactionId>
</ApplePayResponse>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.