POST api/OmsGiftCard/GetGiftCardNumberForCredit

Request Information

URI Parameters

None.

Body Parameters

NewGiftCardNumberRequest

NameDescriptionTypeAdditional Information
OrderId

integer

None.

SiteId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "OrderId": 1,
  "SiteId": 2
}

application/xml, text/xml

Sample:
<NewGiftCardNumberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
  <OrderId>1</OrderId>
  <SiteId>2</SiteId>
</NewGiftCardNumberRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NewGiftCardNumberResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.

Message

string

None.

GiftCardDetails

NewGiftCardDetails

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "GiftCardDetails": {
    "GiftCardNumber": "sample string 1",
    "ShowInputForGiftCardNumber": true,
    "Pin": "sample string 3"
  },
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:
<NewGiftCardNumberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
  <CorrelationId>sample string 2</CorrelationId>
  <GiftCardDetails>
    <GiftCardNumber>sample string 1</GiftCardNumber>
    <Pin>sample string 3</Pin>
    <ShowInputForGiftCardNumber>true</ShowInputForGiftCardNumber>
  </GiftCardDetails>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</NewGiftCardNumberResponse>