POST api/order/Payment/Update
Allow update payment record using PaymentID. Only Details payment fields to be updated and only if bring some information. No other payment detail to be updated. (sensitive data).
Request Information
URI Parameters
None.
Body Parameters
PaymentViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Payment identifier. |
integer |
None. |
| PaymentTypeID |
Payment Type ID. |
integer |
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. |
| 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. |
Request Formats
application/xml, text/xml
<PaymentViewModel> <ID>1</ID> <PaymentTypeID>2</PaymentTypeID> <PaymentDate>01/09/2025 02:25:34</PaymentDate> <OrderID>1</OrderID> <Amount>4</Amount> <Detail1>sample string 5</Detail1> <Detail2>sample string 6</Detail2> <Detail3>sample string 7</Detail3> <Detail4>sample string 8</Detail4> <Detail5>sample string 9</Detail5> <Detail6>sample string 10</Detail6> <StatusTypeID>11</StatusTypeID> <MarketShowID>1</MarketShowID> <Detail7>sample string 12</Detail7> <Detail8>sample string 13</Detail8> <Detail9>sample string 14</Detail9> <Detail10>sample string 15</Detail10> <Detail11>sample string 16</Detail11> <Detail12>sample string 17</Detail12> <CCAccount>sample string 18</CCAccount> <CCAccountID>1</CCAccountID> <PartyPaymentID>1</PartyPaymentID> <PartyRewardID>1</PartyRewardID> <IsDoNotRecall>True</IsDoNotRecall> <ImportBatchID>20</ImportBatchID> <DataRepairNotes>sample string 21</DataRepairNotes> <DebitCardAccountID>1</DebitCardAccountID> <GiftCardAccountID>1</GiftCardAccountID> <ECheckAccountID>1</ECheckAccountID> <CurrencyTypeID>1</CurrencyTypeID> <Detail13>sample string 22</Detail13> <Detail14>sample string 23</Detail14> <Detail15>sample string 24</Detail15> <Detail16>sample string 25</Detail16> <Detail17>sample string 26</Detail17> <Detail18>sample string 27</Detail18> <DisconnectedAccountID>1</DisconnectedAccountID> <PartyID>1</PartyID> <IsBypass>True</IsBypass> <TokenizedPaymentAccountID>1</TokenizedPaymentAccountID> <Detail19>sample string 28</Detail19> <PromissoryAmount>29</PromissoryAmount> <PromissoryPaymentID>1</PromissoryPaymentID> <CreatedBy>sample string 30</CreatedBy> <DateCreated>01/09/2025 02:25:34</DateCreated> <LastModifiedBy>sample string 32</LastModifiedBy> <DateLastModified>01/09/2025 02:25:34</DateLastModified> <Detail20>sample string 33</Detail20> <Detail21>sample string 34</Detail21> <Detail22>sample string 35</Detail22> <Detail23>sample string 36</Detail23> <Detail24>sample string 37</Detail24> <Detail25>sample string 38</Detail25> </PaymentViewModel>
application/json, text/json
{
"ID": 1,
"PaymentTypeID": 2,
"PaymentDate": "2025-01-09T02:25:34.7593994-05:00",
"OrderID": 1,
"Amount": 4.0,
"Detail1": "sample string 5",
"Detail2": "sample string 6",
"Detail3": "sample string 7",
"Detail4": "sample string 8",
"Detail5": "sample string 9",
"Detail6": "sample string 10",
"StatusTypeID": 11,
"MarketShowID": 1,
"Detail7": "sample string 12",
"Detail8": "sample string 13",
"Detail9": "sample string 14",
"Detail10": "sample string 15",
"Detail11": "sample string 16",
"Detail12": "sample string 17",
"CCAccount": "sample string 18",
"CCAccountID": 1,
"PartyPaymentID": 1,
"PartyRewardID": 1,
"ImportBatchID": 20,
"DataRepairNotes": "sample string 21",
"DebitCardAccountID": 1,
"GiftCardAccountID": 1,
"ECheckAccountID": 1,
"CurrencyTypeID": 1,
"Detail13": "sample string 22",
"Detail14": "sample string 23",
"Detail15": "sample string 24",
"Detail16": "sample string 25",
"Detail17": "sample string 26",
"Detail18": "sample string 27",
"DisconnectedAccountID": 1,
"PartyID": 1,
"IsBypass": true,
"TokenizedPaymentAccountID": 1,
"Detail19": "sample string 28",
"PromissoryAmount": 29.0,
"CreatedBy": "sample string 30",
"LastModifiedBy": "sample string 32",
"DateLastModified": "2025-01-09T02:25:34.7594936-05:00",
"Detail20": "sample string 33",
"Detail21": "sample string 34",
"Detail22": "sample string 35",
"Detail23": "sample string 36",
"Detail24": "sample string 37",
"Detail25": "sample string 38"
}
application/x-www-form-urlencoded
Response Information
Resource Description
ApiResultOfPaymentViewModel| Name | Description | Type | Additional 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 not available.