POST api/shoppingcarts/{id}/payments

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

ShoppingCartAddPaymentItems
NameDescriptionTypeAdditional information
Payments

Collection of ShoppingCartAddPaymentItem

None.

Request Formats

application/json, text/json

Sample:
{
  "Payments": [
    {
      "PaymentType": 0,
      "VoucherGroupID": 1,
      "VoucherID": 2,
      "PromotionID": 3,
      "Code": "sample string 4",
      "PromotionItemDetails": "sample string 5",
      "CustomerPersonID": 6,
      "ApplyToAll": true,
      "PaymentMethodSubtypeID": 8,
      "ShoppingCartLineID": 9,
      "PaymentEngineID": 10,
      "PaymentSum": 11.0,
      "PaymentReceived": 12.0,
      "ResourceTag": "sample string 13",
      "RemoteTransactionIdentifier": "sample string 14",
      "RemoteReference": "sample string 15",
      "ResultMessage": "sample string 16",
      "Description": "sample string 17",
      "PaymentDetails": "sample string 18",
      "ManualOverrideTicketCategoryID": 19,
      "ManualOverrideGrossUnitPrice": 20.0,
      "ManualOverridePaymentValue": 21.0,
      "PaymentLogID": 22,
      "CouponID": 23
    },
    {
      "PaymentType": 0,
      "VoucherGroupID": 1,
      "VoucherID": 2,
      "PromotionID": 3,
      "Code": "sample string 4",
      "PromotionItemDetails": "sample string 5",
      "CustomerPersonID": 6,
      "ApplyToAll": true,
      "PaymentMethodSubtypeID": 8,
      "ShoppingCartLineID": 9,
      "PaymentEngineID": 10,
      "PaymentSum": 11.0,
      "PaymentReceived": 12.0,
      "ResourceTag": "sample string 13",
      "RemoteTransactionIdentifier": "sample string 14",
      "RemoteReference": "sample string 15",
      "ResultMessage": "sample string 16",
      "Description": "sample string 17",
      "PaymentDetails": "sample string 18",
      "ManualOverrideTicketCategoryID": 19,
      "ManualOverrideGrossUnitPrice": 20.0,
      "ManualOverridePaymentValue": 21.0,
      "PaymentLogID": 22,
      "CouponID": 23
    }
  ]
}

application/xml, text/xml

Sample:
<Payments xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Payments>
    <Payment>
      <ApplyToAll>true</ApplyToAll>
      <Code>sample string 4</Code>
      <CouponID>23</CouponID>
      <CustomerPersonID>6</CustomerPersonID>
      <Description>sample string 17</Description>
      <ManualOverrideGrossUnitPrice>20</ManualOverrideGrossUnitPrice>
      <ManualOverridePaymentValue>21</ManualOverridePaymentValue>
      <ManualOverrideTicketCategoryID>19</ManualOverrideTicketCategoryID>
      <PaymentDetails>sample string 18</PaymentDetails>
      <PaymentEngineID>10</PaymentEngineID>
      <PaymentLogID>22</PaymentLogID>
      <PaymentMethodSubtypeID>8</PaymentMethodSubtypeID>
      <PaymentReceived>12</PaymentReceived>
      <PaymentSum>11</PaymentSum>
      <PaymentType>Unknown</PaymentType>
      <PromotionID>3</PromotionID>
      <PromotionItemDetails>sample string 5</PromotionItemDetails>
      <RemoteReference>sample string 15</RemoteReference>
      <RemoteTransactionIdentifier>sample string 14</RemoteTransactionIdentifier>
      <ResourceTag>sample string 13</ResourceTag>
      <ResultMessage>sample string 16</ResultMessage>
      <ShoppingCartLineID>9</ShoppingCartLineID>
      <VoucherGroupID>1</VoucherGroupID>
      <VoucherID>2</VoucherID>
    </Payment>
    <Payment>
      <ApplyToAll>true</ApplyToAll>
      <Code>sample string 4</Code>
      <CouponID>23</CouponID>
      <CustomerPersonID>6</CustomerPersonID>
      <Description>sample string 17</Description>
      <ManualOverrideGrossUnitPrice>20</ManualOverrideGrossUnitPrice>
      <ManualOverridePaymentValue>21</ManualOverridePaymentValue>
      <ManualOverrideTicketCategoryID>19</ManualOverrideTicketCategoryID>
      <PaymentDetails>sample string 18</PaymentDetails>
      <PaymentEngineID>10</PaymentEngineID>
      <PaymentLogID>22</PaymentLogID>
      <PaymentMethodSubtypeID>8</PaymentMethodSubtypeID>
      <PaymentReceived>12</PaymentReceived>
      <PaymentSum>11</PaymentSum>
      <PaymentType>Unknown</PaymentType>
      <PromotionID>3</PromotionID>
      <PromotionItemDetails>sample string 5</PromotionItemDetails>
      <RemoteReference>sample string 15</RemoteReference>
      <RemoteTransactionIdentifier>sample string 14</RemoteTransactionIdentifier>
      <ResourceTag>sample string 13</ResourceTag>
      <ResultMessage>sample string 16</ResultMessage>
      <ShoppingCartLineID>9</ShoppingCartLineID>
      <VoucherGroupID>1</VoucherGroupID>
      <VoucherID>2</VoucherID>
    </Payment>
  </Payments>
</Payments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.