CarrierPaymentStatus

  • carrierId
    Type: string
    required

    Brokerage-side external carrier identifier (the externalId used elsewhere in the API). Resolved against (brokerageKey, carrierId), which is unique. Required on every entry.

  • status
    Type: string enum
    required

    Explicit payment status. OTHER is a catch-all for states not yet promoted to first-class enum values (e.g., PARTIAL, APPROVED, DISPUTED, FAILED); additional values may be added in a backward-compatible way.

    values
    • PAID
    • SCHEDULED
    • OTHER
  • actualPaymentDate
    Type: string Format: date

    Actual payment date (YYYY-MM-DD, UTC).

  • paymentMethod
    Type: string enum

    Payment method used.

    values
    • ACH
    • CHECK
  • paymentReferenceNumbers
    Type: array string[]

    Broker-side transaction or confirmation IDs associated with the payment (e.g., TriumphPay confirmation IDs). A list supports split payments and multiple confirmation IDs per payment.

  • scheduledPaymentDate
    Type: string Format: date

    Scheduled payment date (YYYY-MM-DD, UTC).