POST api/order/Payment/Tokenized/Save

Allows for storage of a Tokenized Payment Processor's payment transaction details on an order. This request is for storing records assumed to be created externally and does not make any transactional requests.

Request Information

URI Parameters

None.

Body Parameters

TokenizedPaymentViewModel
NameDescriptionTypeAdditional information
OrderID

The OrderID to associate the payment record with.

 integer

Required
PaymentDate

Date of the Payment Record.

 date

None.
Amount

Amount to associate the payment.

 decimal number

Required
Status

string

None.
TokenizedPaymentAccountID

Tokenized AccountID to reference on the payment record.

 integer

Required
MarketShowID

The MarketShow ID for the payment record.

 integer

None.
Detail1

Detail1 for the payment record. The data required is processor dependent.

 string

None.
Detail2

Detail2 for the payment record. The data required is processor dependent.

 string

None.
Detail3

Detail3 for the payment record. The data required is processor dependent.

 string

None.
Detail4

Detail4 for the payment record. The data required is processor dependent.

 string

None.
Detail5

Detail5 for the payment record. The data required is processor dependent.

 string

None.
Detail6

Detail6 for the payment record. The data required is processor dependent.

 string

None.
Detail7

Detail7 for the payment record. The data required is processor dependent.

 string

None.
Detail8

Detail8 for the payment record. The data required is processor dependent.

 string

None.
Detail9

Detail9 for the payment record. The data required is processor dependent.

 string

None.
Detail10

Detail10 for the payment record. The data required is processor dependent.

 string

None.
Detail11

Detail11 for the payment record. The data required is processor dependent.

 string

None.
Detail12

Detail12 for the payment record. The data required is processor dependent.

 string

None.
Detail13

Detail13 for the payment record. The data required is processor dependent.

 string

None.
Detail14

Detail14 for the payment record. The data required is processor dependent.

 string

None.
Detail15

Detail15 for the payment record. The data required is processor dependent.

 string

None.
Detail16

Detail16 for the payment record. The data required is processor dependent.

 string

None.
Detail17

Detail17 for the payment record. The data required is processor dependent.

 string

None.
Detail18

Detail18 for the payment record. The data required is processor dependent.

 string

None.
Detail19

Detail19 for the payment record. The data required is processor dependent.

 string

None.

Request Formats

application/xml, text/xml

Sample: 
<TokenizedPaymentViewModel>
  <OrderID>1</OrderID>
  <PaymentDate>01/09/2025 02:06:53</PaymentDate>
  <Amount>3</Amount>
  <Status>sample string 4</Status>
  <StatusTypeID>5</StatusTypeID>
  <TokenizedPaymentAccountID>6</TokenizedPaymentAccountID>
  <MarketShowID>7</MarketShowID>
  <Detail1>sample string 8</Detail1>
  <Detail2>sample string 9</Detail2>
  <Detail3>sample string 10</Detail3>
  <Detail4>sample string 11</Detail4>
  <Detail5>sample string 12</Detail5>
  <Detail6>sample string 13</Detail6>
  <Detail7>sample string 14</Detail7>
  <Detail8>sample string 15</Detail8>
  <Detail9>sample string 16</Detail9>
  <Detail10>sample string 17</Detail10>
  <Detail11>sample string 18</Detail11>
  <Detail12>sample string 19</Detail12>
  <Detail13>sample string 20</Detail13>
  <Detail14>sample string 21</Detail14>
  <Detail15>sample string 22</Detail15>
  <Detail16>sample string 23</Detail16>
  <Detail17>sample string 24</Detail17>
  <Detail18>sample string 25</Detail18>
  <Detail19>sample string 26</Detail19>
</TokenizedPaymentViewModel>

application/json, text/json

Sample: 
{
  "OrderID": 1,
  "PaymentDate": "2025-01-09T02:06:53.7179528-05:00",
  "Amount": 3.0,
  "Status": "sample string 4",
  "TokenizedPaymentAccountID": 6,
  "MarketShowID": 7,
  "Detail1": "sample string 8",
  "Detail2": "sample string 9",
  "Detail3": "sample string 10",
  "Detail4": "sample string 11",
  "Detail5": "sample string 12",
  "Detail6": "sample string 13",
  "Detail7": "sample string 14",
  "Detail8": "sample string 15",
  "Detail9": "sample string 16",
  "Detail10": "sample string 17",
  "Detail11": "sample string 18",
  "Detail12": "sample string 19",
  "Detail13": "sample string 20",
  "Detail14": "sample string 21",
  "Detail15": "sample string 22",
  "Detail16": "sample string 23",
  "Detail17": "sample string 24",
  "Detail18": "sample string 25",
  "Detail19": "sample string 26"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'TokenizedPaymentViewModel'.

Response Information

Resource Description

ApiResultOfPaymentViewModel
NameDescriptionTypeAdditional information
Result

PaymentViewModel

None.
IsSuccessful

boolean

None.
MessageTranslationKey

string

None.
Message

string

None.
Messages

Collection of ApiResultMessage

None.

Response Formats

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

Sample:

Sample not available.