InvoicePaymentCollection

Payment attempts associated with the invoice.

  • data
    Type: array object[] · InvoicePayment[]
    required

    Payment attempts on the current page.

    A single attempt to collect payment for an invoice.

    • amount_paid
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

      Amount collected by this attempt, in the smallest currency unit.

    • amount_requested
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

      Amount Paypercut attempted to collect, in the smallest currency unit.

    • created
      Type: stringFormat: date-time
      required

      Time at which the invoice payment attempt was created.

    • currency
      Type: string
      required

      ISO 4217 currency codes (alpha3) supported for payments

    • id
      Type: string
      max length:  
      100
      required

      Unique identifier for the invoice payment attempt.

    • invoice
      Type: string
      max length:  
      100
      required

      Invoice collected by this payment attempt.

    • object
      enum
      const:  
      invoice_payment
      required
      values
      • invoice_payment
    • payment
      Type: object
      required

      Payment resource associated with an invoice payment attempt.

    • status
      Type: stringenum
      required

      Status of the invoice payment attempt.

      values
      • paid

        Payment attempt succeeded and contributed to amount_paid.

      • failed

        Payment attempt failed and did not collect funds.

      • requires_action

        Payment attempt requires customer action before it can complete.

    • failed_at
      Type: string | nullFormat: date-time

      Time at which this payment attempt failed.

    • paid_at
      Type: string | nullFormat: date-time

      Time at which this payment attempt succeeded.

  • has_more
    Type: boolean
    required

    Whether more payment attempts are available after the items returned in data.

  • object
    enum
    const:  
    list
    required

    String representing the collection type.

    values
    • list
  • url
    Type: string
    required

    API URL that can be used to list the full invoice payment collection.