Clover · Example Payload

Platform Rest Api Payment Example

RestaurantPOSPaymentsRetailSMBHardware

Platform Rest Api Payment Example is an example object payload from Clover, with 44 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idorderdevicetenderamounttipAmounttaxAmountcashbackAmountcashTenderedexternalPaymentIdemployeecreatedTimeclientCreatedTimegatewayProcessingTimemodifiedTimeofflineresultcardTransactionserviceChargeattributesadditionalChargestaxRatesrefundsnotelineItemPaymentsauthorizationvoidPaymentRefvoidReasonvoidReasonDetailsdccInfotransactionSettingsgermanInfoappTrackingcashAdvanceExtratransactionInfosignatureDisclaimerexternalReferenceIdmerchantincrementspurchaseCardL2purchaseCardL3oceanGatewayInfoterminalManagementComponentsemiInfo

Example Payload

Raw ↑ 
{
  "id": "9ABCDEF1234567",
  "order": {},
  "device": {},
  "tender": {},
  "amount": 1099,
  "tipAmount": 1099,
  "taxAmount": 1099,
  "cashbackAmount": 1099,
  "cashTendered": 1,
  "externalPaymentId": "9ABCDEF1234567",
  "employee": {},
  "createdTime": 1718153645000,
  "clientCreatedTime": 1718153645000,
  "gatewayProcessingTime": 1718153645000,
  "modifiedTime": 1718153645000,
  "offline": true,
  "result": "SUCCESS",
  "cardTransaction": {},
  "serviceCharge": {},
  "attributes": {},
  "additionalCharges": [],
  "taxRates": [],
  "refunds": [],
  "note": "Example note value.",
  "lineItemPayments": [],
  "authorization": {},
  "voidPaymentRef": {},
  "voidReason": "USER_CANCEL",
  "voidReasonDetails": {},
  "dccInfo": {},
  "transactionSettings": {},
  "germanInfo": {},
  "appTracking": {},
  "cashAdvanceExtra": {},
  "transactionInfo": {},
  "signatureDisclaimer": {},
  "externalReferenceId": "9ABCDEF1234567",
  "merchant": {},
  "increments": [],
  "purchaseCardL2": {},
  "purchaseCardL3": {},
  "oceanGatewayInfo": {},
  "terminalManagementComponents": [],
  "emiInfo": {}
}