1. Live Endpoints
PearlPOS
  • Inbound
    • postMasterdata
      POST
    • postPOSdata
      POST
  • Outbound
    • POSLog XSD
    • POSlog
      POST
  • Live Endpoints
    • getCustomers
      GET
    • getCustomerOrders
      GET
    • verifyDigitalArticle
      GET
    • verifyCustomerReference
      GET
    • purchaseDigitalArticle
      POST
    • getRelatedProducts
      GET
    • getSerialNumberVerification
      GET
    • getAvailableValueCodes
      POST
    • getValueCodes
      GET
    • getStockLevels
      GET
    • lookupPrices
      POST
    • lookupMargins
      POST
  • Schemas
    • TransactionType
    • RetailTransactionType
    • LineItemType
    • TransactionLinkType
    • SaleReturnType
    • RetailPriceModifierType
    • ActionAmountType
    • TaxType
    • CustomerInformationType
    • CustomerOrderType
    • TenderLineItemType
    • TenderType
    • AuthorizationType
    • RoundingType
    • VoidsLineItemType
    • PriceModificationType
    • TenderControlTransactionType
    • TillSettleType
    • TenderSummaryType
    • SummaryAmountType
    • ForeignSummaryAmountType
    • TenderLoanType
    • TenderPickupType
    • TotalsType
    • POSLog
  1. Live Endpoints

verifyCustomerReference

GET
/verifyCustomerReference
This endpoint shall be implemented by the customer system and called by PearlPOS to verify the reference entered when a customer pays on account. PearlPOS only calls it for customers with checkReference = true.
Always respond with HTTP 200. An invalid reference is not an error: return isValid = false and a message for the cashier. Any other HTTP status is treated as a technical error, and the reference is not accepted.

Request

Query Params

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/verifyCustomerReference?customerId=undefined&businessUnitId=undefined&reference=undefined'
Response Response Example
Valid reference
{
    "isValid": true,
    "message": null,
    "formatHint": "6 characters, 100000-999999"
}
Modified at 2026-10-01 14:14:19
Previous
verifyDigitalArticle
Next
purchaseDigitalArticle
Built with