InvoicePayment

A single attempt to collect payment for an invoice.

  • 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.

  • 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.

  • amount_requested
    Type: amountWithCurrencyPrecisionFormat: int64
    required

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

  • amount_paid
    Type: amountWithCurrencyPrecisionFormat: int64
    required

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

  • currency
    Type: CurrencyCode
    required

    ISO 4217 currency codes (alpha3) supported for payments

  • payment
    Type: InvoicePaymentReference
    required

    Payment resource associated with an invoice payment attempt.

    Properties: 3
  • created
    Type: stringFormat: date-time
    required

    Time at which the invoice payment attempt was created.

  • paid_at
    Type: string | nullFormat: date-time

    Time at which this payment attempt succeeded.

  • failed_at
    Type: string | nullFormat: date-time

    Time at which this payment attempt failed.

  • object
    enum
    const:  
    invoice_payment
    required