POST api/ARInvoicesToCharge/AddInvoiceCreditCardPaymentRef
Request Information
URI Parameters
None.
Body Parameters
SaiCreditCardInvoicePaymentReference| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| InvoiceNum | string |
None. |
|
| AuthCode | string |
None. |
|
| AmountCharged | decimal number |
None. |
|
| Status | string |
None. |
|
| ARCustomerMasterId | string |
None. |
|
| Paymenttoken | string |
None. |
|
| Reference | string |
None. |
|
| ProcessingDateTime | date |
None. |
|
| Last4Digits | string |
None. |
|
| CardHolderName | string |
None. |
|
| PaymentServerResponse | Object |
None. |
|
| CardType | string |
None. |
|
| PriorityPaymentResponseStoreUrl | string |
None. |
|
| AuthMessage | string |
None. |
|
| MockContractIds | Collection of string |
None. |
|
| MockContractTotal | decimal number |
None. |
|
| InvoiceInfoSeqNum | integer |
None. |
|
| UserId | integer |
None. |
|
| UserName | string |
None. |
|
| EmvApplicationIdentifier | string |
None. |
|
| EmvApplicationName | string |
None. |
|
| EmvCryptogramType | string |
None. |
|
| EmvCryptogramValue | string |
None. |
|
| EmvVerificationType | string |
None. |
|
| LockedBy | string |
None. |
|
| CallNum | string |
None. |
|
| Source | string |
None. |
|
| Comments | string |
None. |
|
| IsVoid | boolean |
None. |
|
| AccountId | integer |
None. |
|
| CompanyId | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedOn | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"InvoiceNum": "sample string 2",
"AuthCode": "sample string 3",
"AmountCharged": 4.0,
"Status": "sample string 5",
"ARCustomerMasterId": "sample string 6",
"Paymenttoken": "sample string 7",
"Reference": "sample string 8",
"ProcessingDateTime": "2025-12-16T22:08:57.4255719+00:00",
"Last4Digits": "sample string 10",
"CardHolderName": "sample string 11",
"PaymentServerResponse": {},
"CardType": "sample string 13",
"PriorityPaymentResponseStoreUrl": "sample string 14",
"AuthMessage": "sample string 15",
"MockContractIds": [
"sample string 1",
"sample string 2"
],
"MockContractTotal": 16.0,
"InvoiceInfoSeqNum": 17,
"UserId": 18,
"UserName": "sample string 19",
"EmvApplicationIdentifier": "sample string 20",
"EmvApplicationName": "sample string 21",
"EmvCryptogramType": "sample string 22",
"EmvCryptogramValue": "sample string 23",
"EmvVerificationType": "sample string 24",
"LockedBy": "sample string 25",
"CallNum": "sample string 26",
"Source": "sample string 27",
"Comments": "sample string 28",
"IsVoid": true,
"AccountId": 30,
"CompanyId": "sample string 31",
"CreatedBy": "sample string 32",
"CreatedOn": "2025-12-16T22:08:57.4255719+00:00"
}
application/xml, text/xml
Sample:
<SaiCreditCardInvoicePaymentReference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.SAI">
<AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">30</AccountId>
<CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 31</CompanyId>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">sample string 32</CreatedBy>
<CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO">2025-12-16T22:08:57.4255719+00:00</CreatedOn>
<ARCustomerMasterId>sample string 6</ARCustomerMasterId>
<AmountCharged>4</AmountCharged>
<AuthCode>sample string 3</AuthCode>
<AuthMessage>sample string 15</AuthMessage>
<CallNum>sample string 26</CallNum>
<CardHolderName>sample string 11</CardHolderName>
<CardType>sample string 13</CardType>
<Comments>sample string 28</Comments>
<EmvApplicationIdentifier>sample string 20</EmvApplicationIdentifier>
<EmvApplicationName>sample string 21</EmvApplicationName>
<EmvCryptogramType>sample string 22</EmvCryptogramType>
<EmvCryptogramValue>sample string 23</EmvCryptogramValue>
<EmvVerificationType>sample string 24</EmvVerificationType>
<Id>1</Id>
<InvoiceInfoSeqNum>17</InvoiceInfoSeqNum>
<InvoiceNum>sample string 2</InvoiceNum>
<IsVoid>true</IsVoid>
<Last4Digits>sample string 10</Last4Digits>
<LockedBy>sample string 25</LockedBy>
<MockContractIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</MockContractIds>
<MockContractTotal>16</MockContractTotal>
<PaymentServerResponse />
<Paymenttoken>sample string 7</Paymenttoken>
<PriorityPaymentResponseStoreUrl>sample string 14</PriorityPaymentResponseStoreUrl>
<ProcessingDateTime>2025-12-16T22:08:57.4255719+00:00</ProcessingDateTime>
<Reference>sample string 8</Reference>
<Source>sample string 27</Source>
<Status>sample string 5</Status>
<UserId>18</UserId>
<UserName>sample string 19</UserName>
</SaiCreditCardInvoicePaymentReference>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ObjectNone.
Response Formats
application/json, text/json
Sample:
{}
application/xml, text/xml
Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />