POST check/active/{siteId}/{terminalId}/pay/cps

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

integer

Required

terminalId

integer

Required

Body Parameters

SavedCardFastPaymentRequest
NameDescriptionTypeAdditional information
checkId

integer

None.

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:
{
  "checkId": 1,
  "cardReference": "c278ee3b-e7e1-4dd2-a581-55ad3ddf2711",
  "cpsCustomerProfileId": "7d5fb814-4af2-44e6-9eac-4e95c3a09ca2",
  "cpsCompanyCode": "sample string 4",
  "amount": 5.0,
  "tipAmount": 6.0
}

application/xml, text/xml

Sample:
<SavedCardFastPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pay.Platform.Site.Core.Contracts.Requests">
  <amount>5</amount>
  <cardReference>c278ee3b-e7e1-4dd2-a581-55ad3ddf2711</cardReference>
  <checkId>1</checkId>
  <cpsCompanyCode>sample string 4</cpsCompanyCode>
  <cpsCustomerProfileId>7d5fb814-4af2-44e6-9eac-4e95c3a09ca2</cpsCustomerProfileId>
  <tipAmount>6</tipAmount>
</SavedCardFastPaymentRequest>

Response Information

Resource Description

CloudConnectResponse
NameDescriptionTypeAdditional information
message

string

None.

developerMessage

string

None.

code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "message": "sample string 1",
  "developerMessage": "sample string 2",
  "code": 3
}

application/xml, text/xml

Sample:
<CloudConnectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pay.Platform.CloudConnect.Models">
  <code>3</code>
  <developerMessage>sample string 2</developerMessage>
  <message>sample string 1</message>
</CloudConnectResponse>