WalletDeposit

A wallet top-up and its charge state.

  • object
    Type: string

    Resource type identifier.

  • id
    Type: string

    Deposit identifier (wdep_… typeid).

  • status
    Type: string

    Charge lifecycle state: pending, pending_action, succeeded, failed, canceled.

  • source
    Type: string

    How the top-up was initiated: manual (cardholder-present) or auto (off-session).

  • failure_reason
    Type: string · DepositFailureReasonenum

    Why the top-up failed; present only on a failed deposit.

    Stable, public classification of why a wallet top-up failed, present only on a failed deposit. Values are: - card_declined: the saved card was declined by the issuer - authentication_required: an off-session charge needed a 3DS challenge no auto-topup can satisfy - auto_topup_exhausted: auto-topup spent its retry budget and gave up - auto_topup_no_payment_method: auto-topup was armed but the org has no saved card

    values
    • card_declined = DepositFailureReasonCardDeclined
    • authentication_required = DepositFailureReasonAuthenticationRequired
    • auto_topup_exhausted = DepositFailureReasonAutoTopupExhausted
    • auto_topup_no_payment_method = DepositFailureReasonAutoTopupNoPaymentMethod
  • currency
    Type: string

    ISO 4217 currency the amounts are denominated in.

  • subtotal_amount
    Type: integer

    Spendable principal credited to the wallet, in the currency's minor unit.

  • tax_amount
    Type: integer

    Tax on the top-up, in the currency's minor unit. Zero today.

  • total_amount
    Type: integer

    Gross amount charged to the card, in the currency's minor unit.

  • invoice_id
    Type: string

    Local invoice identifier (binv_… typeid) for the hosted document; omitted until the invoice mirror links it.

  • payment_action
    Type: object · WalletPaymentAction

    Buyer action to complete a 3DS challenge; present only while the deposit is pending_action.

    Buyer action required to settle a wallet top-up (today: a 3DS challenge).

    • object
      Type: string

      Resource type identifier.

    • type
      enum
      const:  
      stripe_3ds

      Action kind. Today always stripe_3ds.

      values
      • stripe_3ds = WalletPaymentActionType3DS
    • client_secret
      Type: string

      Stripe client secret the frontend completes the challenge with. Sensitive.

    • publishable_key
      Type: string

      Stripe publishable key for the Elements / Stripe.js client.

  • created_at
    Type: string

    When the deposit was created, RFC 3339 (UTC).

  • updated_at
    Type: string

    When the deposit last changed, RFC 3339 (UTC).