Breakdown (with Surcharge)

Enhanced payment amount breakdown with surcharge support. Rates can be sent as integers (old SDK format, e.g., 875 = 8.75%) or floats (new SDK format, e.g., 8.75). Values >= 100 are auto-converted from basis points.

  • subtotal
    Type: integer
    required

    Subtotal amount in cents before tax, tip, and surcharge.

  • surcharge
    Type: nullable

    Surcharge configuration. When provided, surcharge is calculated and applied to the transaction total.

    Properties: 3
  • taxAmount
    Type: integer | null

    Tax amount in cents.

  • taxRate
    Type: number | null

    Tax rate as a float (e.g., 8.75 for 8.75%). Integer values >= 100 are auto-divided by 100 for backward compatibility.

  • tipAmount
    Type: integer | null

    Tip amount in cents.

  • tipRate
    Type: number | null

    Tip rate as a float (e.g., 15.0 for 15%). Integer values >= 100 are auto-divided by 100 for backward compatibility.

  • tipType
    Type: string | null

    Tip calculation method. One of: fixed, percentage.