POST check/{siteId}/{checkId}/pay/cps
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteId | integer |
Required |
|
checkId | integer |
Required |
Body Parameters
SavedCardPaymentRequestName | Description | Type | Additional information |
---|---|---|---|
cardReference | globally unique identifier |
None. |
|
cpsCustomerProfileId | globally unique identifier |
None. |
|
cpsCompanyCode | string |
None. |
|
amount | decimal number |
None. |
|
tipAmount | decimal number |
None. |
Request Formats
application/json, text/json
Sample:
{ "cardReference": "0a54e9e7-aea7-45bd-a79d-fb66a0d1a420", "cpsCustomerProfileId": "afaa7837-89f6-4c8a-954c-5e508124ea59", "cpsCompanyCode": "sample string 3", "amount": 4.0, "tipAmount": 5.0 }
application/xml, text/xml
Sample:
<SavedCardPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pay.Platform.Site.Core.Contracts.Requests"> <amount>4</amount> <cardReference>0a54e9e7-aea7-45bd-a79d-fb66a0d1a420</cardReference> <cpsCompanyCode>sample string 3</cpsCompanyCode> <cpsCustomerProfileId>afaa7837-89f6-4c8a-954c-5e508124ea59</cpsCustomerProfileId> <tipAmount>5</tipAmount> </SavedCardPaymentRequest>
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>