WalletDeposit

A wallet top-up and its charge state.

  • object
    Type: string

    Resource type identifier.

  • refunded_amount
    Type: integer

    Gross amount refunded so far, in the currency's minor unit; omitted until a refund lands. A refunded top-up keeps its succeeded status, and the refunded principal comes back out of the wallet balance.

  • charged_back_amount
    Type: integer

    Gross amount taken back by lost payment disputes, in the currency's minor unit; omitted until one lands. It is counted apart from refunded_amount, the two together never exceed total_amount, and a charged-back top-up keeps its succeeded status while the principal comes back out of the wallet balance.

  • invoice_id
    Type: string

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

  • payment_action
    Type: WalletPaymentAction

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

    Properties: 4
  • created_at
    Type: string

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

  • updated_at
    Type: string

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

  • 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: DepositFailureReasonenum

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

    values
    • card_declined = DepositFailureReasonCardDeclined
    • authentication_required = DepositFailureReasonAuthenticationRequired
    • auto_topup_exhausted = DepositFailureReasonAutoTopupExhausted
    • auto_topup_no_payment_method = DepositFailureReasonAutoTopupNoPaymentMethod
    • auto_topup_above_entitlement = DepositFailureReasonAutoTopupAboveEntitlement
  • 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.