POST api/quote/{id}/payments
Add quote payment
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Guid identifier of Quote Header record |
globally unique identifier |
Required |
Body Parameters
Quote Payment detail to add
QuotePayment| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| Identifier | Collection of byte |
None. |
|
| IdentifierGuid | globally unique identifier |
None. |
|
| SaleHeaderID | integer |
None. |
|
| PaymentType | PaymentType |
None. |
|
| Amount | integer |
None. |
|
| Account | string |
String length: inclusive between 0 and 40 |
|
| AccountID | Collection of byte |
None. |
|
| AccountIDGuid | globally unique identifier |
None. |
|
| AccountType | AccountType |
None. |
|
| CardName | string |
String length: inclusive between 0 and 16 |
|
| AuthorisationNumber | string |
String length: inclusive between 0 and 16 |
|
| BankReference | string |
String length: inclusive between 0 and 40 |
|
| MerchantID | string |
String length: inclusive between 0 and 32 |
|
| TerminalID | string |
String length: inclusive between 0 and 32 |
|
| CardNumber |
Can be: CardNumber of Gift Card, Barcode of issued/redeemed voucher, etc |
string |
String length: inclusive between 0 and 32 |
| PaymentDate | date |
None. |
|
| PaymentDateString | string |
None. |
|
| InvRocNo | string |
String length: inclusive between 0 and 16 |
|
| ResponseCode | string |
String length: inclusive between 0 and 4 |
|
| Cashout | integer |
None. |
|
| IdempotentVoid | Collection of byte |
None. |
|
| IdempotentVoidGuid | globally unique identifier |
None. |
|
| Offline | boolean |
None. |
|
| Processed | Processed |
None. |
|
| STAN | string |
String length: inclusive between 0 and 10 |
|
| ResponseText | string |
None. |
|
| SaleHeaderGuid | Collection of byte |
Relation. This field may not always be loaded or used for updates. |
|
| SaleHeaderIdentifierGuid | globally unique identifier |
Relation. This field may not always be loaded or used for updates. |
Request Formats
application/json, text/json
{
"id": 1,
"identifier": "EfIi2BMd9kmGYTdDwNWr/A==",
"identifierGuid": "d822f211-1d13-49f6-8661-3743c0d5abfc",
"saleHeaderID": 2,
"paymentType": 3,
"amount": 4,
"account": "sample string 5",
"accountID": "4LKwJxltM0GqMW8JBuqtkg==",
"accountIDGuid": "27b0b2e0-6d19-4133-aa31-6f0906eaad92",
"accountType": 1,
"cardName": "sample string 6",
"authorisationNumber": "sample string 7",
"bankReference": "sample string 8",
"merchantID": "sample string 9",
"terminalID": "sample string 10",
"cardNumber": "sample string 11",
"paymentDate": "2026-04-03T06:18:28.8762444",
"paymentDateString": "sample string 12",
"invRocNo": "sample string 13",
"responseCode": "sample string 14",
"cashout": 1,
"idempotentVoid": "mLjsZMFNeUqG8OdFYh4FPg==",
"idempotentVoidGuid": "64ecb898-4dc1-4a79-86f0-e745621e053e",
"offline": true,
"processed": 1,
"stan": "sample string 15",
"responseText": "sample string 16",
"saleHeaderGuid": "+ZG6AeC3M0+gy1Tku1PppQ==",
"saleHeaderIdentifierGuid": "01ba91f9-b7e0-4f33-a0cb-54e4bb53e9a5"
}
application/xml, text/xml
<QuotePayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager"> <Account>sample string 5</Account> <AccountID>4LKwJxltM0GqMW8JBuqtkg==</AccountID> <AccountIDGuid>27b0b2e0-6d19-4133-aa31-6f0906eaad92</AccountIDGuid> <AccountType>1</AccountType> <Amount>4</Amount> <AuthorisationNumber>sample string 7</AuthorisationNumber> <BankReference>sample string 8</BankReference> <CardName>sample string 6</CardName> <CardNumber>sample string 11</CardNumber> <Cashout>1</Cashout> <ID>1</ID> <IdempotentVoid>mLjsZMFNeUqG8OdFYh4FPg==</IdempotentVoid> <IdempotentVoidGuid>64ecb898-4dc1-4a79-86f0-e745621e053e</IdempotentVoidGuid> <Identifier>EfIi2BMd9kmGYTdDwNWr/A==</Identifier> <IdentifierGuid>d822f211-1d13-49f6-8661-3743c0d5abfc</IdentifierGuid> <InvRocNo>sample string 13</InvRocNo> <MerchantID>sample string 9</MerchantID> <Offline>true</Offline> <PaymentDate>2026-04-03T06:18:28.8762444+00:00</PaymentDate> <PaymentDateString>sample string 12</PaymentDateString> <PaymentType>3</PaymentType> <Processed>1</Processed> <ResponseCode>sample string 14</ResponseCode> <ResponseText>sample string 16</ResponseText> <STAN>sample string 15</STAN> <SaleHeaderGuid>+ZG6AeC3M0+gy1Tku1PppQ==</SaleHeaderGuid> <SaleHeaderID>2</SaleHeaderID> <SaleHeaderIdentifierGuid>01ba91f9-b7e0-4f33-a0cb-54e4bb53e9a5</SaleHeaderIdentifierGuid> <TerminalID>sample string 10</TerminalID> </QuotePayment>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Returns a newly added payment record
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel
Sample not available.