← API reference
CANONICAL TYPE REFERENCE

OTCRecordPaymentPayload

Result of recordPayment: the payment ledger row, plus the updated invoice and, where linked, its order.

The ledger row written for this payment. Null when errors is non-empty.

The invoice after the payment: paidAmount re-derived from the payment ledger, status paid (with paidAt set) once the ledger total reaches the invoice total, otherwise partiallyPaid. Null when errors is non-empty.

The order behind the invoice, with paymentStatus rolled up to paid or partiallyPaid. Null when the invoice is not linked to an order (or on failure).

Field-level validation errors — a non-positive amount, an unknown invoice, or an unpayable invoice status. Empty on success.

View exact SDL
"""
Result of `recordPayment`: the payment ledger row, plus the updated invoice and, where linked, its order.
"""
type OTCRecordPaymentPayload {
  """
  The ledger row written for this payment. Null when `errors` is non-empty.
  """
  payment: PaymentState
  """
  The invoice after the payment: `paidAmount` re-derived from the payment ledger, status `paid` (with `paidAt` set) once the ledger total reaches the invoice total, otherwise `partiallyPaid`. Null when `errors` is non-empty.
  """
  invoice: InvoiceState
  """
  The order behind the invoice, with `paymentStatus` rolled up to `paid` or `partiallyPaid`. Null when the invoice is not linked to an order (or on failure).
  """
  order: OrderState
  """
  Field-level validation errors — a non-positive amount, an unknown invoice, or an unpayable invoice status. Empty on success.
  """
  errors: [FieldError!]!
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.