PaymentIntent

  • addenda
    Type: string
    read-only
    required
  • balance_paid
    Type: string Pattern: ^-?\d{0,12}(?:\.\d{0,2})?$Format: decimal
    required
  • canceled_at
    Type: string | nullFormat: date-time
    read-only
    required

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

  • contact
    Type: object
    required
    • email
      Type: string | nullFormat: email
      read-only
      required
    • name
      Type: string
      read-only
      required
    • phone
      Type: string | null
      read-only
      required
    • secondary_email
      Type: string | nullFormat: email
      read-only
      required
    • uid
      Type: stringFormat: uuid
      read-only
      required
  • created_at
    Type: stringFormat: date-time
    read-only
    required

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

  • direction
    Type: integerenum
    required

    0: Inbound, 1: Outbound

    values
    • 0
    • 1
  • due_date
    Type: string | nullFormat: date
    read-only
    required

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • memo
    Type: string | null
    read-only
    required
  • note
    Type: string | null
    read-only
    required
  • paid_at
    Type: string | nullFormat: date-time
    read-only
    required

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

  • pending_at
    Type: string | nullFormat: date-time
    read-only
    required

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

  • status
    Type: string
    read-only
    required
  • total
    Type: string Pattern: ^-?\d{0,12}(?:\.\d{0,2})?$Format: decimal
    read-only
    required
  • transactions
    Type: array object[] ยท PaymentIntentTransaction[]
    required

    List of transactions associated with this payment intent. Only populated on retrieve, not on list or webhook payloads.

    • amount
      Type: string Pattern: ^-?\d{0,12}(?:\.\d{0,2})?$Format: decimal
      required
    • date
      Type: stringFormat: date-time
      required

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

    • direction
      Type: integerenum
      required

      0: Inbound, 1: Outbound

      values
      • 0
      • 1
    • payment_method
      Type: stringenum
      required
      • ach - Ach
      • book - Book
      • credit_card - Credit Card
      • check_deposit - Check Deposit
      • card_repayment - Card Repayment
      • uncontrolled - Uncontrolled
      • card_payment_intent - Card Payment Intent
      • push_to_card - Push To Card
      • astra_account_to_card - Astra Account To Card
      • check_payment - Check Payment
      • interest - Interest
      • legacy - Legacy
      • email - Email
      • direct_deposit - Direct Deposit
      • instant_payment - Instant Payment
      • check - Check
      • cash - Cash
      • bank_transfer - Bank Transfer
      • discount - Discount
      • other - Other
      values
      • ach
      • book
      • credit_card
      • check_deposit
      • card_repayment
    • status
      Type: stringenum
      required
      • ReturnedTransaction - Returned Transaction
      • RefundedTransaction - Refunded Transaction
      • CanceledTransaction - Canceled Transaction
      • ReturnTransaction - Return Transaction
      • RefundTransaction - Refund Transaction
      • PendingCredit - Pending Credit
      • AcceptedCredit - Accepted Credit
      • ProcessedCredit - Processed Credit
      • PaidDebit - Paid Debit
      • ProcessedDebit - Processed Debit
      • SettledDebit - Settled Debit
      • OnHold - On Hold
      • Error - Error
      • DraftCredit - Draft Credit
      • ExternalCredit - External Credit
      values
      • ReturnedTransaction
      • RefundedTransaction
      • CanceledTransaction
      • ReturnTransaction
      • RefundTransaction
    • type
      Type: stringenum
      required
      • transaction - Transaction
      • draft - Draft
      • external - External
      values
      • transaction
      • draft
      • external
    • uid
      Type: stringFormat: uuid
      required
    • addenda
      Type: string | null
    • posted_at
      Type: stringFormat: date-time

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

    • preprocessed_at
      Type: stringFormat: date-time

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

    • processed_at
      Type: stringFormat: date-time

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

    • returned_at
      Type: stringFormat: date-time

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

    • settled_at
      Type: stringFormat: date-time

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

  • uid
    Type: stringFormat: uuid
    read-only
    required