POST api/CustomerPayment/process-invoice-payment
Request Information
URI Parameters
None.
Body Parameters
ForwardPaymentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CardLast4 | string |
None. |
|
| CardFirst6 | string |
None. |
|
| Balance | string |
None. |
|
| Amount | string |
None. |
|
| DueAmount | string |
None. |
|
| PaidAmount | string |
None. |
|
| Name | string |
None. |
|
| Expiry | string |
None. |
|
| PaymentType | string |
None. |
|
| AccountType | string |
None. |
|
| Street | string |
None. |
|
| Country | string |
None. |
|
| ZipCode | string |
None. |
|
| TransactionID | integer |
None. |
|
| AccountID | integer |
None. |
|
| TransactionDate | string |
None. |
|
| TransactionNum | string |
None. |
|
| brand | string |
None. |
|
| subtype | string |
None. |
|
| ResultCode | string |
None. |
|
| RefNum | string |
None. |
|
| status | string |
None. |
|
| auth_response_text | string |
None. |
|
| settlement_status | string |
None. |
|
| SavePaymentMethod | boolean |
None. |
|
| payment_intent_id | string |
None. |
|
| payment_method_id | string |
None. |
|
| payment_id | string |
None. |
|
| recaptchaToken | string |
None. |
|
| FeePayer | string |
None. |
|
| Fee | string |
None. |
|
| cardFeePct | decimal number |
None. |
|
| achFeePct | decimal number |
None. |
|
| feeCap | decimal number |
None. |
|
| ProcessBy | string |
None. |
|
| initPayAmount | decimal number |
None. |
|
| InvoicePayments | Collection of Invoice |
None. |
|
| CurrencyCode | string |
None. |
|
| NotifyEmail | string |
None. |
|
| NotifyPhone | string |
None. |
|
| AmexFeePct | decimal number |
None. |
|
| CompanyID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"CardLast4": "sample string 1",
"CardFirst6": "sample string 2",
"Balance": "sample string 3",
"Amount": "sample string 4",
"DueAmount": "sample string 5",
"PaidAmount": "sample string 6",
"Name": "sample string 7",
"Expiry": "sample string 8",
"PaymentType": "sample string 9",
"AccountType": "sample string 10",
"Street": "sample string 11",
"Country": "sample string 12",
"ZipCode": "sample string 13",
"TransactionID": 14,
"AccountID": 15,
"TransactionDate": "sample string 16",
"TransactionNum": "sample string 17",
"brand": "sample string 18",
"subtype": "sample string 19",
"ResultCode": "sample string 20",
"RefNum": "sample string 21",
"status": "sample string 22",
"auth_response_text": "sample string 23",
"settlement_status": "sample string 24",
"SavePaymentMethod": true,
"payment_intent_id": "sample string 26",
"payment_method_id": "sample string 27",
"payment_id": "sample string 28",
"recaptchaToken": "sample string 29",
"FeePayer": "sample string 30",
"Fee": "sample string 31",
"cardFeePct": 32.0,
"achFeePct": 33.0,
"feeCap": 1.0,
"ProcessBy": "sample string 34",
"initPayAmount": 35.0,
"InvoicePayments": [
{
"TransactionID": 1,
"TransactionNum": "sample string 2",
"PaidAmount": 3.0
},
{
"TransactionID": 1,
"TransactionNum": "sample string 2",
"PaidAmount": 3.0
}
],
"CurrencyCode": "sample string 36",
"NotifyEmail": "sample string 37",
"NotifyPhone": "sample string 38",
"AmexFeePct": 39.0,
"CompanyID": 40
}
application/xml, text/xml
Sample:
<ForwardPaymentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccountingServices.Models">
<AccountID>15</AccountID>
<AccountType>sample string 10</AccountType>
<AmexFeePct>39</AmexFeePct>
<Amount>sample string 4</Amount>
<Balance>sample string 3</Balance>
<CardFirst6>sample string 2</CardFirst6>
<CardLast4>sample string 1</CardLast4>
<CompanyID>40</CompanyID>
<Country>sample string 12</Country>
<CurrencyCode>sample string 36</CurrencyCode>
<DueAmount>sample string 5</DueAmount>
<Expiry>sample string 8</Expiry>
<Fee>sample string 31</Fee>
<FeePayer>sample string 30</FeePayer>
<InvoicePayments>
<Invoice>
<PaidAmount>3</PaidAmount>
<TransactionID>1</TransactionID>
<TransactionNum>sample string 2</TransactionNum>
</Invoice>
<Invoice>
<PaidAmount>3</PaidAmount>
<TransactionID>1</TransactionID>
<TransactionNum>sample string 2</TransactionNum>
</Invoice>
</InvoicePayments>
<Name>sample string 7</Name>
<NotifyEmail>sample string 37</NotifyEmail>
<NotifyPhone>sample string 38</NotifyPhone>
<PaidAmount>sample string 6</PaidAmount>
<PaymentType>sample string 9</PaymentType>
<ProcessBy>sample string 34</ProcessBy>
<RefNum>sample string 21</RefNum>
<ResultCode>sample string 20</ResultCode>
<SavePaymentMethod>true</SavePaymentMethod>
<Street>sample string 11</Street>
<TransactionDate>sample string 16</TransactionDate>
<TransactionID>14</TransactionID>
<TransactionNum>sample string 17</TransactionNum>
<ZipCode>sample string 13</ZipCode>
<achFeePct>33</achFeePct>
<auth_response_text>sample string 23</auth_response_text>
<brand>sample string 18</brand>
<cardFeePct>32</cardFeePct>
<feeCap>1</feeCap>
<initPayAmount>35</initPayAmount>
<payment_id>sample string 28</payment_id>
<payment_intent_id>sample string 26</payment_intent_id>
<payment_method_id>sample string 27</payment_method_id>
<recaptchaToken>sample string 29</recaptchaToken>
<settlement_status>sample string 24</settlement_status>
<status>sample string 22</status>
<subtype>sample string 19</subtype>
</ForwardPaymentModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.