Search documentation of stripe_elixir

# StripeElixir.Params.TopupCreateParams (stripe_elixir v0.1.0)

Copy Markdown View Source

Parameters for topup create.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.TopupCreateParams{
      amount: integer(),
      currency: String.t(),
      description: String.t() | nil,
      expand: [String.t()] | nil,
      metadata: map() | nil,
      source: String.t() | nil,
      statement_descriptor: String.t() | nil,
      transfer_group: String.t() | nil
    }

- `amount` - A positive integer representing how much to transfer.
- `currency` - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- `description` - An arbitrary string attached to the object. Often useful for displaying to users. Max length: 5000.
- `expand` - Specifies which fields in the response should be expanded.
- `metadata` - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
- `source` - The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see Testing Top-ups). Max length: 5000.
- `statement_descriptor` - Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. Max length: 15.
- `transfer_group` - A string that identifies this top-up as part of a group.