POST check/{siteId}/{checkId}/pay
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteId | integer |
Required |
|
checkId | integer |
Required |
Body Parameters
PaymentRequestName | Description | Type | Additional information |
---|---|---|---|
tender | string |
None. |
|
amount | decimal number |
None. |
|
tipAmount | decimal number |
None. |
Request Formats
application/json, text/json
Sample:
{ "tender": "sample string 1", "amount": 2.0, "tipAmount": 3.0 }
application/xml, text/xml
Sample:
<PaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pay.Platform.Site.Core.Contracts.Requests"> <amount>2</amount> <tender>sample string 1</tender> <tipAmount>3</tipAmount> </PaymentRequest>
Response Information
Resource Description
ApplyTenderPaymentResponseName | Description | Type | Additional information |
---|---|---|---|
PaymentId | integer |
None. |
|
Code | ErrorCode |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "PaymentId": 1, "Code": 0, "Message": "" }
application/xml, text/xml
Sample:
<ApplyTenderPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pay.Platform.Site.Core.Contracts.Responses"> <Code>None</Code> <Message></Message> <PaymentId>1</PaymentId> </ApplyTenderPaymentResponse>