Payments

Payment transactions within orders.

Fields

Field Type Required Version Legacy Name Description
payment_guid guid No 1.0   Unique payment identifier
payment_type_id integer No 1.0   Reference to PaymentType
account_id integer No 1.0   Reference to Account
account_description string No 1.0   Denormalized account description
net_amount float No 1.0   Payment amount
tip float No 1.0 tip Tip amount
rounding float No 1.0   Rounding adjustment
change float No 1.0 change Change given to customer
cashback float No 1.0 cashback Cashback amount
customer_client_card_id integer No 1.0 customerClientCardRef Customer loyalty card reference
card_type_name string No 1.0   Card type name (Visa, Mastercard, etc.)
invoice_ref string No 1.0 invoiceRef Invoice reference number
invoice_customer_client_guid guid No 1.0 invoiceCustomerClientGuid Invoice customer GUID
psp_ref string No 1.1   Payment Service Provider transaction reference
par string No 1.1   Payment Account Reference (token)
payment_cancel_for_guid guid No 1.0   Reference to cancelled payment (for refunds)
soptid string No 1.0 soptid SOPT identifier
pms_ref string No 1.2   PMS (Property Management System) transfer reference

Example - Card Payment

{
  "payment_guid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "payment_type_id": 2,
  "account_id": 1900,
  "account_description": "Card Payments",
  "net_amount": 318.00,
  "tip": 50.00,
  "rounding": 0.0,
  "change": 0.0,
  "cashback": 0.0,
  "customer_client_card_id": null,
  "card_type_name": "Visa",
  "invoice_ref": null,
  "invoice_customer_client_guid": null,
  "psp_ref": "PSP-20241203-123456",
  "par": "DPAN1234567890",
  "payment_cancel_for_guid": null,
  "soptid": null,
  "pms_ref": null
}

Example - Cash Payment

{
  "payment_guid": "d4e5f6a7-b8c9-0123-def0-234567890123",
  "payment_type_id": 1,
  "account_id": 1000,
  "account_description": "Cash",
  "net_amount": 500.00,
  "tip": 0.0,
  "rounding": -0.50,
  "change": 181.50,
  "cashback": 0.0,
  "customer_client_card_id": null,
  "card_type_name": null,
  "invoice_ref": null,
  "invoice_customer_client_guid": null,
  "psp_ref": null,
  "par": null,
  "payment_cancel_for_guid": null,
  "soptid": null,
  "pms_ref": null
}

Example - Invoice Payment

{
  "payment_guid": "e5f6a7b8-c9d0-1234-ef01-345678901234",
  "payment_type_id": 5,
  "account_id": 1500,
  "account_description": "Accounts Receivable",
  "net_amount": 2500.00,
  "tip": 0.0,
  "rounding": 0.0,
  "change": 0.0,
  "cashback": 0.0,
  "customer_client_card_id": null,
  "card_type_name": null,
  "invoice_ref": "INV-2024-001234",
  "invoice_customer_client_guid": "f6a7b8c9-d0e1-2345-f012-456789012345",
  "psp_ref": null,
  "par": null,
  "payment_cancel_for_guid": null,
  "soptid": null,
  "pms_ref": null
}