Packages
Complete Stripe SDK for Elixir with parity to the official Ruby SDK. V1+V2 coverage (193 services, 320 resource structs, 525 documented params). Per-event modules, Finch HTTP/2, RustyJSON, automatic retries, OAuth, webhooks, telemetry, per-client config, streaming pagination.
Current section
Files
Jump to
Current section
Files
lib/stripe/resources/payment_record.ex
# File generated from our OpenAPI spec
defmodule Stripe.Resources.PaymentRecord do
@moduledoc """
PaymentRecord
A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe.
For example, you can create a Payment Record to model a payment made on a different payment processor,
in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or
more Payment Attempt Records, which represent individual attempts made on a payment network.
"""
@typedoc """
* `amount` - Expandable.
* `amount_authorized` - Expandable.
* `amount_canceled` - Expandable.
* `amount_failed` - Expandable.
* `amount_guaranteed` - Expandable.
* `amount_refunded` - Expandable.
* `amount_requested` - Expandable.
* `application` - ID of the Connect application that created the PaymentRecord. Max length: 5000. Nullable.
* `created` - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
* `customer_details` - Customer information for this payment. Nullable. Expandable.
* `customer_presence` - Indicates whether the customer was present in your checkout flow during this payment. Possible values: `off_session`, `on_session`. Nullable.
* `description` - An arbitrary string attached to the object. Often useful for displaying to users. Max length: 5000. Nullable.
* `id` - Unique identifier for the object. Max length: 5000.
* `latest_payment_attempt_record` - ID of the latest Payment Attempt Record attached to this Payment Record. Max length: 5000. Nullable.
* `livemode` - Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
* `metadata` - Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* `object` - String representing the object's type. Objects of the same type share the same value. Possible values: `payment_record`.
* `payment_method_details` - Information about the Payment Method debited for this payment. Nullable. Expandable.
* `processor_details` - Expandable.
* `reported_by` - Indicates who reported the payment. Possible values: `self`, `stripe`.
* `shipping_details` - Shipping information for this payment. Nullable. Expandable.
"""
@type t :: %__MODULE__{
amount: map(),
amount_authorized: map(),
amount_canceled: map(),
amount_failed: map(),
amount_guaranteed: map(),
amount_refunded: map(),
amount_requested: map(),
application: String.t(),
created: integer(),
customer_details: map(),
customer_presence: String.t(),
description: String.t(),
id: String.t(),
latest_payment_attempt_record: String.t(),
livemode: boolean(),
metadata: map(),
object: String.t(),
payment_method_details: map(),
processor_details: map(),
reported_by: String.t(),
shipping_details: map()
}
defstruct [
:amount,
:amount_authorized,
:amount_canceled,
:amount_failed,
:amount_guaranteed,
:amount_refunded,
:amount_requested,
:application,
:created,
:customer_details,
:customer_presence,
:description,
:id,
:latest_payment_attempt_record,
:livemode,
:metadata,
:object,
:payment_method_details,
:processor_details,
:reported_by,
:shipping_details
]
@object_name "payment_record"
def object_name, do: @object_name
def expandable_fields,
do: [
"amount",
"amount_authorized",
"amount_canceled",
"amount_failed",
"amount_guaranteed",
"amount_refunded",
"amount_requested",
"customer_details",
"payment_method_details",
"processor_details",
"shipping_details"
]
defmodule Amount do
@moduledoc false
@typedoc """
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code.
* `value` - A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
"""
@type t :: %__MODULE__{
currency: String.t() | nil,
value: integer() | nil
}
defstruct [:currency, :value]
end
defmodule AmountAuthorized do
@moduledoc false
@typedoc """
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code.
* `value` - A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
"""
@type t :: %__MODULE__{
currency: String.t() | nil,
value: integer() | nil
}
defstruct [:currency, :value]
end
defmodule AmountCanceled do
@moduledoc false
@typedoc """
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code.
* `value` - A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
"""
@type t :: %__MODULE__{
currency: String.t() | nil,
value: integer() | nil
}
defstruct [:currency, :value]
end
defmodule AmountFailed do
@moduledoc false
@typedoc """
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code.
* `value` - A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
"""
@type t :: %__MODULE__{
currency: String.t() | nil,
value: integer() | nil
}
defstruct [:currency, :value]
end
defmodule AmountGuaranteed do
@moduledoc false
@typedoc """
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code.
* `value` - A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
"""
@type t :: %__MODULE__{
currency: String.t() | nil,
value: integer() | nil
}
defstruct [:currency, :value]
end
defmodule AmountRefunded do
@moduledoc false
@typedoc """
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code.
* `value` - A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
"""
@type t :: %__MODULE__{
currency: String.t() | nil,
value: integer() | nil
}
defstruct [:currency, :value]
end
defmodule AmountRequested do
@moduledoc false
@typedoc """
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code.
* `value` - A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
"""
@type t :: %__MODULE__{
currency: String.t() | nil,
value: integer() | nil
}
defstruct [:currency, :value]
end
defmodule CustomerDetails do
@moduledoc false
@typedoc """
* `customer` - ID of the Stripe Customer associated with this payment. Max length: 5000. Nullable.
* `email` - The customer's email address. Max length: 5000. Nullable.
* `name` - The customer's name. Max length: 5000. Nullable.
* `phone` - The customer's phone number. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
customer: String.t() | nil,
email: String.t() | nil,
name: String.t() | nil,
phone: String.t() | nil
}
defstruct [:customer, :email, :name, :phone]
end
defmodule PaymentMethodDetails do
@moduledoc false
@typedoc """
* `ach_credit_transfer`
* `ach_debit`
* `acss_debit`
* `affirm`
* `afterpay_clearpay`
* `alipay`
* `alma`
* `amazon_pay`
* `au_becs_debit`
* `bacs_debit`
* `bancontact`
* `billie`
* `billing_details` - The billing details associated with the method of payment. Nullable.
* `blik`
* `boleto`
* `card`
* `card_present`
* `cashapp`
* `crypto`
* `custom`
* `customer_balance`
* `eps`
* `fpx`
* `giropay`
* `grabpay`
* `ideal`
* `interac_present`
* `kakao_pay`
* `klarna`
* `konbini`
* `kr_card`
* `link`
* `mb_way`
* `mobilepay`
* `multibanco`
* `naver_pay`
* `nz_bank_account`
* `oxxo`
* `p24`
* `pay_by_bank`
* `payco`
* `payment_method` - ID of the Stripe PaymentMethod used to make this payment. Max length: 5000. Nullable.
* `paynow`
* `paypal`
* `payto`
* `pix`
* `promptpay`
* `revolut_pay`
* `samsung_pay`
* `satispay`
* `sepa_credit_transfer`
* `sepa_debit`
* `sofort`
* `stripe_account`
* `swish`
* `twint`
* `type` - The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
An additional hash is included on `payment_method_details` with a name matching this value.
It contains information specific to the payment method. Max length: 5000.
* `us_bank_account`
* `wechat`
* `wechat_pay`
* `zip`
"""
@type t :: %__MODULE__{
ach_credit_transfer: map() | nil,
ach_debit: map() | nil,
acss_debit: map() | nil,
affirm: map() | nil,
afterpay_clearpay: map() | nil,
alipay: map() | nil,
alma: map() | nil,
amazon_pay: map() | nil,
au_becs_debit: map() | nil,
bacs_debit: map() | nil,
bancontact: map() | nil,
billie: map() | nil,
billing_details: map() | nil,
blik: map() | nil,
boleto: map() | nil,
card: map() | nil,
card_present: map() | nil,
cashapp: map() | nil,
crypto: map() | nil,
custom: map() | nil,
customer_balance: map() | nil,
eps: map() | nil,
fpx: map() | nil,
giropay: map() | nil,
grabpay: map() | nil,
ideal: map() | nil,
interac_present: map() | nil,
kakao_pay: map() | nil,
klarna: map() | nil,
konbini: map() | nil,
kr_card: map() | nil,
link: map() | nil,
mb_way: map() | nil,
mobilepay: map() | nil,
multibanco: map() | nil,
naver_pay: map() | nil,
nz_bank_account: map() | nil,
oxxo: map() | nil,
p24: map() | nil,
pay_by_bank: map() | nil,
payco: map() | nil,
payment_method: String.t() | nil,
paynow: map() | nil,
paypal: map() | nil,
payto: map() | nil,
pix: map() | nil,
promptpay: map() | nil,
revolut_pay: map() | nil,
samsung_pay: map() | nil,
satispay: map() | nil,
sepa_credit_transfer: map() | nil,
sepa_debit: map() | nil,
sofort: map() | nil,
stripe_account: map() | nil,
swish: map() | nil,
twint: map() | nil,
type: String.t() | nil,
us_bank_account: map() | nil,
wechat: map() | nil,
wechat_pay: map() | nil,
zip: map() | nil
}
defstruct [
:ach_credit_transfer,
:ach_debit,
:acss_debit,
:affirm,
:afterpay_clearpay,
:alipay,
:alma,
:amazon_pay,
:au_becs_debit,
:bacs_debit,
:bancontact,
:billie,
:billing_details,
:blik,
:boleto,
:card,
:card_present,
:cashapp,
:crypto,
:custom,
:customer_balance,
:eps,
:fpx,
:giropay,
:grabpay,
:ideal,
:interac_present,
:kakao_pay,
:klarna,
:konbini,
:kr_card,
:link,
:mb_way,
:mobilepay,
:multibanco,
:naver_pay,
:nz_bank_account,
:oxxo,
:p24,
:pay_by_bank,
:payco,
:payment_method,
:paynow,
:paypal,
:payto,
:pix,
:promptpay,
:revolut_pay,
:samsung_pay,
:satispay,
:sepa_credit_transfer,
:sepa_debit,
:sofort,
:stripe_account,
:swish,
:twint,
:type,
:us_bank_account,
:wechat,
:wechat_pay,
:zip
]
defmodule AchCreditTransfer do
@moduledoc false
@typedoc """
* `account_number` - Account number to transfer funds to. Max length: 5000. Nullable.
* `bank_name` - Name of the bank associated with the routing number. Max length: 5000. Nullable.
* `routing_number` - Routing transit number for the bank account to transfer funds to. Max length: 5000. Nullable.
* `swift_code` - SWIFT code of the bank associated with the routing number. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
account_number: String.t() | nil,
bank_name: String.t() | nil,
routing_number: String.t() | nil,
swift_code: String.t() | nil
}
defstruct [:account_number, :bank_name, :routing_number, :swift_code]
end
defmodule AchDebit do
@moduledoc false
@typedoc """
* `account_holder_type` - Type of entity that holds the account. This can be either `individual` or `company`. Possible values: `company`, `individual`. Nullable.
* `bank_name` - Name of the bank associated with the bank account. Max length: 5000. Nullable.
* `country` - Two-letter ISO code representing the country the bank account is located in. Max length: 5000. Nullable.
* `fingerprint` - Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Max length: 5000. Nullable.
* `last4` - Last four digits of the bank account number. Max length: 5000. Nullable.
* `routing_number` - Routing transit number of the bank account. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
account_holder_type: String.t() | nil,
bank_name: String.t() | nil,
country: String.t() | nil,
fingerprint: String.t() | nil,
last4: String.t() | nil,
routing_number: String.t() | nil
}
defstruct [
:account_holder_type,
:bank_name,
:country,
:fingerprint,
:last4,
:routing_number
]
end
defmodule AcssDebit do
@moduledoc false
@typedoc """
* `bank_name` - Name of the bank associated with the bank account. Max length: 5000. Nullable.
* `expected_debit_date` - Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Max length: 5000.
* `fingerprint` - Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Max length: 5000. Nullable.
* `institution_number` - Institution number of the bank account Max length: 5000. Nullable.
* `last4` - Last four digits of the bank account number. Max length: 5000. Nullable.
* `mandate` - ID of the mandate used to make this payment. Max length: 5000.
* `transit_number` - Transit number of the bank account. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank_name: String.t() | nil,
expected_debit_date: String.t() | nil,
fingerprint: String.t() | nil,
institution_number: String.t() | nil,
last4: String.t() | nil,
mandate: String.t() | nil,
transit_number: String.t() | nil
}
defstruct [
:bank_name,
:expected_debit_date,
:fingerprint,
:institution_number,
:last4,
:mandate,
:transit_number
]
end
defmodule Affirm do
@moduledoc false
@typedoc """
* `location` - ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. Max length: 5000.
* `reader` - ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. Max length: 5000.
* `transaction_id` - The Affirm transaction ID associated with this payment. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
location: String.t() | nil,
reader: String.t() | nil,
transaction_id: String.t() | nil
}
defstruct [:location, :reader, :transaction_id]
end
defmodule AfterpayClearpay do
@moduledoc false
@typedoc """
* `order_id` - The Afterpay order ID associated with this payment intent. Max length: 5000. Nullable.
* `reference` - Order identifier shown to the merchant in Afterpay’s online portal. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
order_id: String.t() | nil,
reference: String.t() | nil
}
defstruct [:order_id, :reference]
end
defmodule Alipay do
@moduledoc false
@typedoc """
* `buyer_id` - Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. Max length: 5000.
* `fingerprint` - Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. Max length: 5000. Nullable.
* `transaction_id` - Transaction ID of this particular Alipay transaction. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
buyer_id: String.t() | nil,
fingerprint: String.t() | nil,
transaction_id: String.t() | nil
}
defstruct [:buyer_id, :fingerprint, :transaction_id]
end
defmodule Alma do
@moduledoc false
@typedoc """
* `installments`
* `transaction_id` - The Alma transaction ID associated with this payment. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
installments: map() | nil,
transaction_id: String.t() | nil
}
defstruct [:installments, :transaction_id]
defmodule Installments do
@moduledoc false
@typedoc """
* `count` - The number of installments.
"""
@type t :: %__MODULE__{
count: integer() | nil
}
defstruct [:count]
end
def __inner_types__ do
%{
"installments" => __MODULE__.Installments
}
end
end
defmodule AmazonPay do
@moduledoc false
@typedoc """
* `funding`
* `transaction_id` - The Amazon Pay transaction ID associated with this payment. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
funding: map() | nil,
transaction_id: String.t() | nil
}
defstruct [:funding, :transaction_id]
defmodule Funding do
@moduledoc false
@typedoc """
* `card`
* `type` - funding type of the underlying payment method. Possible values: `card`. Nullable.
"""
@type t :: %__MODULE__{
card: map() | nil,
type: String.t() | nil
}
defstruct [:card, :type]
defmodule Card do
@moduledoc false
@typedoc """
* `brand` - Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. Max length: 5000. Nullable.
* `country` - Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. Max length: 5000. Nullable.
* `exp_month` - Two-digit number representing the card's expiration month. Nullable.
* `exp_year` - Four-digit number representing the card's expiration year. Nullable.
* `funding` - Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Max length: 5000. Nullable.
* `last4` - The last four digits of the card. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
brand: String.t() | nil,
country: String.t() | nil,
exp_month: integer() | nil,
exp_year: integer() | nil,
funding: String.t() | nil,
last4: String.t() | nil
}
defstruct [:brand, :country, :exp_month, :exp_year, :funding, :last4]
end
def __inner_types__ do
%{
"card" => __MODULE__.Card
}
end
end
def __inner_types__ do
%{
"funding" => __MODULE__.Funding
}
end
end
defmodule AuBecsDebit do
@moduledoc false
@typedoc """
* `bsb_number` - Bank-State-Branch number of the bank account. Max length: 5000. Nullable.
* `expected_debit_date` - Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Max length: 5000.
* `fingerprint` - Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Max length: 5000. Nullable.
* `last4` - Last four digits of the bank account number. Max length: 5000. Nullable.
* `mandate` - ID of the mandate used to make this payment. Max length: 5000.
"""
@type t :: %__MODULE__{
bsb_number: String.t() | nil,
expected_debit_date: String.t() | nil,
fingerprint: String.t() | nil,
last4: String.t() | nil,
mandate: String.t() | nil
}
defstruct [:bsb_number, :expected_debit_date, :fingerprint, :last4, :mandate]
end
defmodule BacsDebit do
@moduledoc false
@typedoc """
* `expected_debit_date` - Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Max length: 5000.
* `fingerprint` - Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Max length: 5000. Nullable.
* `last4` - Last four digits of the bank account number. Max length: 5000. Nullable.
* `mandate` - ID of the mandate used to make this payment. Max length: 5000. Nullable.
* `sort_code` - Sort code of the bank account. (e.g., `10-20-30`) Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
expected_debit_date: String.t() | nil,
fingerprint: String.t() | nil,
last4: String.t() | nil,
mandate: String.t() | nil,
sort_code: String.t() | nil
}
defstruct [:expected_debit_date, :fingerprint, :last4, :mandate, :sort_code]
end
defmodule Bancontact do
@moduledoc false
@typedoc """
* `bank_code` - Bank code of bank associated with the bank account. Max length: 5000. Nullable.
* `bank_name` - Name of the bank associated with the bank account. Max length: 5000. Nullable.
* `bic` - Bank Identifier Code of the bank associated with the bank account. Max length: 5000. Nullable.
* `generated_sepa_debit` - The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. Nullable.
* `generated_sepa_debit_mandate` - The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. Nullable.
* `iban_last4` - Last four characters of the IBAN. Max length: 5000. Nullable.
* `preferred_language` - Preferred language of the Bancontact authorization page that the customer is redirected to.
Can be one of `en`, `de`, `fr`, or `nl` Possible values: `de`, `en`, `fr`, `nl`. Nullable.
* `verified_name` - Owner's verified full name. Values are verified or provided by Bancontact directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank_code: String.t() | nil,
bank_name: String.t() | nil,
bic: String.t() | nil,
generated_sepa_debit: String.t() | map() | nil,
generated_sepa_debit_mandate: String.t() | map() | nil,
iban_last4: String.t() | nil,
preferred_language: String.t() | nil,
verified_name: String.t() | nil
}
defstruct [
:bank_code,
:bank_name,
:bic,
:generated_sepa_debit,
:generated_sepa_debit_mandate,
:iban_last4,
:preferred_language,
:verified_name
]
end
defmodule Billie do
@moduledoc false
@typedoc """
* `transaction_id` - The Billie transaction ID associated with this payment. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
transaction_id: String.t() | nil
}
defstruct [:transaction_id]
end
defmodule BillingDetails do
@moduledoc false
@typedoc """
* `address`
* `email` - The billing email associated with the method of payment. Max length: 5000. Nullable.
* `name` - The billing name associated with the method of payment. Max length: 5000. Nullable.
* `phone` - The billing phone number associated with the method of payment. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
address: map() | nil,
email: String.t() | nil,
name: String.t() | nil,
phone: String.t() | nil
}
defstruct [:address, :email, :name, :phone]
defmodule Address do
@moduledoc false
@typedoc """
* `city` - City, district, suburb, town, or village. Max length: 5000. Nullable.
* `country` - Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Max length: 5000. Nullable.
* `line1` - Address line 1, such as the street, PO Box, or company name. Max length: 5000. Nullable.
* `line2` - Address line 2, such as the apartment, suite, unit, or building. Max length: 5000. Nullable.
* `postal_code` - ZIP or postal code. Max length: 5000. Nullable.
* `state` - State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
city: String.t() | nil,
country: String.t() | nil,
line1: String.t() | nil,
line2: String.t() | nil,
postal_code: String.t() | nil,
state: String.t() | nil
}
defstruct [:city, :country, :line1, :line2, :postal_code, :state]
end
def __inner_types__ do
%{
"address" => __MODULE__.Address
}
end
end
defmodule Blik do
@moduledoc false
@typedoc """
* `buyer_id` - A unique and immutable identifier assigned by BLIK to every buyer. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
buyer_id: String.t() | nil
}
defstruct [:buyer_id]
end
defmodule Boleto do
@moduledoc false
@typedoc """
* `tax_id` - The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) Max length: 5000.
"""
@type t :: %__MODULE__{
tax_id: String.t() | nil
}
defstruct [:tax_id]
end
defmodule Card do
@moduledoc false
@typedoc """
* `authorization_code` - The authorization code of the payment. Max length: 5000. Nullable.
* `brand` - Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. Possible values: `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `unknown`, `visa`.
* `capture_before` - When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured. Format: Unix timestamp.
* `checks` - Check results by Card networks on Card address and CVC at time of payment. Nullable.
* `country` - Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. Max length: 5000. Nullable.
* `description` - A high-level description of the type of cards issued in this range. Max length: 5000. Nullable.
* `exp_month` - Two-digit number representing the card's expiration month.
* `exp_year` - Four-digit number representing the card's expiration year.
* `fingerprint` - Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* Max length: 5000. Nullable.
* `funding` - Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Possible values: `credit`, `debit`, `prepaid`, `unknown`.
* `iin` - Issuer identification number of the card. Max length: 5000. Nullable.
* `installments` - Installment details for this payment. Nullable.
* `issuer` - The name of the card's issuing bank. Max length: 5000. Nullable.
* `last4` - The last four digits of the card. Max length: 5000.
* `moto` - True if this payment was marked as MOTO and out of scope for SCA.
* `network` - Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. Possible values: `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `unknown`, `visa`. Nullable.
* `network_advice_code` - Advice code from the card network for the failed payment. Max length: 5000. Nullable.
* `network_decline_code` - Decline code from the card network for the failed payment. Max length: 5000. Nullable.
* `network_token` - If this card has network token credentials, this contains the details of the network token credentials. Nullable.
* `network_transaction_id` - This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. Max length: 5000. Nullable.
* `stored_credential_usage` - The transaction type that was passed for an off-session, Merchant-Initiated transaction, one of `recurring` or `unscheduled`. Possible values: `recurring`, `unscheduled`. Nullable.
* `three_d_secure` - Populated if this transaction used 3D Secure authentication. Nullable.
* `wallet` - If this Card is part of a card wallet, this contains the details of the card wallet. Nullable.
"""
@type t :: %__MODULE__{
authorization_code: String.t() | nil,
brand: String.t() | nil,
capture_before: integer() | nil,
checks: map() | nil,
country: String.t() | nil,
description: String.t() | nil,
exp_month: integer() | nil,
exp_year: integer() | nil,
fingerprint: String.t() | nil,
funding: String.t() | nil,
iin: String.t() | nil,
installments: map() | nil,
issuer: String.t() | nil,
last4: String.t() | nil,
moto: boolean() | nil,
network: String.t() | nil,
network_advice_code: String.t() | nil,
network_decline_code: String.t() | nil,
network_token: map() | nil,
network_transaction_id: String.t() | nil,
stored_credential_usage: String.t() | nil,
three_d_secure: map() | nil,
wallet: map() | nil
}
defstruct [
:authorization_code,
:brand,
:capture_before,
:checks,
:country,
:description,
:exp_month,
:exp_year,
:fingerprint,
:funding,
:iin,
:installments,
:issuer,
:last4,
:moto,
:network,
:network_advice_code,
:network_decline_code,
:network_token,
:network_transaction_id,
:stored_credential_usage,
:three_d_secure,
:wallet
]
defmodule Checks do
@moduledoc false
@typedoc """
* `address_line1_check` - Possible values: `fail`, `pass`, `unavailable`, `unchecked`. Nullable.
* `address_postal_code_check` - Possible values: `fail`, `pass`, `unavailable`, `unchecked`. Nullable.
* `cvc_check` - Possible values: `fail`, `pass`, `unavailable`, `unchecked`. Nullable.
"""
@type t :: %__MODULE__{
address_line1_check: String.t() | nil,
address_postal_code_check: String.t() | nil,
cvc_check: String.t() | nil
}
defstruct [:address_line1_check, :address_postal_code_check, :cvc_check]
end
defmodule Installments do
@moduledoc false
@typedoc """
* `plan` - Nullable.
"""
@type t :: %__MODULE__{
plan: map() | nil
}
defstruct [:plan]
defmodule Plan do
@moduledoc false
@typedoc """
* `count` - For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. Nullable.
* `interval` - For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. One of `month`. Possible values: `month`. Nullable.
* `type` - Type of installment plan, one of `fixed_count`, `revolving`, or `bonus`. Possible values: `bonus`, `fixed_count`, `revolving`.
"""
@type t :: %__MODULE__{
count: integer() | nil,
interval: String.t() | nil,
type: String.t() | nil
}
defstruct [:count, :interval, :type]
end
def __inner_types__ do
%{
"plan" => __MODULE__.Plan
}
end
end
defmodule NetworkToken do
@moduledoc false
@typedoc """
* `used` - Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.
"""
@type t :: %__MODULE__{
used: boolean() | nil
}
defstruct [:used]
end
defmodule ThreeDSecure do
@moduledoc false
@typedoc """
* `authentication_flow` - Possible values: `challenge`, `frictionless`. Nullable.
* `result` - Possible values: `attempt_acknowledged`, `authenticated`, `exempted`, `failed`, `not_supported`, `processing_error`. Nullable.
* `result_reason` - Possible values: `abandoned`, `bypassed`, `canceled`, `card_not_enrolled`, `network_not_supported`, `protocol_error`, `rejected`. Nullable.
* `version` - Possible values: `1.0.2`, `2.1.0`, `2.2.0`. Nullable.
"""
@type t :: %__MODULE__{
authentication_flow: String.t() | nil,
result: String.t() | nil,
result_reason: String.t() | nil,
version: String.t() | nil
}
defstruct [:authentication_flow, :result, :result_reason, :version]
end
defmodule Wallet do
@moduledoc false
@typedoc """
* `apple_pay`
* `dynamic_last4` - (For tokenized numbers only.) The last four digits of the device account number. Max length: 5000.
* `google_pay`
* `type` - The type of the card wallet, one of `apple_pay` or `google_pay`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. Max length: 5000.
"""
@type t :: %__MODULE__{
apple_pay: map() | nil,
dynamic_last4: String.t() | nil,
google_pay: map() | nil,
type: String.t() | nil
}
defstruct [:apple_pay, :dynamic_last4, :google_pay, :type]
defmodule ApplePay do
@moduledoc false
@typedoc """
* `type` - Type of the apple_pay transaction, one of `apple_pay` or `apple_pay_later`. Max length: 5000.
"""
@type t :: %__MODULE__{
type: String.t() | nil
}
defstruct [:type]
end
def __inner_types__ do
%{
"apple_pay" => __MODULE__.ApplePay
}
end
end
def __inner_types__ do
%{
"checks" => __MODULE__.Checks,
"installments" => __MODULE__.Installments,
"network_token" => __MODULE__.NetworkToken,
"three_d_secure" => __MODULE__.ThreeDSecure,
"wallet" => __MODULE__.Wallet
}
end
end
defmodule CardPresent do
@moduledoc false
@typedoc """
* `amount_authorized` - The authorized amount Nullable.
* `brand` - Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. Max length: 5000. Nullable.
* `brand_product` - The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. Max length: 5000. Nullable.
* `capture_before` - When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. Format: Unix timestamp.
* `cardholder_name` - The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. Max length: 5000. Nullable.
* `country` - Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. Max length: 5000. Nullable.
* `description` - A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.) Max length: 5000. Nullable.
* `emv_auth_data` - Authorization response cryptogram. Max length: 5000. Nullable.
* `exp_month` - Two-digit number representing the card's expiration month.
* `exp_year` - Four-digit number representing the card's expiration year.
* `fingerprint` - Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* Max length: 5000. Nullable.
* `funding` - Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Max length: 5000. Nullable.
* `generated_card` - ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. Max length: 5000. Nullable.
* `iin` - Issuer identification number of the card. (For internal use only and not typically available in standard API requests.) Max length: 5000. Nullable.
* `incremental_authorization_supported` - Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
* `issuer` - The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.) Max length: 5000. Nullable.
* `last4` - The last four digits of the card. Max length: 5000. Nullable.
* `network` - Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. Max length: 5000. Nullable.
* `network_transaction_id` - This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. Max length: 5000. Nullable.
* `offline` - Details about payments collected offline. Nullable.
* `overcapture_supported` - Defines whether the authorized amount can be over-captured or not
* `preferred_locales` - The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. Nullable.
* `read_method` - How card details were read in this transaction. Possible values: `contact_emv`, `contactless_emv`, `contactless_magstripe_mode`, `magnetic_stripe_fallback`, `magnetic_stripe_track2`. Nullable.
* `receipt` - A collection of fields required to be displayed on receipts. Only required for EMV transactions. Nullable.
* `wallet`
"""
@type t :: %__MODULE__{
amount_authorized: integer() | nil,
brand: String.t() | nil,
brand_product: String.t() | nil,
capture_before: integer() | nil,
cardholder_name: String.t() | nil,
country: String.t() | nil,
description: String.t() | nil,
emv_auth_data: String.t() | nil,
exp_month: integer() | nil,
exp_year: integer() | nil,
fingerprint: String.t() | nil,
funding: String.t() | nil,
generated_card: String.t() | nil,
iin: String.t() | nil,
incremental_authorization_supported: boolean() | nil,
issuer: String.t() | nil,
last4: String.t() | nil,
network: String.t() | nil,
network_transaction_id: String.t() | nil,
offline: map() | nil,
overcapture_supported: boolean() | nil,
preferred_locales: [String.t()] | nil,
read_method: String.t() | nil,
receipt: map() | nil,
wallet: map() | nil
}
defstruct [
:amount_authorized,
:brand,
:brand_product,
:capture_before,
:cardholder_name,
:country,
:description,
:emv_auth_data,
:exp_month,
:exp_year,
:fingerprint,
:funding,
:generated_card,
:iin,
:incremental_authorization_supported,
:issuer,
:last4,
:network,
:network_transaction_id,
:offline,
:overcapture_supported,
:preferred_locales,
:read_method,
:receipt,
:wallet
]
defmodule Receipt do
@moduledoc false
@typedoc """
* `account_type` - The type of account being debited or credited Possible values: `checking`, `credit`, `prepaid`, `unknown`.
* `application_cryptogram` - The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers. Max length: 5000. Nullable.
* `application_preferred_name` - The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip. Max length: 5000. Nullable.
* `authorization_code` - Identifier for this transaction. Max length: 5000. Nullable.
* `authorization_response_code` - EMV tag 8A. A code returned by the card issuer. Max length: 5000. Nullable.
* `cardholder_verification_method` - Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. Max length: 5000. Nullable.
* `dedicated_file_name` - Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84. Max length: 5000. Nullable.
* `terminal_verification_results` - A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95. Max length: 5000. Nullable.
* `transaction_status_information` - An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
account_type: String.t() | nil,
application_cryptogram: String.t() | nil,
application_preferred_name: String.t() | nil,
authorization_code: String.t() | nil,
authorization_response_code: String.t() | nil,
cardholder_verification_method: String.t() | nil,
dedicated_file_name: String.t() | nil,
terminal_verification_results: String.t() | nil,
transaction_status_information: String.t() | nil
}
defstruct [
:account_type,
:application_cryptogram,
:application_preferred_name,
:authorization_code,
:authorization_response_code,
:cardholder_verification_method,
:dedicated_file_name,
:terminal_verification_results,
:transaction_status_information
]
end
defmodule Wallet do
@moduledoc false
@typedoc """
* `type` - The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`. Possible values: `apple_pay`, `google_pay`, `samsung_pay`, `unknown`.
"""
@type t :: %__MODULE__{
type: String.t() | nil
}
defstruct [:type]
end
def __inner_types__ do
%{
"receipt" => __MODULE__.Receipt,
"wallet" => __MODULE__.Wallet
}
end
end
defmodule Cashapp do
@moduledoc false
@typedoc """
* `buyer_id` - A unique and immutable identifier assigned by Cash App to every buyer. Max length: 5000. Nullable.
* `cashtag` - A public identifier for buyers using Cash App. Max length: 5000. Nullable.
* `transaction_id` - A unique and immutable identifier of payments assigned by Cash App Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
buyer_id: String.t() | nil,
cashtag: String.t() | nil,
transaction_id: String.t() | nil
}
defstruct [:buyer_id, :cashtag, :transaction_id]
end
defmodule Custom do
@moduledoc false
@typedoc """
* `display_name` - Display name for the custom (user-defined) payment method type used to make this payment. Max length: 5000.
* `type` - The custom payment method type associated with this payment. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
display_name: String.t() | nil,
type: String.t() | nil
}
defstruct [:display_name, :type]
end
defmodule Eps do
@moduledoc false
@typedoc """
* `bank` - The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. Possible values: `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, `vr_bank_braunau`. Nullable.
* `verified_name` - Owner's verified full name. Values are verified or provided by EPS directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
EPS rarely provides this information so the attribute is usually empty. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank: String.t() | nil,
verified_name: String.t() | nil
}
defstruct [:bank, :verified_name]
end
defmodule Fpx do
@moduledoc false
@typedoc """
* `account_holder_type` - Account holder type, if provided. Can be one of `individual` or `company`. Possible values: `company`, `individual`. Nullable.
* `bank` - The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`. Possible values: `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_of_china`, `bank_rakyat`, `bsn`, `cimb`, `deutsche_bank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2e`, `maybank2u`, `ocbc`, `pb_enterprise`, `public_bank`, `rhb`, `standard_chartered`, `uob`.
* `transaction_id` - Unique transaction id generated by FPX for every request from the merchant Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
account_holder_type: String.t() | nil,
bank: String.t() | nil,
transaction_id: String.t() | nil
}
defstruct [:account_holder_type, :bank, :transaction_id]
end
defmodule Giropay do
@moduledoc false
@typedoc """
* `bank_code` - Bank code of bank associated with the bank account. Max length: 5000. Nullable.
* `bank_name` - Name of the bank associated with the bank account. Max length: 5000. Nullable.
* `bic` - Bank Identifier Code of the bank associated with the bank account. Max length: 5000. Nullable.
* `verified_name` - Owner's verified full name. Values are verified or provided by Giropay directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
Giropay rarely provides this information so the attribute is usually empty. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank_code: String.t() | nil,
bank_name: String.t() | nil,
bic: String.t() | nil,
verified_name: String.t() | nil
}
defstruct [:bank_code, :bank_name, :bic, :verified_name]
end
defmodule Grabpay do
@moduledoc false
@typedoc """
* `transaction_id` - Unique transaction id generated by GrabPay Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
transaction_id: String.t() | nil
}
defstruct [:transaction_id]
end
defmodule Ideal do
@moduledoc false
@typedoc """
* `bank` - The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. Possible values: `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, `yoursafe`. Nullable.
* `bic` - The Bank Identifier Code of the customer's bank. Possible values: `ABNANL2A`, `ADYBNL2A`, `ASNBNL21`, `BITSNL2A`, `BUNQNL2A`, `BUUTNL2A`, `FNOMNL22`, `FVLBNL22`, `HANDNL2A`, `INGBNL2A`, `KNABNL2H`, `MLLENL2A`, `MOYONL21`, `NNBANL2G`, `NTSBDEB1`, `RABONL2U`, `RBRBNL21`, `REVOIE23`, `REVOLT21`, `SNSBNL2A`, `TRIONL2U`. Nullable.
* `generated_sepa_debit` - The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. Nullable.
* `generated_sepa_debit_mandate` - The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. Nullable.
* `iban_last4` - Last four characters of the IBAN. Max length: 5000. Nullable.
* `transaction_id` - Unique transaction ID generated by iDEAL. Max length: 5000. Nullable.
* `verified_name` - Owner's verified full name. Values are verified or provided by iDEAL directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank: String.t() | nil,
bic: String.t() | nil,
generated_sepa_debit: String.t() | map() | nil,
generated_sepa_debit_mandate: String.t() | map() | nil,
iban_last4: String.t() | nil,
transaction_id: String.t() | nil,
verified_name: String.t() | nil
}
defstruct [
:bank,
:bic,
:generated_sepa_debit,
:generated_sepa_debit_mandate,
:iban_last4,
:transaction_id,
:verified_name
]
end
defmodule InteracPresent do
@moduledoc false
@typedoc """
* `brand` - Card brand. Can be `interac`, `mastercard` or `visa`. Max length: 5000. Nullable.
* `cardholder_name` - The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. Max length: 5000. Nullable.
* `country` - Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. Max length: 5000. Nullable.
* `description` - A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.) Max length: 5000. Nullable.
* `emv_auth_data` - Authorization response cryptogram. Max length: 5000. Nullable.
* `exp_month` - Two-digit number representing the card's expiration month.
* `exp_year` - Four-digit number representing the card's expiration year.
* `fingerprint` - Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* Max length: 5000. Nullable.
* `funding` - Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Max length: 5000. Nullable.
* `generated_card` - ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. Max length: 5000. Nullable.
* `iin` - Issuer identification number of the card. (For internal use only and not typically available in standard API requests.) Max length: 5000. Nullable.
* `issuer` - The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.) Max length: 5000. Nullable.
* `last4` - The last four digits of the card. Max length: 5000. Nullable.
* `network` - Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. Max length: 5000. Nullable.
* `network_transaction_id` - This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. Max length: 5000. Nullable.
* `preferred_locales` - The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. Nullable.
* `read_method` - How card details were read in this transaction. Possible values: `contact_emv`, `contactless_emv`, `contactless_magstripe_mode`, `magnetic_stripe_fallback`, `magnetic_stripe_track2`. Nullable.
* `receipt` - A collection of fields required to be displayed on receipts. Only required for EMV transactions. Nullable.
"""
@type t :: %__MODULE__{
brand: String.t() | nil,
cardholder_name: String.t() | nil,
country: String.t() | nil,
description: String.t() | nil,
emv_auth_data: String.t() | nil,
exp_month: integer() | nil,
exp_year: integer() | nil,
fingerprint: String.t() | nil,
funding: String.t() | nil,
generated_card: String.t() | nil,
iin: String.t() | nil,
issuer: String.t() | nil,
last4: String.t() | nil,
network: String.t() | nil,
network_transaction_id: String.t() | nil,
preferred_locales: [String.t()] | nil,
read_method: String.t() | nil,
receipt: map() | nil
}
defstruct [
:brand,
:cardholder_name,
:country,
:description,
:emv_auth_data,
:exp_month,
:exp_year,
:fingerprint,
:funding,
:generated_card,
:iin,
:issuer,
:last4,
:network,
:network_transaction_id,
:preferred_locales,
:read_method,
:receipt
]
end
defmodule Klarna do
@moduledoc false
@typedoc """
* `payer_details` - The payer details for this transaction. Nullable.
* `payment_method_category` - The Klarna payment method used for this transaction.
Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` Max length: 5000. Nullable.
* `preferred_locale` - Preferred language of the Klarna authorization page that the customer is redirected to.
Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH` Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
payer_details: map() | nil,
payment_method_category: String.t() | nil,
preferred_locale: String.t() | nil
}
defstruct [:payer_details, :payment_method_category, :preferred_locale]
defmodule PayerDetails do
@moduledoc false
@typedoc """
* `address` - The payer's address Nullable.
"""
@type t :: %__MODULE__{
address: map() | nil
}
defstruct [:address]
defmodule Address do
@moduledoc false
@typedoc """
* `country` - The payer address country Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
country: String.t() | nil
}
defstruct [:country]
end
def __inner_types__ do
%{
"address" => __MODULE__.Address
}
end
end
def __inner_types__ do
%{
"payer_details" => __MODULE__.PayerDetails
}
end
end
defmodule Konbini do
@moduledoc false
@typedoc """
* `store` - If the payment succeeded, this contains the details of the convenience store where the payment was completed. Nullable.
"""
@type t :: %__MODULE__{
store: map() | nil
}
defstruct [:store]
defmodule Store do
@moduledoc false
@typedoc """
* `chain` - The name of the convenience store chain where the payment was completed. Possible values: `familymart`, `lawson`, `ministop`, `seicomart`. Nullable.
"""
@type t :: %__MODULE__{
chain: String.t() | nil
}
defstruct [:chain]
end
def __inner_types__ do
%{
"store" => __MODULE__.Store
}
end
end
defmodule Link do
@moduledoc false
@typedoc """
* `country` - Two-letter ISO code representing the funding source country beneath the Link payment.
You could use this attribute to get a sense of international fees. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
country: String.t() | nil
}
defstruct [:country]
end
defmodule Mobilepay do
@moduledoc false
@typedoc """
* `card` - Internal card details Nullable.
"""
@type t :: %__MODULE__{
card: map() | nil
}
defstruct [:card]
defmodule Card do
@moduledoc false
@typedoc """
* `brand` - Brand of the card used in the transaction Max length: 5000. Nullable.
* `country` - Two-letter ISO code representing the country of the card Max length: 5000. Nullable.
* `exp_month` - Two digit number representing the card's expiration month Nullable.
* `exp_year` - Two digit number representing the card's expiration year Nullable.
* `last4` - The last 4 digits of the card Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
brand: String.t() | nil,
country: String.t() | nil,
exp_month: integer() | nil,
exp_year: integer() | nil,
last4: String.t() | nil
}
defstruct [:brand, :country, :exp_month, :exp_year, :last4]
end
def __inner_types__ do
%{
"card" => __MODULE__.Card
}
end
end
defmodule Multibanco do
@moduledoc false
@typedoc """
* `entity` - Entity number associated with this Multibanco payment. Max length: 5000. Nullable.
* `reference` - Reference number associated with this Multibanco payment. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
entity: String.t() | nil,
reference: String.t() | nil
}
defstruct [:entity, :reference]
end
defmodule NzBankAccount do
@moduledoc false
@typedoc """
* `account_holder_name` - The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details. Max length: 5000. Nullable.
* `bank_code` - The numeric code for the bank account's bank. Max length: 5000.
* `bank_name` - The name of the bank. Max length: 5000.
* `branch_code` - The numeric code for the bank account's bank branch. Max length: 5000.
* `expected_debit_date` - Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Max length: 5000.
* `last4` - Last four digits of the bank account number. Max length: 5000.
* `suffix` - The suffix of the bank account number. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
account_holder_name: String.t() | nil,
bank_code: String.t() | nil,
bank_name: String.t() | nil,
branch_code: String.t() | nil,
expected_debit_date: String.t() | nil,
last4: String.t() | nil,
suffix: String.t() | nil
}
defstruct [
:account_holder_name,
:bank_code,
:bank_name,
:branch_code,
:expected_debit_date,
:last4,
:suffix
]
end
defmodule Oxxo do
@moduledoc false
@typedoc """
* `number` - OXXO reference number Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
number: String.t() | nil
}
defstruct [:number]
end
defmodule P24 do
@moduledoc false
@typedoc """
* `bank` - The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. Possible values: `alior_bank`, `bank_millennium`, `bank_nowy_bfg_sa`, `bank_pekao_sa`, `banki_spbdzielcze`, `blik`, `bnp_paribas`, `boz`, `citi_handlowy`, `credit_agricole`, `envelobank`, `etransfer_pocztowy24`, `getin_bank`, `ideabank`, `ing`, `inteligo`, `mbank_mtransfer`, `nest_przelew`, `noble_pay`, `pbac_z_ipko`, `plus_bank`, `santander_przelew24`, `tmobile_usbugi_bankowe`, `toyota_bank`, `velobank`, `volkswagen_bank`. Nullable.
* `reference` - Unique reference for this Przelewy24 payment. Max length: 5000. Nullable.
* `verified_name` - Owner's verified full name. Values are verified or provided by Przelewy24 directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
Przelewy24 rarely provides this information so the attribute is usually empty. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank: String.t() | nil,
reference: String.t() | nil,
verified_name: String.t() | nil
}
defstruct [:bank, :reference, :verified_name]
end
defmodule Paynow do
@moduledoc false
@typedoc """
* `location` - ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. Max length: 5000.
* `reader` - ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. Max length: 5000.
* `reference` - Reference number associated with this PayNow payment Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
location: String.t() | nil,
reader: String.t() | nil,
reference: String.t() | nil
}
defstruct [:location, :reader, :reference]
end
defmodule Paypal do
@moduledoc false
@typedoc """
* `country` - Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Max length: 5000. Nullable.
* `payer_email` - Owner's email. Values are provided by PayPal directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated. Max length: 5000. Nullable.
* `payer_id` - PayPal account PayerID. This identifier uniquely identifies the PayPal customer. Max length: 5000. Nullable.
* `payer_name` - Owner's full name. Values provided by PayPal directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated. Max length: 5000. Nullable.
* `seller_protection` - The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction. Nullable.
* `transaction_id` - A unique ID generated by PayPal for this transaction. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
country: String.t() | nil,
payer_email: String.t() | nil,
payer_id: String.t() | nil,
payer_name: String.t() | nil,
seller_protection: map() | nil,
transaction_id: String.t() | nil
}
defstruct [
:country,
:payer_email,
:payer_id,
:payer_name,
:seller_protection,
:transaction_id
]
defmodule SellerProtection do
@moduledoc false
@typedoc """
* `dispute_categories` - An array of conditions that are covered for the transaction, if applicable. Nullable.
* `status` - Indicates whether the transaction is eligible for PayPal's seller protection. Possible values: `eligible`, `not_eligible`, `partially_eligible`.
"""
@type t :: %__MODULE__{
dispute_categories: [String.t()] | nil,
status: String.t() | nil
}
defstruct [:dispute_categories, :status]
end
def __inner_types__ do
%{
"seller_protection" => __MODULE__.SellerProtection
}
end
end
defmodule Payto do
@moduledoc false
@typedoc """
* `bsb_number` - Bank-State-Branch number of the bank account. Max length: 5000. Nullable.
* `last4` - Last four digits of the bank account number. Max length: 5000. Nullable.
* `mandate` - ID of the mandate used to make this payment. Max length: 5000.
* `pay_id` - The PayID alias for the bank account. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bsb_number: String.t() | nil,
last4: String.t() | nil,
mandate: String.t() | nil,
pay_id: String.t() | nil
}
defstruct [:bsb_number, :last4, :mandate, :pay_id]
end
defmodule Pix do
@moduledoc false
@typedoc """
* `bank_transaction_id` - Unique transaction id generated by BCB Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank_transaction_id: String.t() | nil
}
defstruct [:bank_transaction_id]
end
defmodule Promptpay do
@moduledoc false
@typedoc """
* `reference` - Bill reference generated by PromptPay Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
reference: String.t() | nil
}
defstruct [:reference]
end
defmodule RevolutPay do
@moduledoc false
@typedoc """
* `funding`
* `transaction_id` - The Revolut Pay transaction ID associated with this payment. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
funding: map() | nil,
transaction_id: String.t() | nil
}
defstruct [:funding, :transaction_id]
defmodule Funding do
@moduledoc false
@typedoc """
* `card`
* `type` - funding type of the underlying payment method. Possible values: `card`. Nullable.
"""
@type t :: %__MODULE__{
card: map() | nil,
type: String.t() | nil
}
defstruct [:card, :type]
defmodule Card do
@moduledoc false
@typedoc """
* `brand` - Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. Max length: 5000. Nullable.
* `country` - Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. Max length: 5000. Nullable.
* `exp_month` - Two-digit number representing the card's expiration month. Nullable.
* `exp_year` - Four-digit number representing the card's expiration year. Nullable.
* `funding` - Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Max length: 5000. Nullable.
* `last4` - The last four digits of the card. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
brand: String.t() | nil,
country: String.t() | nil,
exp_month: integer() | nil,
exp_year: integer() | nil,
funding: String.t() | nil,
last4: String.t() | nil
}
defstruct [:brand, :country, :exp_month, :exp_year, :funding, :last4]
end
def __inner_types__ do
%{
"card" => __MODULE__.Card
}
end
end
def __inner_types__ do
%{
"funding" => __MODULE__.Funding
}
end
end
defmodule Satispay do
@moduledoc false
@typedoc """
* `transaction_id` - The Satispay transaction ID associated with this payment. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
transaction_id: String.t() | nil
}
defstruct [:transaction_id]
end
defmodule SepaCreditTransfer do
@moduledoc false
@typedoc """
* `bank_name` - Name of the bank associated with the bank account. Max length: 5000. Nullable.
* `bic` - Bank Identifier Code of the bank associated with the bank account. Max length: 5000. Nullable.
* `iban` - IBAN of the bank account to transfer funds to. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank_name: String.t() | nil,
bic: String.t() | nil,
iban: String.t() | nil
}
defstruct [:bank_name, :bic, :iban]
end
defmodule SepaDebit do
@moduledoc false
@typedoc """
* `bank_code` - Bank code of bank associated with the bank account. Max length: 5000. Nullable.
* `branch_code` - Branch code of bank associated with the bank account. Max length: 5000. Nullable.
* `country` - Two-letter ISO code representing the country the bank account is located in. Max length: 5000. Nullable.
* `expected_debit_date` - Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Max length: 5000.
* `fingerprint` - Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Max length: 5000. Nullable.
* `last4` - Last four characters of the IBAN. Max length: 5000. Nullable.
* `mandate` - Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve). Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank_code: String.t() | nil,
branch_code: String.t() | nil,
country: String.t() | nil,
expected_debit_date: String.t() | nil,
fingerprint: String.t() | nil,
last4: String.t() | nil,
mandate: String.t() | nil
}
defstruct [
:bank_code,
:branch_code,
:country,
:expected_debit_date,
:fingerprint,
:last4,
:mandate
]
end
defmodule Sofort do
@moduledoc false
@typedoc """
* `bank_code` - Bank code of bank associated with the bank account. Max length: 5000. Nullable.
* `bank_name` - Name of the bank associated with the bank account. Max length: 5000. Nullable.
* `bic` - Bank Identifier Code of the bank associated with the bank account. Max length: 5000. Nullable.
* `country` - Two-letter ISO code representing the country the bank account is located in. Max length: 5000. Nullable.
* `generated_sepa_debit` - The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. Nullable.
* `generated_sepa_debit_mandate` - The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. Nullable.
* `iban_last4` - Last four characters of the IBAN. Max length: 5000. Nullable.
* `preferred_language` - Preferred language of the SOFORT authorization page that the customer is redirected to.
Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` Possible values: `de`, `en`, `es`, `fr`, `it`, `nl`, `pl`. Nullable.
* `verified_name` - Owner's verified full name. Values are verified or provided by SOFORT directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
bank_code: String.t() | nil,
bank_name: String.t() | nil,
bic: String.t() | nil,
country: String.t() | nil,
generated_sepa_debit: String.t() | map() | nil,
generated_sepa_debit_mandate: String.t() | map() | nil,
iban_last4: String.t() | nil,
preferred_language: String.t() | nil,
verified_name: String.t() | nil
}
defstruct [
:bank_code,
:bank_name,
:bic,
:country,
:generated_sepa_debit,
:generated_sepa_debit_mandate,
:iban_last4,
:preferred_language,
:verified_name
]
end
defmodule Swish do
@moduledoc false
@typedoc """
* `fingerprint` - Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer Max length: 5000. Nullable.
* `payment_reference` - Payer bank reference number for the payment Max length: 5000. Nullable.
* `verified_phone_last4` - The last four digits of the Swish account phone number Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
fingerprint: String.t() | nil,
payment_reference: String.t() | nil,
verified_phone_last4: String.t() | nil
}
defstruct [:fingerprint, :payment_reference, :verified_phone_last4]
end
defmodule UsBankAccount do
@moduledoc false
@typedoc """
* `account_holder_type` - The type of entity that holds the account. This can be either 'individual' or 'company'. Possible values: `company`, `individual`. Nullable.
* `account_type` - The type of the bank account. This can be either 'checking' or 'savings'. Possible values: `checking`, `savings`. Nullable.
* `bank_name` - Name of the bank associated with the bank account. Max length: 5000. Nullable.
* `expected_debit_date` - Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Max length: 5000. Nullable.
* `fingerprint` - Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Max length: 5000. Nullable.
* `last4` - Last four digits of the bank account number. Max length: 5000. Nullable.
* `mandate` - ID of the mandate used to make this payment.
* `payment_reference` - The ACH payment reference for this transaction. Max length: 5000. Nullable.
* `routing_number` - The routing number for the bank account. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
account_holder_type: String.t() | nil,
account_type: String.t() | nil,
bank_name: String.t() | nil,
expected_debit_date: String.t() | nil,
fingerprint: String.t() | nil,
last4: String.t() | nil,
mandate: String.t() | map() | nil,
payment_reference: String.t() | nil,
routing_number: String.t() | nil
}
defstruct [
:account_holder_type,
:account_type,
:bank_name,
:expected_debit_date,
:fingerprint,
:last4,
:mandate,
:payment_reference,
:routing_number
]
end
defmodule WechatPay do
@moduledoc false
@typedoc """
* `fingerprint` - Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. Max length: 5000. Nullable.
* `location` - ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. Max length: 5000.
* `reader` - ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. Max length: 5000.
* `transaction_id` - Transaction ID of this particular WeChat Pay transaction. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
fingerprint: String.t() | nil,
location: String.t() | nil,
reader: String.t() | nil,
transaction_id: String.t() | nil
}
defstruct [:fingerprint, :location, :reader, :transaction_id]
end
def __inner_types__ do
%{
"ach_credit_transfer" => __MODULE__.AchCreditTransfer,
"ach_debit" => __MODULE__.AchDebit,
"acss_debit" => __MODULE__.AcssDebit,
"affirm" => __MODULE__.Affirm,
"afterpay_clearpay" => __MODULE__.AfterpayClearpay,
"alipay" => __MODULE__.Alipay,
"alma" => __MODULE__.Alma,
"amazon_pay" => __MODULE__.AmazonPay,
"au_becs_debit" => __MODULE__.AuBecsDebit,
"bacs_debit" => __MODULE__.BacsDebit,
"bancontact" => __MODULE__.Bancontact,
"billie" => __MODULE__.Billie,
"billing_details" => __MODULE__.BillingDetails,
"blik" => __MODULE__.Blik,
"boleto" => __MODULE__.Boleto,
"card" => __MODULE__.Card,
"card_present" => __MODULE__.CardPresent,
"cashapp" => __MODULE__.Cashapp,
"custom" => __MODULE__.Custom,
"eps" => __MODULE__.Eps,
"fpx" => __MODULE__.Fpx,
"giropay" => __MODULE__.Giropay,
"grabpay" => __MODULE__.Grabpay,
"ideal" => __MODULE__.Ideal,
"interac_present" => __MODULE__.InteracPresent,
"klarna" => __MODULE__.Klarna,
"konbini" => __MODULE__.Konbini,
"link" => __MODULE__.Link,
"mobilepay" => __MODULE__.Mobilepay,
"multibanco" => __MODULE__.Multibanco,
"nz_bank_account" => __MODULE__.NzBankAccount,
"oxxo" => __MODULE__.Oxxo,
"p24" => __MODULE__.P24,
"paynow" => __MODULE__.Paynow,
"paypal" => __MODULE__.Paypal,
"payto" => __MODULE__.Payto,
"pix" => __MODULE__.Pix,
"promptpay" => __MODULE__.Promptpay,
"revolut_pay" => __MODULE__.RevolutPay,
"satispay" => __MODULE__.Satispay,
"sepa_credit_transfer" => __MODULE__.SepaCreditTransfer,
"sepa_debit" => __MODULE__.SepaDebit,
"sofort" => __MODULE__.Sofort,
"swish" => __MODULE__.Swish,
"us_bank_account" => __MODULE__.UsBankAccount,
"wechat_pay" => __MODULE__.WechatPay
}
end
end
defmodule ProcessorDetails do
@moduledoc false
@typedoc """
* `custom`
* `type` - The processor used for this payment attempt. Possible values: `custom`.
"""
@type t :: %__MODULE__{
custom: map() | nil,
type: String.t() | nil
}
defstruct [:custom, :type]
defmodule Custom do
@moduledoc false
@typedoc """
* `payment_reference` - An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
payment_reference: String.t() | nil
}
defstruct [:payment_reference]
end
def __inner_types__ do
%{
"custom" => __MODULE__.Custom
}
end
end
defmodule ShippingDetails do
@moduledoc false
@typedoc """
* `address`
* `name` - The shipping recipient's name. Max length: 5000. Nullable.
* `phone` - The shipping recipient's phone number. Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
address: map() | nil,
name: String.t() | nil,
phone: String.t() | nil
}
defstruct [:address, :name, :phone]
defmodule Address do
@moduledoc false
@typedoc """
* `city` - City, district, suburb, town, or village. Max length: 5000. Nullable.
* `country` - Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Max length: 5000. Nullable.
* `line1` - Address line 1, such as the street, PO Box, or company name. Max length: 5000. Nullable.
* `line2` - Address line 2, such as the apartment, suite, unit, or building. Max length: 5000. Nullable.
* `postal_code` - ZIP or postal code. Max length: 5000. Nullable.
* `state` - State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Max length: 5000. Nullable.
"""
@type t :: %__MODULE__{
city: String.t() | nil,
country: String.t() | nil,
line1: String.t() | nil,
line2: String.t() | nil,
postal_code: String.t() | nil,
state: String.t() | nil
}
defstruct [:city, :country, :line1, :line2, :postal_code, :state]
end
def __inner_types__ do
%{
"address" => __MODULE__.Address
}
end
end
def __inner_types__ do
%{
"amount" => __MODULE__.Amount,
"amount_authorized" => __MODULE__.AmountAuthorized,
"amount_canceled" => __MODULE__.AmountCanceled,
"amount_failed" => __MODULE__.AmountFailed,
"amount_guaranteed" => __MODULE__.AmountGuaranteed,
"amount_refunded" => __MODULE__.AmountRefunded,
"amount_requested" => __MODULE__.AmountRequested,
"customer_details" => __MODULE__.CustomerDetails,
"payment_method_details" => __MODULE__.PaymentMethodDetails,
"processor_details" => __MODULE__.ProcessorDetails,
"shipping_details" => __MODULE__.ShippingDetails
}
end
end