ChargeTransaction

    • accountCategory
      enum
      const:  
      LOC_ACCOUNT
      required
    • amount
      Type: number
      min:  
      0
      required

      Absolute amount in USD. Use debitCreditMemo for direction.

    • debitCreditMemo
      Type: "CREDIT" or "DEBIT"enum
      required

      For deposits, DEBIT means money leaving and CREDIT means money entering the account. For charge accounts, DEBIT increases the amount owed and CREDIT represents a payment or credit.

    • description
      Type: string | null
      required
    • interestAmount
      Type: 0enum
      const:  
      0
      required
    • memo
      Type: string | null
      required
    • postedTimestamp
      Type: stringFormat: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • principalAmount
      Type: number
      required

      Zero for a purchase; the amount for a payment or credit.

    • status
      enum
      const:  
      POSTED
      required
    • transactionId
      Type: stringFormat: uuid
      required
    • transactionTimestamp
      Type: stringFormat: date-time
      required

      For deposits, the ledger activation time (also postedTimestamp). For charge accounts, the transaction's creation time.

    • transactionType
      Type: "PAYMENT" or "PURCHASE"enum
      required

      PURCHASE for a debit; PAYMENT for a payment or credit.

    • category
      Type: string

      Merchant category code, when known.

    • payee
      Type: string

      Merchant description, when present.

    • subCategory
      enum
      const:  
      MCC