GET api/order/Payment?orderID={orderID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of PaymentViewModel
NameDescriptionTypeAdditional information
id

Payment identifier.

 integer

None.
paymentTypeId

Payment Type ID.

 integer

None.
paymentType

Payment Type Description.

 string

None.
paymentDate

Payment Date.

 date

None.
orderId

OrderID.

 integer

None.
amount

Amount

 decimal number

None.
detail1

Payment detail 1. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail2

Payment detail 2. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail3

Payment detail 3. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail4

Payment detail 4. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail5

Payment detail 5. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail6

Payment detail 6. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
statusTypeId

Payment status identifier.

 integer

None.
marketShowId

Market Show identifier.

 integer

None.
detail7

Payment detail 7. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail8

Payment detail 8. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail9

Payment detail 9. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail10

Payment detail 10. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail11

Payment detail 11. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail12

Payment detail 12. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
ccAccount

Credit card account, if applicable.

 string

None.
ccAccountId

Credit card account identifier, if applicable.

 integer

None.
partyPaymentId

Party payment identifier, if applicable.

 integer

None.
partyRewardId

Party reward identifier, if applicable.

 integer

None.
importBatchId

Import Batch identifier.

 integer

None.
dataRepairNotes

Data Repair Notes.

 string

None.
debitCardAccountId

Debit card account identifier, if applicable.

 integer

None.
DebitCardProcessor_ProgrammingKey

Debit card Processor Programming key, if applicable.

 string

None.
giftCardAccountId

Gift card account identifier, if applicable.

 integer

None.
eCheckAccountId

E-check account identifier, if applicable.

 integer

None.
currencyTypeId

Currency type identifier.

 integer

None.
detail13

Payment detail 13. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail14

Payment detail 14. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail15

Payment detail 15. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail16

Payment detail 16. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail17

Payment detail 17. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail18

Payment detail 18. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
disconnectedAccountId

Disconnected account identifier.

 integer

None.
partyId

Party identifier, if applicable.

 integer

None.
isBypass

Indicates if this is a bypass payment record.

 boolean

None.
tokenizedPaymentAccountId

Tokenized payment account identifier, if applicable.

 integer

None.
detail19

Payment detail 19. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
promissoryAmount

Promissory amount.

 decimal number

None.
createdBy

Created By.

 string

None.
lastModifiedBy

Last Modified By.

 string

None.
dateLastModified

Date Last Modified.

 date

None.
detail20

Payment detail 20. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail21

Payment detail 21. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail22

Payment detail 22. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail23

Payment detail 23. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail24

Payment detail 24. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.
detail25

Payment detail 25. Referer to ByDesign Support to get the correct mapping per payment type.

 string

None.

Response Formats

application/xml, text/xml

Sample: 
<ListOfPaymentViewModel>
  <PaymentViewModel>
    <ID>1</ID>
    <PaymentTypeID>2</PaymentTypeID>
    <PaymentTypeDescription>sample string 3</PaymentTypeDescription>
    <PaymentDate>10/28/2025 17:40:25</PaymentDate>
    <OrderID>1</OrderID>
    <Amount>5</Amount>
    <Detail1>sample string 6</Detail1>
    <Detail2>sample string 7</Detail2>
    <Detail3>sample string 8</Detail3>
    <Detail4>sample string 9</Detail4>
    <Detail5>sample string 10</Detail5>
    <Detail6>sample string 11</Detail6>
    <StatusTypeID>12</StatusTypeID>
    <MarketShowID>1</MarketShowID>
    <Detail7>sample string 13</Detail7>
    <Detail8>sample string 14</Detail8>
    <Detail9>sample string 15</Detail9>
    <Detail10>sample string 16</Detail10>
    <Detail11>sample string 17</Detail11>
    <Detail12>sample string 18</Detail12>
    <CCAccount>sample string 19</CCAccount>
    <CCAccountID>1</CCAccountID>
    <PartyPaymentID>1</PartyPaymentID>
    <PartyRewardID>1</PartyRewardID>
    <IsDoNotRecall>True</IsDoNotRecall>
    <ImportBatchID>21</ImportBatchID>
    <DataRepairNotes>sample string 22</DataRepairNotes>
    <DebitCardAccountID>1</DebitCardAccountID>
    <DebitCardProcessor_ProgrammingKey>sample string 23</DebitCardProcessor_ProgrammingKey>
    <GiftCardAccountID>1</GiftCardAccountID>
    <ECheckAccountID>1</ECheckAccountID>
    <CurrencyTypeID>1</CurrencyTypeID>
    <Detail13>sample string 24</Detail13>
    <Detail14>sample string 25</Detail14>
    <Detail15>sample string 26</Detail15>
    <Detail16>sample string 27</Detail16>
    <Detail17>sample string 28</Detail17>
    <Detail18>sample string 29</Detail18>
    <DisconnectedAccountID>1</DisconnectedAccountID>
    <PartyID>1</PartyID>
    <IsBypass>True</IsBypass>
    <TokenizedPaymentAccountID>1</TokenizedPaymentAccountID>
    <Detail19>sample string 30</Detail19>
    <PromissoryAmount>31</PromissoryAmount>
    <PromissoryPaymentID>1</PromissoryPaymentID>
    <CreatedBy>sample string 32</CreatedBy>
    <DateCreated>10/28/2025 17:40:25</DateCreated>
    <LastModifiedBy>sample string 34</LastModifiedBy>
    <DateLastModified>10/28/2025 17:40:25</DateLastModified>
    <Detail20>sample string 35</Detail20>
    <Detail21>sample string 36</Detail21>
    <Detail22>sample string 37</Detail22>
    <Detail23>sample string 38</Detail23>
    <Detail24>sample string 39</Detail24>
    <Detail25>sample string 40</Detail25>
  </PaymentViewModel>
  <PaymentViewModel>
    <ID>1</ID>
    <PaymentTypeID>2</PaymentTypeID>
    <PaymentTypeDescription>sample string 3</PaymentTypeDescription>
    <PaymentDate>10/28/2025 17:40:25</PaymentDate>
    <OrderID>1</OrderID>
    <Amount>5</Amount>
    <Detail1>sample string 6</Detail1>
    <Detail2>sample string 7</Detail2>
    <Detail3>sample string 8</Detail3>
    <Detail4>sample string 9</Detail4>
    <Detail5>sample string 10</Detail5>
    <Detail6>sample string 11</Detail6>
    <StatusTypeID>12</StatusTypeID>
    <MarketShowID>1</MarketShowID>
    <Detail7>sample string 13</Detail7>
    <Detail8>sample string 14</Detail8>
    <Detail9>sample string 15</Detail9>
    <Detail10>sample string 16</Detail10>
    <Detail11>sample string 17</Detail11>
    <Detail12>sample string 18</Detail12>
    <CCAccount>sample string 19</CCAccount>
    <CCAccountID>1</CCAccountID>
    <PartyPaymentID>1</PartyPaymentID>
    <PartyRewardID>1</PartyRewardID>
    <IsDoNotRecall>True</IsDoNotRecall>
    <ImportBatchID>21</ImportBatchID>
    <DataRepairNotes>sample string 22</DataRepairNotes>
    <DebitCardAccountID>1</DebitCardAccountID>
    <DebitCardProcessor_ProgrammingKey>sample string 23</DebitCardProcessor_ProgrammingKey>
    <GiftCardAccountID>1</GiftCardAccountID>
    <ECheckAccountID>1</ECheckAccountID>
    <CurrencyTypeID>1</CurrencyTypeID>
    <Detail13>sample string 24</Detail13>
    <Detail14>sample string 25</Detail14>
    <Detail15>sample string 26</Detail15>
    <Detail16>sample string 27</Detail16>
    <Detail17>sample string 28</Detail17>
    <Detail18>sample string 29</Detail18>
    <DisconnectedAccountID>1</DisconnectedAccountID>
    <PartyID>1</PartyID>
    <IsBypass>True</IsBypass>
    <TokenizedPaymentAccountID>1</TokenizedPaymentAccountID>
    <Detail19>sample string 30</Detail19>
    <PromissoryAmount>31</PromissoryAmount>
    <PromissoryPaymentID>1</PromissoryPaymentID>
    <CreatedBy>sample string 32</CreatedBy>
    <DateCreated>10/28/2025 17:40:25</DateCreated>
    <LastModifiedBy>sample string 34</LastModifiedBy>
    <DateLastModified>10/28/2025 17:40:25</DateLastModified>
    <Detail20>sample string 35</Detail20>
    <Detail21>sample string 36</Detail21>
    <Detail22>sample string 37</Detail22>
    <Detail23>sample string 38</Detail23>
    <Detail24>sample string 39</Detail24>
    <Detail25>sample string 40</Detail25>
  </PaymentViewModel>
</ListOfPaymentViewModel>

application/json, text/json

Sample: 
[
  {
    "id": 1,
    "paymentTypeId": 2,
    "paymentType": "sample string 3",
    "paymentDate": "2025-10-28T17:40:25.6181615-04:00",
    "orderId": 1,
    "amount": 5.0,
    "detail1": "sample string 6",
    "detail2": "sample string 7",
    "detail3": "sample string 8",
    "detail4": "sample string 9",
    "detail5": "sample string 10",
    "detail6": "sample string 11",
    "statusTypeId": 12,
    "marketShowId": 1,
    "detail7": "sample string 13",
    "detail8": "sample string 14",
    "detail9": "sample string 15",
    "detail10": "sample string 16",
    "detail11": "sample string 17",
    "detail12": "sample string 18",
    "ccAccount": "sample string 19",
    "ccAccountId": 1,
    "partyPaymentId": 1,
    "partyRewardId": 1,
    "isDoNotRecall": true,
    "importBatchId": 21,
    "dataRepairNotes": "sample string 22",
    "debitCardAccountId": 1,
    "DebitCardProcessor_ProgrammingKey": "sample string 23",
    "giftCardAccountId": 1,
    "eCheckAccountId": 1,
    "currencyTypeId": 1,
    "detail13": "sample string 24",
    "detail14": "sample string 25",
    "detail15": "sample string 26",
    "detail16": "sample string 27",
    "detail17": "sample string 28",
    "detail18": "sample string 29",
    "disconnectedAccountId": 1,
    "partyId": 1,
    "isBypass": true,
    "tokenizedPaymentAccountId": 1,
    "detail19": "sample string 30",
    "promissoryAmount": 31.0,
    "promissoryPaymentId": 1,
    "createdBy": "sample string 32",
    "dateCreated": "2025-10-28T17:40:25.6181615-04:00",
    "lastModifiedBy": "sample string 34",
    "dateLastModified": "2025-10-28T17:40:25.6181615-04:00",
    "detail20": "sample string 35",
    "detail21": "sample string 36",
    "detail22": "sample string 37",
    "detail23": "sample string 38",
    "detail24": "sample string 39",
    "detail25": "sample string 40"
  },
  {
    "id": 1,
    "paymentTypeId": 2,
    "paymentType": "sample string 3",
    "paymentDate": "2025-10-28T17:40:25.6181615-04:00",
    "orderId": 1,
    "amount": 5.0,
    "detail1": "sample string 6",
    "detail2": "sample string 7",
    "detail3": "sample string 8",
    "detail4": "sample string 9",
    "detail5": "sample string 10",
    "detail6": "sample string 11",
    "statusTypeId": 12,
    "marketShowId": 1,
    "detail7": "sample string 13",
    "detail8": "sample string 14",
    "detail9": "sample string 15",
    "detail10": "sample string 16",
    "detail11": "sample string 17",
    "detail12": "sample string 18",
    "ccAccount": "sample string 19",
    "ccAccountId": 1,
    "partyPaymentId": 1,
    "partyRewardId": 1,
    "isDoNotRecall": true,
    "importBatchId": 21,
    "dataRepairNotes": "sample string 22",
    "debitCardAccountId": 1,
    "DebitCardProcessor_ProgrammingKey": "sample string 23",
    "giftCardAccountId": 1,
    "eCheckAccountId": 1,
    "currencyTypeId": 1,
    "detail13": "sample string 24",
    "detail14": "sample string 25",
    "detail15": "sample string 26",
    "detail16": "sample string 27",
    "detail17": "sample string 28",
    "detail18": "sample string 29",
    "disconnectedAccountId": 1,
    "partyId": 1,
    "isBypass": true,
    "tokenizedPaymentAccountId": 1,
    "detail19": "sample string 30",
    "promissoryAmount": 31.0,
    "promissoryPaymentId": 1,
    "createdBy": "sample string 32",
    "dateCreated": "2025-10-28T17:40:25.6181615-04:00",
    "lastModifiedBy": "sample string 34",
    "dateLastModified": "2025-10-28T17:40:25.6181615-04:00",
    "detail20": "sample string 35",
    "detail21": "sample string 36",
    "detail22": "sample string 37",
    "detail23": "sample string 38",
    "detail24": "sample string 39",
    "detail25": "sample string 40"
  }
]