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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

integer

Required

checkId

integer

Required

Body Parameters

SavedCardPaymentRequest
NameDescriptionTypeAdditional 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": "852fa77a-2ed3-40c8-a5a1-b4fba6487852",
  "cpsCustomerProfileId": "d7e2a2f4-e454-4bf5-99d6-dde0ab975638",
  "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>852fa77a-2ed3-40c8-a5a1-b4fba6487852</cardReference>
  <cpsCompanyCode>sample string 3</cpsCompanyCode>
  <cpsCustomerProfileId>d7e2a2f4-e454-4bf5-99d6-dde0ab975638</cpsCustomerProfileId>
  <tipAmount>5</tipAmount>
</SavedCardPaymentRequest>

Response Information

Resource Description

ApplyTenderPaymentResponse
NameDescriptionTypeAdditional 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>