Stripe: Sources schemas
41 Stripe schemas with complete fields and constraints.
← Sources operations · All schemas
Create a source — request body — body mandate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. |
acceptance | Model | Optional | Expand Create a source — request body — body mandate acceptance |
amount | JSON | Optional | |
amount (anyOf 1) | integer | Alternative | |
amount (anyOf 2) | string | Alternative | One of: |
currency | string | Optional | Format: currency |
interval | string | Optional | One of: one_time, scheduled, variable Maximum length: 5000 |
notification_method | string | Optional | One of: deprecated_none, email, manual, none, stripe_email Maximum length: 5000 |
Referenced models: Create a source — request body — body mandate acceptance
Create a source — request body — body mandate acceptance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | integer | Optional | Format: unix-time |
ip | string | Optional | |
offline | object | Optional | |
offline.contact_email | string | Required within parent | |
online | object | Optional | |
online.date | integer | Optional | Format: unix-time |
online.ip | string | Optional | |
online.user_agent | string | Optional | Maximum length: 5000 |
status | string | Required within parent | One of: accepted, pending, refused, revoked Maximum length: 5000 |
type | string | Optional | One of: offline, online Maximum length: 5000 |
user_agent | string | Optional | Maximum length: 5000 |
Create a source — request body — body owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the owner of the payment instrument that may be used or required by particular source types. |
address | object | Optional | |
address.city | string | Optional | Maximum length: 5000 |
address.country | string | Optional | Maximum length: 5000 |
address.line1 | string | Optional | Maximum length: 5000 |
address.line2 | string | Optional | Maximum length: 5000 |
address.postal_code | string | Optional | Maximum length: 5000 |
address.state | string | Optional | Maximum length: 5000 |
email | string | Optional | |
name | string | Optional | Maximum length: 5000 |
phone | string | Optional | Maximum length: 5000 |
Create a source — request body — body source order
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. |
items | array | Optional | |
items[] | object | Each item | |
items[].amount | integer | Optional | |
items[].currency | string | Optional | Format: currency |
items[].description | string | Optional | Maximum length: 1000 |
items[].parent | string | Optional | Maximum length: 5000 |
items[].quantity | integer | Optional | |
items[].type | string | Optional | One of: discount, shipping, sku, tax Maximum length: 5000 |
shipping | Model | Optional | Expand Create a source — request body — body source order shipping |
Referenced models: Create a source — request body — body source order shipping
Create a source — request body — body source order shipping
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | object | Required within parent | |
address.city | string | Optional | Maximum length: 5000 |
address.country | string | Optional | Maximum length: 5000 |
address.line1 | string | Required within parent | Maximum length: 5000 |
address.line2 | string | Optional | Maximum length: 5000 |
address.postal_code | string | Optional | Maximum length: 5000 |
address.state | string | Optional | Maximum length: 5000 |
carrier | string | Optional | Maximum length: 5000 |
name | string | Optional | Maximum length: 5000 |
phone | string | Optional | Maximum length: 5000 |
tracking_number | string | Optional | Maximum length: 5000 |
Create a source — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). |
ach_credit_transfer | Model | Optional | Expand Create a source — response body — ach credit transfer |
ach_debit | Model | Optional | Expand Create a source — response body — ach debit |
acss_debit | Model | Optional | Expand Create a source — response body — acss debit |
alipay | Model | Optional | Expand Create a source — response body — alipay |
allow_redisplay | JSON | Optional | |
allow_redisplay (anyOf 1) | string | Alternative | This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. Known values: always, limited, unspecified |
allow_redisplay (anyOf 2) | null | Alternative | |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | integer | Alternative | A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | |
au_becs_debit | Model | Optional | Expand Create a source — response body — au becs debit |
bancontact | Model | Optional | Expand Create a source — response body — bancontact |
card | Model | Optional | Expand Create a source — response body — card |
card_present | Model | Optional | Expand Create a source — response body — card present |
client_secret | string | Required within parent | The client secret of the source. Used for client-side retrieval using a publishable key. Maximum length: 5000 |
code_verification | Model | Optional | Expand Create a source — response body — code verification |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. Format: currency |
currency (anyOf 2) | null | Alternative | |
customer | string | Optional | The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. Maximum length: 5000 |
eps | Model | Optional | Expand Create a source — response body — eps |
flow | string | Required within parent | The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. Maximum length: 5000 |
giropay | Model | Optional | Expand Create a source — response body — giropay |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
ideal | Model | Optional | Expand Create a source — response body — ideal |
klarna | Model | Optional | Expand Create a source — response body — klarna |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | 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. Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | Maximum length: 500 |
metadata (anyOf 2) | null | Alternative | |
multibanco | Model | Optional | Expand Create a source — response body — multibanco |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: source |
owner | JSON | Optional | |
owner (anyOf 1) | JSON | Alternative | Information about the owner of the payment instrument that may be used or required by particular source types. |
owner (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a source — response body — owner value address, email, name, phone, verified address, verified email, verified name, verified phone |
owner (anyOf 2) | null | Alternative | |
p24 | Model | Optional | Expand Create a source — response body — p24 |
receiver | Model | Optional | Expand Create a source — response body — receiver |
redirect | Model | Optional | Expand Create a source — response body — redirect |
sepa_debit | Model | Optional | Expand Create a source — response body — sepa debit |
sofort | Model | Optional | Expand Create a source — response body — sofort |
source_order | Model | Optional | Expand Create a source — response body — source order |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | Extra information about a source. This will appear on your customer's statement every time you charge the source. Maximum length: 5000 |
statement_descriptor (anyOf 2) | null | Alternative | |
status | string | Required within parent | The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. Maximum length: 5000 |
three_d_secure | Model | Optional | Expand Create a source — response body — three d secure |
type | string | Required within parent | The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used. Known values: ach_credit_transfer, ach_debit, acss_debit, alipay, au_becs_debit, bancontact, card, card_present, eps, giropay, ideal, klarna, multibanco, p24, sepa_debit, sofort, three_d_secure, wechat |
usage | JSON | Optional | |
usage (anyOf 1) | string | Alternative | Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. Maximum length: 5000 |
usage (anyOf 2) | null | Alternative | |
wechat | Model | Optional | Expand Create a source — response body — wechat |
Referenced models: Create a source — response body — code verification, Create a source — response body — source order, Create a source — response body — owner value address, email, name, phone, verified address, verified email, verified name, verified phone, Create a source — response body — receiver, Create a source — response body — redirect, Create a source — response body — ach credit transfer, Create a source — response body — ach debit, Create a source — response body — acss debit, Create a source — response body — alipay, Create a source — response body — au becs debit, Create a source — response body — bancontact, Create a source — response body — card, Create a source — response body — card present, Create a source — response body — eps, Create a source — response body — giropay, Create a source — response body — ideal, Create a source — response body — klarna, Create a source — response body — multibanco, Create a source — response body — p24, Create a source — response body — sepa debit, Create a source — response body — sofort, Create a source — response body — three d secure, Create a source — response body — wechat
Create a source — response body — ach credit transfer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_number | JSON | Optional | |
account_number (anyOf 1) | string | Alternative | |
account_number (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | |
bank_name (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | |
fingerprint (anyOf 2) | null | Alternative | |
refund_account_holder_name | JSON | Optional | |
refund_account_holder_name (anyOf 1) | string | Alternative | |
refund_account_holder_name (anyOf 2) | null | Alternative | |
refund_account_holder_type | JSON | Optional | |
refund_account_holder_type (anyOf 1) | string | Alternative | |
refund_account_holder_type (anyOf 2) | null | Alternative | |
refund_routing_number | JSON | Optional | |
refund_routing_number (anyOf 1) | string | Alternative | |
refund_routing_number (anyOf 2) | null | Alternative | |
routing_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | |
routing_number (anyOf 2) | null | Alternative | |
swift_code | JSON | Optional | |
swift_code (anyOf 1) | string | Alternative | |
swift_code (anyOf 2) | null | Alternative |
Create a source — response body — ach debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | |
bank_name (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | |
last4 (anyOf 2) | null | Alternative | |
routing_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | |
routing_number (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | |
type (anyOf 2) | null | Alternative |
Create a source — response body — acss debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_address_city | JSON | Optional | |
bank_address_city (anyOf 1) | string | Alternative | |
bank_address_city (anyOf 2) | null | Alternative | |
bank_address_line_1 | JSON | Optional | |
bank_address_line_1 (anyOf 1) | string | Alternative | |
bank_address_line_1 (anyOf 2) | null | Alternative | |
bank_address_line_2 | JSON | Optional | |
bank_address_line_2 (anyOf 1) | string | Alternative | |
bank_address_line_2 (anyOf 2) | null | Alternative | |
bank_address_postal_code | JSON | Optional | |
bank_address_postal_code (anyOf 1) | string | Alternative | |
bank_address_postal_code (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | |
bank_name (anyOf 2) | null | Alternative | |
category | JSON | Optional | |
category (anyOf 1) | string | Alternative | |
category (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | |
last4 (anyOf 2) | null | Alternative | |
routing_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | |
routing_number (anyOf 2) | null | Alternative |
Create a source — response body — alipay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_string | JSON | Optional | |
data_string (anyOf 1) | string | Alternative | |
data_string (anyOf 2) | null | Alternative | |
native_url | JSON | Optional | |
native_url (anyOf 1) | string | Alternative | |
native_url (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | |
statement_descriptor (anyOf 2) | null | Alternative |
Create a source — response body — au becs debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bsb_number | JSON | Optional | |
bsb_number (anyOf 1) | string | Alternative | |
bsb_number (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | |
last4 (anyOf 2) | null | Alternative |
Create a source — response body — bancontact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_code | JSON | Optional | |
bank_code (anyOf 1) | string | Alternative | |
bank_code (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | |
bank_name (anyOf 2) | null | Alternative | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | |
bic (anyOf 2) | null | Alternative | |
iban_last4 | JSON | Optional | |
iban_last4 (anyOf 1) | string | Alternative | |
iban_last4 (anyOf 2) | null | Alternative | |
preferred_language | JSON | Optional | |
preferred_language (anyOf 1) | string | Alternative | |
preferred_language (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | |
statement_descriptor (anyOf 2) | null | Alternative |
Create a source — response body — card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line1_check | JSON | Optional | |
address_line1_check (anyOf 1) | string | Alternative | |
address_line1_check (anyOf 2) | null | Alternative | |
address_zip_check | JSON | Optional | |
address_zip_check (anyOf 1) | string | Alternative | |
address_zip_check (anyOf 2) | null | Alternative | |
brand | JSON | Optional | |
brand (anyOf 1) | string | Alternative | |
brand (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
cvc_check | JSON | Optional | |
cvc_check (anyOf 1) | string | Alternative | |
cvc_check (anyOf 2) | null | Alternative | |
dynamic_last4 | JSON | Optional | |
dynamic_last4 (anyOf 1) | string | Alternative | |
dynamic_last4 (anyOf 2) | null | Alternative | |
exp_month | JSON | Optional | |
exp_month (anyOf 1) | JSON | Alternative | |
exp_month (anyOf 1) (anyOf 1) | integer | Alternative | |
exp_month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_month (anyOf 2) | null | Alternative | |
exp_year | JSON | Optional | |
exp_year (anyOf 1) | JSON | Alternative | |
exp_year (anyOf 1) (anyOf 1) | integer | Alternative | |
exp_year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_year (anyOf 2) | null | Alternative | |
fingerprint | string | Optional | |
funding | JSON | Optional | |
funding (anyOf 1) | string | Alternative | |
funding (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | |
last4 (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
three_d_secure | string | Optional | |
tokenization_method | JSON | Optional | |
tokenization_method (anyOf 1) | string | Alternative | |
tokenization_method (anyOf 2) | null | Alternative |
Create a source — response body — card present
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
application_cryptogram | string | Optional | |
application_preferred_name | string | Optional | |
authorization_code | JSON | Optional | |
authorization_code (anyOf 1) | string | Alternative | |
authorization_code (anyOf 2) | null | Alternative | |
authorization_response_code | string | Optional | |
brand | JSON | Optional | |
brand (anyOf 1) | string | Alternative | |
brand (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
cvm_type | string | Optional | |
data_type | JSON | Optional | |
data_type (anyOf 1) | string | Alternative | |
data_type (anyOf 2) | null | Alternative | |
dedicated_file_name | string | Optional | |
emv_auth_data | string | Optional | |
evidence_customer_signature | JSON | Optional | |
evidence_customer_signature (anyOf 1) | string | Alternative | |
evidence_customer_signature (anyOf 2) | null | Alternative | |
evidence_transaction_certificate | JSON | Optional | |
evidence_transaction_certificate (anyOf 1) | string | Alternative | |
evidence_transaction_certificate (anyOf 2) | null | Alternative | |
exp_month | JSON | Optional | |
exp_month (anyOf 1) | JSON | Alternative | |
exp_month (anyOf 1) (anyOf 1) | integer | Alternative | |
exp_month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_month (anyOf 2) | null | Alternative | |
exp_year | JSON | Optional | |
exp_year (anyOf 1) | JSON | Alternative | |
exp_year (anyOf 1) (anyOf 1) | integer | Alternative | |
exp_year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_year (anyOf 2) | null | Alternative | |
fingerprint | string | Optional | |
funding | JSON | Optional | |
funding (anyOf 1) | string | Alternative | |
funding (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | |
last4 (anyOf 2) | null | Alternative | |
pos_device_id | JSON | Optional | |
pos_device_id (anyOf 1) | string | Alternative | |
pos_device_id (anyOf 2) | null | Alternative | |
pos_entry_mode | string | Optional | |
read_method | JSON | Optional | |
read_method (anyOf 1) | string | Alternative | |
read_method (anyOf 2) | null | Alternative | |
reader | JSON | Optional | |
reader (anyOf 1) | string | Alternative | |
reader (anyOf 2) | null | Alternative | |
terminal_verification_results | string | Optional | |
transaction_status_information | string | Optional |
Create a source — response body — code verification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attempts_remaining | JSON | Required within parent | |
attempts_remaining (anyOf 1) | integer | Alternative | The number of attempts remaining to authenticate the source object with a verification code. |
attempts_remaining (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | string | Required within parent | The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0). Maximum length: 5000 |
Create a source — response body — eps
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | |
reference (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | |
statement_descriptor (anyOf 2) | null | Alternative |
Create a source — response body — giropay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_code | JSON | Optional | |
bank_code (anyOf 1) | string | Alternative | |
bank_code (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | |
bank_name (anyOf 2) | null | Alternative | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | |
bic (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | |
statement_descriptor (anyOf 2) | null | Alternative |
Create a source — response body — ideal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | JSON | Optional | |
bank (anyOf 1) | string | Alternative | |
bank (anyOf 2) | null | Alternative | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | |
bic (anyOf 2) | null | Alternative | |
iban_last4 | JSON | Optional | |
iban_last4 (anyOf 1) | string | Alternative | |
iban_last4 (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | |
statement_descriptor (anyOf 2) | null | Alternative |
Create a source — response body — klarna
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
background_image_url | string | Optional | |
client_token | JSON | Optional | |
client_token (anyOf 1) | string | Alternative | |
client_token (anyOf 2) | null | Alternative | |
first_name | string | Optional | |
last_name | string | Optional | |
locale | string | Optional | |
logo_url | string | Optional | |
page_title | string | Optional | |
pay_later_asset_urls_descriptive | string | Optional | |
pay_later_asset_urls_standard | string | Optional | |
pay_later_name | string | Optional | |
pay_later_redirect_url | string | Optional | |
pay_now_asset_urls_descriptive | string | Optional | |
pay_now_asset_urls_standard | string | Optional | |
pay_now_name | string | Optional | |
pay_now_redirect_url | string | Optional | |
pay_over_time_asset_urls_descriptive | string | Optional | |
pay_over_time_asset_urls_standard | string | Optional | |
pay_over_time_name | string | Optional | |
pay_over_time_redirect_url | string | Optional | |
payment_method_categories | string | Optional | |
purchase_country | string | Optional | |
purchase_type | string | Optional | |
redirect_url | string | Optional | |
shipping_delay | JSON | Optional | |
shipping_delay (anyOf 1) | integer | Alternative | |
shipping_delay (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shipping_first_name | string | Optional | |
shipping_last_name | string | Optional |
Create a source — response body — multibanco
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity | JSON | Optional | |
entity (anyOf 1) | string | Alternative | |
entity (anyOf 2) | null | Alternative | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | |
reference (anyOf 2) | null | Alternative | |
refund_account_holder_address_city | JSON | Optional | |
refund_account_holder_address_city (anyOf 1) | string | Alternative | |
refund_account_holder_address_city (anyOf 2) | null | Alternative | |
refund_account_holder_address_country | JSON | Optional | |
refund_account_holder_address_country (anyOf 1) | string | Alternative | |
refund_account_holder_address_country (anyOf 2) | null | Alternative | |
refund_account_holder_address_line1 | JSON | Optional | |
refund_account_holder_address_line1 (anyOf 1) | string | Alternative | |
refund_account_holder_address_line1 (anyOf 2) | null | Alternative | |
refund_account_holder_address_line2 | JSON | Optional | |
refund_account_holder_address_line2 (anyOf 1) | string | Alternative | |
refund_account_holder_address_line2 (anyOf 2) | null | Alternative | |
refund_account_holder_address_postal_code | JSON | Optional | |
refund_account_holder_address_postal_code (anyOf 1) | string | Alternative | |
refund_account_holder_address_postal_code (anyOf 2) | null | Alternative | |
refund_account_holder_address_state | JSON | Optional | |
refund_account_holder_address_state (anyOf 1) | string | Alternative | |
refund_account_holder_address_state (anyOf 2) | null | Alternative | |
refund_account_holder_name | JSON | Optional | |
refund_account_holder_name (anyOf 1) | string | Alternative | |
refund_account_holder_name (anyOf 2) | null | Alternative | |
refund_iban | JSON | Optional | |
refund_iban (anyOf 1) | string | Alternative | |
refund_iban (anyOf 2) | null | Alternative |
Create a source — response body — owner value address, email, name, phone, verified address, verified email, verified name, verified phone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | Owner's address. |
address (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address |
address (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Owner's email address. Maximum length: 5000 |
email (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Owner's full name. Maximum length: 5000 |
name (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Owner's phone number (including extension). Maximum length: 5000 |
phone (anyOf 2) | null | Alternative | |
verified_address | JSON | Optional | |
verified_address (anyOf 1) | JSON | Alternative | Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. |
verified_address (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address |
verified_address (anyOf 2) | null | Alternative | |
verified_email | JSON | Optional | |
verified_email (anyOf 1) | string | Alternative | Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
verified_email (anyOf 2) | null | Alternative | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
verified_name (anyOf 2) | null | Alternative | |
verified_phone | JSON | Optional | |
verified_phone (anyOf 1) | string | Alternative | Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
verified_phone (anyOf 2) | null | Alternative |
Referenced models: Create a Location — response body — address
Create a source — response body — p24
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | |
reference (anyOf 2) | null | Alternative |
Create a source — response body — receiver
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | string | Alternative | The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. Maximum length: 5000 |
address (anyOf 2) | null | Alternative | |
amount_charged | JSON | Required within parent | |
amount_charged (anyOf 1) | integer | Alternative | The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. |
amount_charged (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_received | JSON | Required within parent | |
amount_received (anyOf 1) | integer | Alternative | The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency. |
amount_received (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_returned | JSON | Required within parent | |
amount_returned (anyOf 1) | integer | Alternative | The total amount that was returned to the customer. The amount returned is expressed in the source's currency. |
amount_returned (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
refund_attributes_method | string | Required within parent | Type of refund attribute method, one of `email`, `manual`, or `none`. Maximum length: 5000 |
refund_attributes_status | string | Required within parent | Type of refund attribute status, one of `missing`, `requested`, or `available`. Maximum length: 5000 |
Create a source — response body — redirect
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
failure_reason | JSON | Optional | |
failure_reason (anyOf 1) | string | Alternative | The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. Maximum length: 5000 |
failure_reason (anyOf 2) | null | Alternative | |
return_url | string | Required within parent | The URL you provide to redirect the customer to after they authenticated their payment. Maximum length: 5000 |
status | string | Required within parent | The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (successful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). Maximum length: 5000 |
url | string | Required within parent | The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. Maximum length: 2048 |
Create a source — response body — sepa debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_code | JSON | Optional | |
bank_code (anyOf 1) | string | Alternative | |
bank_code (anyOf 2) | null | Alternative | |
branch_code | JSON | Optional | |
branch_code (anyOf 1) | string | Alternative | |
branch_code (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | |
last4 (anyOf 2) | null | Alternative | |
mandate_reference | JSON | Optional | |
mandate_reference (anyOf 1) | string | Alternative | |
mandate_reference (anyOf 2) | null | Alternative | |
mandate_url | JSON | Optional | |
mandate_url (anyOf 1) | string | Alternative | |
mandate_url (anyOf 2) | null | Alternative |
Create a source — response body — sofort
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_code | JSON | Optional | |
bank_code (anyOf 1) | string | Alternative | |
bank_code (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | |
bank_name (anyOf 2) | null | Alternative | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | |
bic (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
iban_last4 | JSON | Optional | |
iban_last4 (anyOf 1) | string | Alternative | |
iban_last4 (anyOf 2) | null | Alternative | |
preferred_language | JSON | Optional | |
preferred_language (anyOf 1) | string | Alternative | |
preferred_language (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | |
statement_descriptor (anyOf 2) | null | Alternative |
Create a source — response body — source order
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | 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: currency |
email | string | Optional | The email address of the customer placing the order. Maximum length: 5000 |
items | JSON | Optional | |
items (anyOf 1) | array | Alternative | List of items constituting the order. |
items (anyOf 1)[] | Model | Each item | Expand Create a source — response body — source order items List of items constituting the order item |
items (anyOf 2) | null | Alternative | |
shipping | Model | Optional | Expand Create a source — response body — source order shipping |
Referenced models: Create a source — response body — source order shipping, Create a source — response body — source order items List of items constituting the order item
Create a source — response body — source order items List of items constituting the order item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | integer | Alternative | The amount (price) for this order item. |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | This currency of this order item. Required when `amount` is present. Maximum length: 5000 |
currency (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Human-readable description for this order item. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
parent | JSON | Optional | |
parent (anyOf 1) | string | Alternative | The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). Maximum length: 5000 |
parent (anyOf 2) | null | Alternative | |
quantity | JSON | Optional | |
quantity (anyOf 1) | integer | Alternative | The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. |
quantity (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of this order item. Must be `sku`, `tax`, or `shipping`. Maximum length: 5000 |
type (anyOf 2) | null | Alternative |
Create a source — response body — source order shipping
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Create a Location — response body — address |
carrier | JSON | Optional | |
carrier (anyOf 1) | string | Alternative | The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. Maximum length: 5000 |
carrier (anyOf 2) | null | Alternative | |
name | string | Optional | Recipient name. Maximum length: 5000 |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Recipient phone (including extension). Maximum length: 5000 |
phone (anyOf 2) | null | Alternative | |
tracking_number | JSON | Optional | |
tracking_number (anyOf 1) | string | Alternative | The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. Maximum length: 5000 |
tracking_number (anyOf 2) | null | Alternative |
Referenced models: Create a Location — response body — address
Create a source — response body — three d secure
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line1_check | JSON | Optional | |
address_line1_check (anyOf 1) | string | Alternative | |
address_line1_check (anyOf 2) | null | Alternative | |
address_zip_check | JSON | Optional | |
address_zip_check (anyOf 1) | string | Alternative | |
address_zip_check (anyOf 2) | null | Alternative | |
authenticated | JSON | Optional | |
authenticated (anyOf 1) | boolean | Alternative | |
authenticated (anyOf 2) | null | Alternative | |
brand | JSON | Optional | |
brand (anyOf 1) | string | Alternative | |
brand (anyOf 2) | null | Alternative | |
card | JSON | Optional | |
card (anyOf 1) | string | Alternative | |
card (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | |
country (anyOf 2) | null | Alternative | |
customer | JSON | Optional | |
customer (anyOf 1) | string | Alternative | |
customer (anyOf 2) | null | Alternative | |
cvc_check | JSON | Optional | |
cvc_check (anyOf 1) | string | Alternative | |
cvc_check (anyOf 2) | null | Alternative | |
dynamic_last4 | JSON | Optional | |
dynamic_last4 (anyOf 1) | string | Alternative | |
dynamic_last4 (anyOf 2) | null | Alternative | |
exp_month | JSON | Optional | |
exp_month (anyOf 1) | JSON | Alternative | |
exp_month (anyOf 1) (anyOf 1) | integer | Alternative | |
exp_month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_month (anyOf 2) | null | Alternative | |
exp_year | JSON | Optional | |
exp_year (anyOf 1) | JSON | Alternative | |
exp_year (anyOf 1) (anyOf 1) | integer | Alternative | |
exp_year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_year (anyOf 2) | null | Alternative | |
fingerprint | string | Optional | |
funding | JSON | Optional | |
funding (anyOf 1) | string | Alternative | |
funding (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | |
last4 (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
three_d_secure | string | Optional | |
tokenization_method | JSON | Optional | |
tokenization_method (anyOf 1) | string | Alternative | |
tokenization_method (anyOf 2) | null | Alternative |
Create a source — response body — wechat
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
prepay_id | string | Optional | |
qr_code_url | JSON | Optional | |
qr_code_url (anyOf 1) | string | Alternative | |
qr_code_url (anyOf 2) | null | Alternative | |
statement_descriptor | string | Optional |
Retrieve a Source Mandate Notification — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Source mandate notifications should be created when a notification related to a source mandate must be sent to the payer. They will trigger a webhook or deliver an email to the customer. |
acss_debit | Model | Optional | Expand Retrieve a Source Mandate Notification — response body — acss debit |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | integer | Alternative | A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`. |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | |
bacs_debit | Model | Optional | Expand Retrieve a Source Mandate Notification — response body — bacs debit |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: source_mandate_notification |
reason | string | Required within parent | The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. Maximum length: 5000 |
sepa_debit | Model | Optional | Expand Retrieve a Source Mandate Notification — response body — sepa debit |
source | Model | Required within parent | Expand Create a source — response body |
status | string | Required within parent | The status of the mandate notification. Valid statuses are `pending` or `submitted`. Maximum length: 5000 |
type | string | Required within parent | The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`. Maximum length: 5000 |
Referenced models: Create a source — response body, Retrieve a Source Mandate Notification — response body — acss debit, Retrieve a Source Mandate Notification — response body — bacs debit, Retrieve a Source Mandate Notification — response body — sepa debit
Retrieve a Source Mandate Notification — response body — acss debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
statement_descriptor | string | Optional | The statement descriptor associate with the debit. Maximum length: 5000 |
Retrieve a Source Mandate Notification — response body — bacs debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
last4 | string | Optional | Last 4 digits of the account number associated with the debit. Maximum length: 5000 |
Retrieve a Source Mandate Notification — response body — sepa debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
creditor_identifier | string | Optional | SEPA creditor ID. Maximum length: 5000 |
last4 | string | Optional | Last 4 digits of the account number associated with the debit. Maximum length: 5000 |
mandate_reference | string | Optional | Mandate reference associated with the debit. Maximum length: 5000 |
Retrieve a source transaction — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Some payment methods have no required amount that a customer must send. Customers can be instructed to send any amount, and it can be made up of multiple transactions. As such, sources can have multiple associated transactions. |
ach_credit_transfer | Model | Optional | Expand Retrieve a source transaction — response body — ach credit transfer |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
chf_credit_transfer | Model | Optional | Expand Retrieve a source transaction — response body — chf credit transfer |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | 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: currency |
gbp_credit_transfer | Model | Optional | Expand Retrieve a source transaction — response body — gbp credit transfer |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: source_transaction |
paper_check | Model | Optional | Expand Retrieve a source transaction — response body — paper check |
sepa_credit_transfer | Model | Optional | Expand Retrieve a source transaction — response body — sepa credit transfer |
source | string | Required within parent | The ID of the source this transaction is attached to. Maximum length: 5000 |
status | string | Required within parent | The status of the transaction, one of `succeeded`, `pending`, or `failed`. Maximum length: 5000 |
type | string | Required within parent | The type of source this transaction is attached to. Known values: ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, klarna, multibanco, p24, sepa_debit, sofort, three_d_secure, wechat |
Referenced models: Retrieve a source transaction — response body — ach credit transfer, Retrieve a source transaction — response body — chf credit transfer, Retrieve a source transaction — response body — gbp credit transfer, Retrieve a source transaction — response body — paper check, Retrieve a source transaction — response body — sepa credit transfer
Retrieve a source transaction — response body — ach credit transfer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customer_data | string | Optional | Customer data associated with the transfer. Maximum length: 5000 |
fingerprint | string | Optional | Bank account fingerprint associated with the transfer. Maximum length: 5000 |
last4 | string | Optional | Last 4 digits of the account number associated with the transfer. Maximum length: 5000 |
routing_number | string | Optional | Routing number associated with the transfer. Maximum length: 5000 |
Retrieve a source transaction — response body — chf credit transfer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reference | string | Optional | Reference associated with the transfer. Maximum length: 5000 |
sender_address_country | string | Optional | Sender's country address. Maximum length: 5000 |
sender_address_line1 | string | Optional | Sender's line 1 address. Maximum length: 5000 |
sender_iban | string | Optional | Sender's bank account IBAN. Maximum length: 5000 |
sender_name | string | Optional | Sender's name. Maximum length: 5000 |
Retrieve a source transaction — response body — gbp credit transfer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fingerprint | string | Optional | Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. Maximum length: 5000 |
funding_method | string | Optional | The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported. Maximum length: 5000 |
last4 | string | Optional | Last 4 digits of sender account number associated with the transfer. Maximum length: 5000 |
reference | string | Optional | Sender entered arbitrary information about the transfer. Maximum length: 5000 |
sender_account_number | string | Optional | Sender account number associated with the transfer. Maximum length: 5000 |
sender_name | string | Optional | Sender name associated with the transfer. Maximum length: 5000 |
sender_sort_code | string | Optional | Sender sort code associated with the transfer. Maximum length: 5000 |
Retrieve a source transaction — response body — paper check
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
available_at | string | Optional | Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. Maximum length: 5000 |
invoices | string | Optional | Comma-separated list of invoice IDs associated with the paper check. Maximum length: 5000 |
Retrieve a source transaction — response body — sepa credit transfer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reference | string | Optional | Reference associated with the transfer. Maximum length: 5000 |
sender_iban | string | Optional | Sender's bank account IBAN. Maximum length: 5000 |
sender_name | string | Optional | Sender's name. Maximum length: 5000 |