Payment

  • allocatedAmount
    Type: integer
    required

    How much of the payment has been allocated to invoice lines. A payment collected for an invoice (invoiceId set) counts as allocated to it in full. Integer minor units (cents for USD).

  • amount
    Type: integer
    required

    How much was paid (for a failed payment, how much was due). Integer minor units (cents for USD).

  • balance
    Type: integer
    required

    What's left to allocate: amount less allocatedAmount for a posted or draft payment, and 0 for a failed one. Integer minor units (cents for USD).

  • createdAt
    Type: stringFormat: date-time
    required

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

  • currency
    Type: string
    required

    Three-letter ISO 4217 code, upper case.

  • customerId
    Type: string
    required

    The customer who paid.

  • id
    Type: string
    required

    The payment's ID.

  • invoiceId
    Type: string | null
    required

    The invoice this payment was collected for: set on payments Stripe collected (or failed to collect) for an invoice and on invoices marked paid in the dashboard. Null on payments you record, which reach invoices through allocations.

  • metadata
    Type: nullable
    required

    Your own key-value data, as recorded; null when none.

    Properties: 1
  • number
    Type: integer
    required

    A sequential number, in the order payments were recorded.

  • orderId
    Type: string | null
    required

    The order of the invoice in invoiceId, if any.

  • paymentDate
    Type: stringFormat: date-time
    required

    When the payment was made; when none was given, when it was recorded.

  • paymentType
    Type: stringenum
    required

    How it was paid. creditCard: a card (or Stripe Link). bankTransfer: a bank transfer or bank debit (including Bacs and SEPA Direct Debit). ach: a US ACH payment. cash. check: a cheque. manual: the invoice was marked paid in the dashboard without recording how.

    values
    creditCardbankTransferachcashcheckmanual
  • status
    Type: enum
    required

    posted: received and confirmed; it can be allocated to invoice lines. draft: recorded but not confirmed, and can't be allocated. failed: an attempt to collect that failed (Stripe couldn't charge the card); nothing was received.

    values
    posteddraftfailed
  • updatedAt
    Type: stringFormat: date-time
    required

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

Previous
PaymentStatus
Next
PaymentInput