CustomerPaymentV2

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CustomerPaymentV2",
  "description": "Details about customer payment.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-customer-payment-v2-schema.json",
  "type": "object",
  "properties": {
    "customerPaymentDue": {
      "type": "number",
      "nullable": true,
      "description": "The portion of the overall order cost that will be collected when the order is delivered, or when picked up by the customer at the store. This field should not be set if the order was pre-paid.",
      "example": 1
    },
    "customerPrepayment": {
      "type": "number",
      "nullable": true,
      "description": "The portion of the overall order cost that was paid upfront by the customer (online payment), with the remaining portion in the customerPaymentDue. In most cases the order value will be covered entirely by prepayment or entirely by payment_due. But in some cases mixing is allowed.",
      "example": 1
    },
    "customerAmountToReturn": {
      "type": "number",
      "nullable": true,
      "description": "Change (cash back) to be returned to the customer by the courier or store when the order has payment due value.\n\n Scenario:\n 1. Customer places an order for $7.50.\n 2. In the service app, after selecting Cash as payment type, the customer is presented with an additional field to indicate that order will be paid with a single $20 bill.\n 3. When the order is delivered, the courier should have $12.50 in cash on hand to complete the transaction.\n",
      "example": 1
    },
    "paymentDueToRestaurant": {
      "type": "number",
      "nullable": true,
      "description": "The portion of the overall order cost that was received directly by restaurant/store when the order is delivered or picked up. Should be used when customerPaymentDue is set. If payment due is entirely received by the store, customerPaymentDue and paymentDueToRestaurant will have the same value.",
      "example": 1
    }
  }
}