@datafire/stripe

Client library for Stripe API

Installation and Usage

npm install --save @datafire/stripe

let stripe = require('@datafire/stripe').create({
  username: "",
  password: "",
  bearerAuth: ""
});

.then(data => {
  console.log(data);
});

Description

The Stripe REST API. Please see https://stripe.com/docs/api for more details.

Actions

Post3dSecure

stripe.Post3dSecure({
  "amount": 0,
  "currency": "",
  "return_url": ""
}, context)

Input

• input object
  • amount required integer: Amount of the charge that you will create when authentication completes.
  • card string: The ID of a card token, or the ID of a card belonging to the given customer.
  • currency required string: Three-letter ISO currency code, in lowercase. Must be a supported currency.
  • customer string: The customer associated with this 3D secure authentication.
  • expand array: Specifies which fields in the response should be expanded.
  • return_url required string: The URL that the cardholder's browser will be returned to when authentication completes.

Output

• output three_d_secure

Get3dSecureThreeDSecure

stripe.Get3dSecureThreeDSecure({
  "three_d_secure": ""
}, context)

Input

• input object
  • expand array: Specifies which fields in the response should be expanded.
  • three_d_secure required string

Output

• output three_d_secure

DeleteAccount

stripe.DeleteAccount({}, context)

Input

• input object
  • account string

Output

• output deleted_account

GetAccount

stripe.GetAccount({}, context)

Input

• input object
  • expand array: Specifies which fields in the response should be expanded.

Output

• output account

PostAccount

stripe.PostAccount({}, context)

Input

• input object
  • account_token string: An account token, used to securely provide details to the account.
  • business_profile object: Business information about the account.
  • business_type string (values: company, government_entity, individual, non_profit): The business type.
  • capabilities object: Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.
  • company object: Information about the company or business. This field is available for any business_type.
  • default_currency string: Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
  • documents object: Documents that may be submitted to satisfy various informational requests.
  • email string: The email address of the account holder. This is only to make the account easier to identify to you. Stripe will never directly email Custom accounts.
  • expand array: Specifies which fields in the response should be expanded.
  • external_account string: A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account parameter for bank account creation. By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
  • individual object: Information about the person represented by the account. This field is null unless business_type is set to individual.
  • settings object: Options for customizing how the account functions within Stripe.
  • tos_acceptance object: Details on the account's acceptance of the Stripe Services Agreement.

Output

• output account

PostAccountBankAccounts

stripe.PostAccountBankAccounts({}, context)

Input

• input object
  • default_for_currency boolean: When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
  • expand array: Specifies which fields in the response should be expanded.
  • external_account string: Please refer to full documentation instead.
  • metadata object: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Output

• output external_account

DeleteAccountBankAccountsId

stripe.DeleteAccountBankAccountsId({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output deleted_external_account

GetAccountBankAccountsId

stripe.GetAccountBankAccountsId({
  "id": ""
}, context)

Input

• input object
  • expand array: Specifies which fields in the response should be expanded.
  • id required string

Output

• output external_account

PostAccountBankAccountsId

stripe.PostAccountBankAccountsId({
  "id": ""
}, context)

Input

• input object
  • id required string
  • account_holder_name string: The name of the person or business that owns the bank account.
  • account_holder_type string (values: , company, individual): The type of entity that holds the account. This can be either individual or company.
  • address_city string: City/District/Suburb/Town/Village.
  • address_country string: Billing address country, if provided when creating card.
  • address_line1 string: Address line 1 (Street address/PO Box/Company name).
  • address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
  • address_state string: State/County/Province/Region.
  • address_zip string: ZIP or postal code.
  • default_for_currency boolean: When set to true, this becomes the default external account for its currency.
  • exp_month string: Two digit number representing the card’s expiration month.
  • exp_year string: Four digit number representing the card’s expiration year.
  • expand array: Specifies which fields in the response should be expanded.
  • name string: Cardholder name.

Output

• output external_account

GetAccountCapabilities

stripe.GetAccountCapabilities({}, context)

Input

• input object
  • expand array: Specifies which fields in the response should be expanded.

Output

• output object
  • data required array
    • items capability
  • has_more required boolean: True if this list has another page of items after this one that can be fetched.
  • object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
  • url required string: The URL where this list can be accessed.

GetAccountCapabilitiesCapability

stripe.GetAccountCapabilitiesCapability({
  "capability": ""
}, context)

Input

• input object
  • capability required string
  • expand array: Specifies which fields in the response should be expanded.

Output

• output capability

PostAccountCapabilitiesCapability

stripe.PostAccountCapabilitiesCapability({
  "capability": ""
}, context)

Input

• input object
  • capability required string
  • expand array: Specifies which fields in the response should be expanded.
  • requested boolean: Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the requirements arrays.

Output

• output capability

GetAccountExternalAccounts

stripe.GetAccountExternalAccounts({}, context)

Input

• input object
  • ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand array: Specifies which fields in the response should be expanded.
  • limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

• output object
  • data required array: The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
  • has_more required boolean: True if this list has another page of items after this one that can be fetched.
  • object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
  • url required string: The URL where this list can be accessed.

PostAccountExternalAccounts

stripe.PostAccountExternalAccounts({}, context)

Input

• input object
  • default_for_currency boolean: When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
  • expand array: Specifies which fields in the response should be expanded.
  • external_account string: Please refer to full documentation instead.
  • metadata object: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Output

• output external_account

DeleteAccountExternalAccountsId

stripe.DeleteAccountExternalAccountsId({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output deleted_external_account

GetAccountExternalAccountsId

stripe.GetAccountExternalAccountsId({
  "id": ""
}, context)

Input

• input object
  • expand array: Specifies which fields in the response should be expanded.
  • id required string

Output

• output external_account

PostAccountExternalAccountsId

stripe.PostAccountExternalAccountsId({
  "id": ""
}, context)

Input

• input object
  • id required string
  • account_holder_name string: The name of the person or business that owns the bank account.
  • account_holder_type string (values: , company, individual): The type of entity that holds the account. This can be either individual or company.
  • address_city string: City/District/Suburb/Town/Village.
  • address_country string: Billing address country, if provided when creating card.
  • address_line1 string: Address line 1 (Street address/PO Box/Company name).
  • address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
  • address_state string: State/County/Province/Region.
  • address_zip string: ZIP or postal code.
  • default_for_currency boolean: When set to true, this becomes the default external account for its currency.
  • exp_month string: Two digit number representing the card’s expiration month.
  • exp_year string: Four digit number representing the card’s expiration year.
  • expand array: Specifies which fields in the response should be expanded.
  • name string: Cardholder name.

Output

• output external_account

PostAccountLoginLinks

stripe.PostAccountLoginLinks({
  "account": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.
  • redirect_url string: Where to redirect the user after they log out of their dashboard.

Output

• output login_link

PutAccountLogout

stripe.PutAccountLogout({
  "account": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.

Output

• output light_account_logout

GetAccountPeople

stripe.GetAccountPeople({}, context)

Input

• input object
  • ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand array: Specifies which fields in the response should be expanded.
  • limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • relationship object: Filters on the list of people returned based on the person's relationship to the account's company.
  • starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

• output object
  • data required array
    • items person
  • has_more required boolean: True if this list has another page of items after this one that can be fetched.
  • object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
  • url required string: The URL where this list can be accessed.

PostAccountPeople

stripe.PostAccountPeople({}, context)

Input

• input object
  • account string
  • address object: The person's address.
  • address_kana object: The Kana variation of the person's address (Japan only).
  • address_kanji object: The Kanji variation of the person's address (Japan only).
  • email string: The person's email address.
  • expand array: Specifies which fields in the response should be expanded.
  • first_name string: The person's first name.
  • first_name_kana string: The Kana variation of the person's first name (Japan only).
  • first_name_kanji string: The Kanji variation of the person's first name (Japan only).
  • gender string: The person's gender (International regulations require either "male" or "female").
  • id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
  • last_name string: The person's last name.
  • last_name_kana string: The Kana variation of the person's last name (Japan only).
  • last_name_kanji string: The Kanji variation of the person's last name (Japan only).
  • maiden_name string: The person's maiden name.
  • person_token string: A person token, used to securely provide details to the person.
  • phone string: The person's phone number.
  • political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
  • relationship object: The relationship that this person has with the account's legal entity.
  • ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
  • verification object: The person's verification status.

Output

• output person

DeleteAccountPeoplePerson

stripe.DeleteAccountPeoplePerson({
  "person": ""
}, context)

Input

• input object
  • person required string

Output

• output deleted_person

GetAccountPeoplePerson

stripe.GetAccountPeoplePerson({
  "person": ""
}, context)

Input

• input object
  • expand array: Specifies which fields in the response should be expanded.
  • person required string

Output

• output person

PostAccountPeoplePerson

stripe.PostAccountPeoplePerson({
  "person": ""
}, context)

Input

• input object
  • person required string
  • account string
  • address object: The person's address.
  • address_kana object: The Kana variation of the person's address (Japan only).
  • address_kanji object: The Kanji variation of the person's address (Japan only).
  • email string: The person's email address.
  • expand array: Specifies which fields in the response should be expanded.
  • first_name string: The person's first name.
  • first_name_kana string: The Kana variation of the person's first name (Japan only).
  • first_name_kanji string: The Kanji variation of the person's first name (Japan only).
  • gender string: The person's gender (International regulations require either "male" or "female").
  • id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
  • last_name string: The person's last name.
  • last_name_kana string: The Kana variation of the person's last name (Japan only).
  • last_name_kanji string: The Kanji variation of the person's last name (Japan only).
  • maiden_name string: The person's maiden name.
  • person_token string: A person token, used to securely provide details to the person.
  • phone string: The person's phone number.
  • political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
  • relationship object: The relationship that this person has with the account's legal entity.
  • ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
  • verification object: The person's verification status.

Output

• output person

GetAccountPersons

stripe.GetAccountPersons({}, context)

Input

• input object
  • ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand array: Specifies which fields in the response should be expanded.
  • limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • relationship object: Filters on the list of people returned based on the person's relationship to the account's company.
  • starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

• output object
  • data required array
    • items person
  • has_more required boolean: True if this list has another page of items after this one that can be fetched.
  • object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
  • url required string: The URL where this list can be accessed.

PostAccountPersons

stripe.PostAccountPersons({}, context)

Input

• input object
  • account string
  • address object: The person's address.
  • address_kana object: The Kana variation of the person's address (Japan only).
  • address_kanji object: The Kanji variation of the person's address (Japan only).
  • email string: The person's email address.
  • expand array: Specifies which fields in the response should be expanded.
  • first_name string: The person's first name.
  • first_name_kana string: The Kana variation of the person's first name (Japan only).
  • first_name_kanji string: The Kanji variation of the person's first name (Japan only).
  • gender string: The person's gender (International regulations require either "male" or "female").
  • id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
  • last_name string: The person's last name.
  • last_name_kana string: The Kana variation of the person's last name (Japan only).
  • last_name_kanji string: The Kanji variation of the person's last name (Japan only).
  • maiden_name string: The person's maiden name.
  • person_token string: A person token, used to securely provide details to the person.
  • phone string: The person's phone number.
  • political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
  • relationship object: The relationship that this person has with the account's legal entity.
  • ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
  • verification object: The person's verification status.

Output

• output person

DeleteAccountPersonsPerson

stripe.DeleteAccountPersonsPerson({
  "person": ""
}, context)

Input

• input object
  • person required string

Output

• output deleted_person

GetAccountPersonsPerson

stripe.GetAccountPersonsPerson({
  "person": ""
}, context)

Input

• input object
  • expand array: Specifies which fields in the response should be expanded.
  • person required string

Output

• output person

PostAccountPersonsPerson

stripe.PostAccountPersonsPerson({
  "person": ""
}, context)

Input

• input object
  • person required string
  • account string
  • address object: The person's address.
  • address_kana object: The Kana variation of the person's address (Japan only).
  • address_kanji object: The Kanji variation of the person's address (Japan only).
  • email string: The person's email address.
  • expand array: Specifies which fields in the response should be expanded.
  • first_name string: The person's first name.
  • first_name_kana string: The Kana variation of the person's first name (Japan only).
  • first_name_kanji string: The Kanji variation of the person's first name (Japan only).
  • gender string: The person's gender (International regulations require either "male" or "female").
  • id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
  • last_name string: The person's last name.
  • last_name_kana string: The Kana variation of the person's last name (Japan only).
  • last_name_kanji string: The Kanji variation of the person's last name (Japan only).
  • maiden_name string: The person's maiden name.
  • person_token string: A person token, used to securely provide details to the person.
  • phone string: The person's phone number.
  • political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
  • relationship object: The relationship that this person has with the account's legal entity.
  • ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
  • verification object: The person's verification status.

Output

• output person

PostAccountLinks

stripe.PostAccountLinks({
  "account": "",
  "type": ""
}, context)

Input

• input object
  • account required string: The identifier of the account to create an account link for.
  • collect string (values: currently_due, eventually_due): Which information the platform needs to collect from the user. One of currently_due or eventually_due. Default is currently_due.
  • expand array: Specifies which fields in the response should be expanded.
  • refresh_url string: The URL that the user will be redirected to if the account link is no longer valid. Your refresh_url should trigger a method on your server to create a new account link using this API, with the same parameters, and redirect the user to the new account link.
  • return_url string: The URL that the user will be redirected to upon leaving or completing the linked flow.
  • type required string (values: account_onboarding, account_update): The type of account link the user is requesting. Possible values are account_onboarding or account_update.

Output

• output account_link

GetAccounts

stripe.GetAccounts({}, context)

Input

• input object
  • ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand array: Specifies which fields in the response should be expanded.
  • limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

• output object
  • data required array
    • items account
  • has_more required boolean: True if this list has another page of items after this one that can be fetched.
  • object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
  • url required string: The URL where this list can be accessed.

PostAccounts

stripe.PostAccounts({}, context)

Input

• input object
  • account_token string: An account token, used to securely provide details to the account.
  • business_profile object: Business information about the account.
  • business_type string (values: company, government_entity, individual, non_profit): The business type.
  • capabilities object: Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.
  • company object: Information about the company or business. This field is available for any business_type.
  • country string: The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use CA as the country for the account being created.
  • default_currency string: Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
  • documents object: Documents that may be submitted to satisfy various informational requests.
  • email string: The email address of the account holder. This is only to make the account easier to identify to you. Stripe will never directly email Custom accounts.
  • expand array: Specifies which fields in the response should be expanded.
  • external_account string: A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account parameter for bank account creation. By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
  • individual object: Information about the person represented by the account. This field is null unless business_type is set to individual.
  • settings object: Options for customizing how the account functions within Stripe.
  • tos_acceptance object: Details on the account's acceptance of the Stripe Services Agreement.
  • type string (values: custom, express, standard): The type of Stripe account to create. May be one of custom, express or standard.

Output

• output account

DeleteAccountsAccount

stripe.DeleteAccountsAccount({
  "account": ""
}, context)

Input

• input object
  • account required string

Output

• output deleted_account

GetAccountsAccount

stripe.GetAccountsAccount({
  "account": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.

Output

• output account

PostAccountsAccount

stripe.PostAccountsAccount({
  "account": ""
}, context)

Input

• input object
  • account required string
  • account_token string: An account token, used to securely provide details to the account.
  • business_profile object: Business information about the account.
  • business_type string (values: company, government_entity, individual, non_profit): The business type.
  • capabilities object: Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.
  • company object: Information about the company or business. This field is available for any business_type.
  • default_currency string: Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
  • documents object: Documents that may be submitted to satisfy various informational requests.
  • email string: The email address of the account holder. This is only to make the account easier to identify to you. Stripe will never directly email Custom accounts.
  • expand array: Specifies which fields in the response should be expanded.
  • external_account string: A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account parameter for bank account creation. By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
  • individual object: Information about the person represented by the account. This field is null unless business_type is set to individual.
  • settings object: Options for customizing how the account functions within Stripe.
  • tos_acceptance object: Details on the account's acceptance of the Stripe Services Agreement.

Output

• output account

PostAccountsAccountBankAccounts

stripe.PostAccountsAccountBankAccounts({
  "account": ""
}, context)

Input

• input object
  • account required string
  • default_for_currency boolean: When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
  • expand array: Specifies which fields in the response should be expanded.
  • external_account string: Please refer to full documentation instead.
  • metadata object: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Output

• output external_account

DeleteAccountsAccountBankAccountsId

stripe.DeleteAccountsAccountBankAccountsId({
  "account": "",
  "id": ""
}, context)

Input

• input object
  • account required string
  • id required string

Output

• output deleted_external_account

GetAccountsAccountBankAccountsId

stripe.GetAccountsAccountBankAccountsId({
  "account": "",
  "id": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.
  • id required string

Output

• output external_account

PostAccountsAccountBankAccountsId

stripe.PostAccountsAccountBankAccountsId({
  "account": "",
  "id": ""
}, context)

Input

• input object
  • account required string
  • id required string
  • account_holder_name string: The name of the person or business that owns the bank account.
  • account_holder_type string (values: , company, individual): The type of entity that holds the account. This can be either individual or company.
  • address_city string: City/District/Suburb/Town/Village.
  • address_country string: Billing address country, if provided when creating card.
  • address_line1 string: Address line 1 (Street address/PO Box/Company name).
  • address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
  • address_state string: State/County/Province/Region.
  • address_zip string: ZIP or postal code.
  • default_for_currency boolean: When set to true, this becomes the default external account for its currency.
  • exp_month string: Two digit number representing the card’s expiration month.
  • exp_year string: Four digit number representing the card’s expiration year.
  • expand array: Specifies which fields in the response should be expanded.
  • name string: Cardholder name.

Output

• output external_account

GetAccountsAccountCapabilities

stripe.GetAccountsAccountCapabilities({
  "account": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.

Output

• output object
  • data required array
    • items capability
  • has_more required boolean: True if this list has another page of items after this one that can be fetched.
  • object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
  • url required string: The URL where this list can be accessed.

GetAccountsAccountCapabilitiesCapability

stripe.GetAccountsAccountCapabilitiesCapability({
  "account": "",
  "capability": ""
}, context)

Input

• input object
  • account required string
  • capability required string
  • expand array: Specifies which fields in the response should be expanded.

Output

• output capability

PostAccountsAccountCapabilitiesCapability

stripe.PostAccountsAccountCapabilitiesCapability({
  "account": "",
  "capability": ""
}, context)

Input

• input object
  • account required string
  • capability required string
  • expand array: Specifies which fields in the response should be expanded.
  • requested boolean: Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the requirements arrays.

Output

• output capability

GetAccountsAccountExternalAccounts

stripe.GetAccountsAccountExternalAccounts({
  "account": ""
}, context)

Input

• input object
  • account required string
  • ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand array: Specifies which fields in the response should be expanded.
  • limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

• output object
  • data required array: The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
  • has_more required boolean: True if this list has another page of items after this one that can be fetched.
  • object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
  • url required string: The URL where this list can be accessed.

PostAccountsAccountExternalAccounts

stripe.PostAccountsAccountExternalAccounts({
  "account": ""
}, context)

Input

• input object
  • account required string
  • default_for_currency boolean: When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
  • expand array: Specifies which fields in the response should be expanded.
  • external_account string: Please refer to full documentation instead.
  • metadata object: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Output

• output external_account

DeleteAccountsAccountExternalAccountsId

stripe.DeleteAccountsAccountExternalAccountsId({
  "account": "",
  "id": ""
}, context)

Input

• input object
  • account required string
  • id required string

Output

• output deleted_external_account

GetAccountsAccountExternalAccountsId

stripe.GetAccountsAccountExternalAccountsId({
  "account": "",
  "id": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.
  • id required string

Output

• output external_account

PostAccountsAccountExternalAccountsId

stripe.PostAccountsAccountExternalAccountsId({
  "account": "",
  "id": ""
}, context)

Input

• input object
  • account required string
  • id required string
  • account_holder_name string: The name of the person or business that owns the bank account.
  • account_holder_type string (values: , company, individual): The type of entity that holds the account. This can be either individual or company.
  • address_city string: City/District/Suburb/Town/Village.
  • address_country string: Billing address country, if provided when creating card.
  • address_line1 string: Address line 1 (Street address/PO Box/Company name).
  • address_line2 string: Address line 2 (Apartment/Suite/Unit/Building).
  • address_state string: State/County/Province/Region.
  • address_zip string: ZIP or postal code.
  • default_for_currency boolean: When set to true, this becomes the default external account for its currency.
  • exp_month string: Two digit number representing the card’s expiration month.
  • exp_year string: Four digit number representing the card’s expiration year.
  • expand array: Specifies which fields in the response should be expanded.
  • name string: Cardholder name.

Output

• output external_account

PostAccountsAccountLoginLinks

stripe.PostAccountsAccountLoginLinks({
  "account": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.
  • redirect_url string: Where to redirect the user after they log out of their dashboard.

Output

• output login_link

PutAccountsAccountLogout

stripe.PutAccountsAccountLogout({
  "account": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.

Output

• output light_account_logout

GetAccountsAccountPeople

stripe.GetAccountsAccountPeople({
  "account": ""
}, context)

Input

• input object
  • account required string
  • ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand array: Specifies which fields in the response should be expanded.
  • limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • relationship object: Filters on the list of people returned based on the person's relationship to the account's company.
  • starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

• output object
  • data required array
    • items person
  • has_more required boolean: True if this list has another page of items after this one that can be fetched.
  • object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
  • url required string: The URL where this list can be accessed.

PostAccountsAccountPeople

stripe.PostAccountsAccountPeople({
  "account": ""
}, context)

Input

• input object
  • account required string
  • address object: The person's address.
  • address_kana object: The Kana variation of the person's address (Japan only).
  • address_kanji object: The Kanji variation of the person's address (Japan only).
  • email string: The person's email address.
  • expand array: Specifies which fields in the response should be expanded.
  • first_name string: The person's first name.
  • first_name_kana string: The Kana variation of the person's first name (Japan only).
  • first_name_kanji string: The Kanji variation of the person's first name (Japan only).
  • gender string: The person's gender (International regulations require either "male" or "female").
  • id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
  • last_name string: The person's last name.
  • last_name_kana string: The Kana variation of the person's last name (Japan only).
  • last_name_kanji string: The Kanji variation of the person's last name (Japan only).
  • maiden_name string: The person's maiden name.
  • person_token string: A person token, used to securely provide details to the person.
  • phone string: The person's phone number.
  • political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
  • relationship object: The relationship that this person has with the account's legal entity.
  • ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
  • verification object: The person's verification status.

Output

• output person

DeleteAccountsAccountPeoplePerson

stripe.DeleteAccountsAccountPeoplePerson({
  "account": "",
  "person": ""
}, context)

Input

• input object
  • account required string
  • person required string

Output

• output deleted_person

GetAccountsAccountPeoplePerson

stripe.GetAccountsAccountPeoplePerson({
  "account": "",
  "person": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.
  • person required string

Output

• output person

PostAccountsAccountPeoplePerson

stripe.PostAccountsAccountPeoplePerson({
  "account": "",
  "person": ""
}, context)

Input

• input object
  • account required string
  • person required string
  • address object: The person's address.
  • address_kana object: The Kana variation of the person's address (Japan only).
  • address_kanji object: The Kanji variation of the person's address (Japan only).
  • email string: The person's email address.
  • expand array: Specifies which fields in the response should be expanded.
  • first_name string: The person's first name.
  • first_name_kana string: The Kana variation of the person's first name (Japan only).
  • first_name_kanji string: The Kanji variation of the person's first name (Japan only).
  • gender string: The person's gender (International regulations require either "male" or "female").
  • id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
  • last_name string: The person's last name.
  • last_name_kana string: The Kana variation of the person's last name (Japan only).
  • last_name_kanji string: The Kanji variation of the person's last name (Japan only).
  • maiden_name string: The person's maiden name.
  • person_token string: A person token, used to securely provide details to the person.
  • phone string: The person's phone number.
  • political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
  • relationship object: The relationship that this person has with the account's legal entity.
  • ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
  • verification object: The person's verification status.

Output

• output person

GetAccountsAccountPersons

stripe.GetAccountsAccountPersons({
  "account": ""
}, context)

Input

• input object
  • account required string
  • ending_before string: A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand array: Specifies which fields in the response should be expanded.
  • limit integer: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • relationship object: Filters on the list of people returned based on the person's relationship to the account's company.
  • starting_after string: A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

• output object
  • data required array
    • items person
  • has_more required boolean: True if this list has another page of items after this one that can be fetched.
  • object required string (values: list): String representing the object's type. Objects of the same type share the same value. Always has the value list.
  • url required string: The URL where this list can be accessed.

PostAccountsAccountPersons

stripe.PostAccountsAccountPersons({
  "account": ""
}, context)

Input

• input object
  • account required string
  • address object: The person's address.
  • address_kana object: The Kana variation of the person's address (Japan only).
  • address_kanji object: The Kanji variation of the person's address (Japan only).
  • email string: The person's email address.
  • expand array: Specifies which fields in the response should be expanded.
  • first_name string: The person's first name.
  • first_name_kana string: The Kana variation of the person's first name (Japan only).
  • first_name_kanji string: The Kanji variation of the person's first name (Japan only).
  • gender string: The person's gender (International regulations require either "male" or "female").
  • id_number string: The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
  • last_name string: The person's last name.
  • last_name_kana string: The Kana variation of the person's last name (Japan only).
  • last_name_kanji string: The Kanji variation of the person's last name (Japan only).
  • maiden_name string: The person's maiden name.
  • person_token string: A person token, used to securely provide details to the person.
  • phone string: The person's phone number.
  • political_exposure string: Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
  • relationship object: The relationship that this person has with the account's legal entity.
  • ssn_last_4 string: The last four digits of the person's Social Security number (U.S. only).
  • verification object: The person's verification status.

Output

• output person

DeleteAccountsAccountPersonsPerson

stripe.DeleteAccountsAccountPersonsPerson({
  "account": "",
  "person": ""
}, context)

Input

• input object
  • account required string
  • person required string

Output

• output deleted_person

GetAccountsAccountPersonsPerson

stripe.GetAccountsAccountPersonsPerson({
  "account": "",
  "person": ""
}, context)

Input

• input object
  • account required string
  • expand array: Specifies which fields in the response should be expanded.
  • p