POST check/{siteId}/{checkId}/pay/cps

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId		integer	Required
checkId		integer	Required

Body Parameters

SavedCardPaymentRequest

Name	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": "99c128ea-7440-4231-9d31-f7441faa15a4",
  "cpsCustomerProfileId": "d5c5f783-718b-40ac-a6f5-80153ab0c88b",
  "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>99c128ea-7440-4231-9d31-f7441faa15a4</cardReference>
  <cpsCompanyCode>sample string 3</cpsCompanyCode>
  <cpsCustomerProfileId>d5c5f783-718b-40ac-a6f5-80153ab0c88b</cpsCustomerProfileId>
  <tipAmount>5</tipAmount>
</SavedCardPaymentRequest>

Response Information

Resource Description

ApplyTenderPaymentResponse

Name	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>