TransactionEditRequest

Passthrough-only transaction edit payload. Use only for PSP flows where Koard forwards EMV data and later receives the final transaction state back from the PSP.

Partial-update semantics: omitted fields and fields set to null are preserved (unchanged). Only fields with an explicit non-null value are updated. A provided breakdown fully replaces the existing breakdown — sub-amounts are not merged.

  • authorized_amount
    Type: integer | null · Authorized Amount

    Replacement authorized amount in cents.

  • breakdown
    Type: object · TransactionEditBreakdown

    Replacement breakdown used when editing passthrough transactions.

    • subtotal
      Type: integer · Subtotal
      required

      Integer numbers.

    • taxAmount
      Type: integer | null · Tax Amount

      Integer numbers.

    • taxRate
      Type: integer | number | null · Tax Rate

      Tax rate as a percentage or basis points. Integer values >= 100 are treated as basis points and auto-divided by 100 (e.g., 875 becomes 8.75%). Float values < 100 are treated as percentages (e.g., 8.75 = 8.75%).

    • tipAmount
      Type: integer | null · Tip Amount

      Integer numbers.

    • tipRate
      Type: integer | number | null · Tip Rate

      Tip rate as a percentage or basis points. Integer values >= 100 are treated as basis points and auto-divided by 100 (e.g., 1500 becomes 15.0%). Float values < 100 are treated as percentages (e.g., 15.0 = 15%).

    • tipType
      Type: string | null · Tip Type
  • refunded
    Type: integer | null · Refunded

    Replacement cumulative refunded amount in cents.

  • reversed
    Type: integer | null · Reversed

    Replacement cumulative reversed amount in cents.

  • status
    Type: string · TransactionStatusenum

    Current status of a transaction. The surcharge_pending status indicates the transaction is awaiting cardholder confirmation of a surcharge via the confirm endpoint. surcharge_declined_by_payer means the cardholder rejected the surcharge and the transaction was canceled.

    values
    • pending
    • authorized
    • captured
    • settled
    • declined
  • status_reason
    Type: string | null · Status Reason

    Replacement status reason for the transaction.