TDV Adapter for Stripe

Build 22.0.8462

Accounts

Create, update, delete, and query the Accounts you manage in Stripe.

Table Specific Information

Select

Server-Side Query Support

The adapter will use the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client side within the adapter.

  • Id supports the following operator: =.

The provider supports all columns to be used as criteria in the WHERE clause of Select statement, as long as SupportEnhancedSQL is set to True. If SupportEnhancedSQL property is set to False, you still can retrieve an Account by specifying its Id: 

SELECT * FROM Accounts WHERE Id='MyId'

Insert

To create a new account, Email is required if Managed is not specified or is set to false and Capabilities is required. Capabilities is an aggregate column. See the example below on how to insert into this column. 

INSERT INTO Accounts (Capabilities, Country, Email, Managed) VALUES ('{"0": "card_payments","1": "transfers"}', 'US','test@sab.com',false)

INSERT INTO Accounts(Capabilities, Country, DefaultCurrency, DetailsSubmitted,Email,Type) VALUES ('{"card_payments": "inactive","transfers": "inactive"}', 'US', 'usd',false, 'test5@test.com','custom')

Update

To update an Account, specify Id of the Account: 

UPDATE Accounts SET BusinessName = 'My Business Name', BusinessPrimaryColor = '#666666', SupportPhone = '+355696977888' WHERE Id = 'acct_1A0XVyFF36eOzuU5'

Delete

To delete an Account, specify the Id of the account. 

DELETE FROM Account WHERE Id = 'acct_1A0XVyFF36eOzuU5'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier for the account.

BusinessType String False

The business type of company

The allowed values are individual, company, non_profit, government_entity.

ChargesEnabled Boolean True

Whether or not the account can create live charges.

Country String False

The country of the account.

IsController Boolean True

Whether or not the Connect application retrieving the resource controls the account.

ControllerType String True

The controller type.

Created Datetime False

Time at which the account was connected.

DefaultCurrency String False

The currency this account has chosen to use as the default.

DetailsSubmitted Boolean False

Whether or not account details have been submitted yet. Standalone accounts cannot receive transfers before this is true.

Email String False

The primary email address of the user.

ExternalAccountsAggregate String False

External accounts (bank accounts and/or cards) currently attached to this account.

FutureRequirementsAggregate String False

Information about the upcoming new requirements for the account, including what information needs to be collected, and by when.

PayoutsEnabled Boolean True

Whether Stripe can send payouts to this account.

SettingsAggregate String False

Options for customizing how the account functions within Stripe.

BusinessSupportEmail String False

The publicly shareable email address that can be reached for support for this account.

BusinessSupportPhone String False

The publicly visible support phone number for the business.

BusinessSupportAddressCity String False

City, district, suburb, town, or village.

BusinessSupportAddressCountry String False

Two-letter country code.

BusinessSupportAddressLine1 String False

Address line 1 (e.g., street, PO Box, or company name).

BusinessSupportAddressLine2 String False

Address line 2 (e.g., apartment, suite, unit, or building).

BusinessSupportAddressPostalCode String False

ZIP or postal code.

BusinessSupportAddressState String False

State, county, province, or region.

BusinessSupportUrl String False

The publicly shareable URL that can be reached for support for this account

BusinessProductDescription String False

An internal-only description of the product or service provided. This is used by Stripe in the event the account gets flagged for potential fraud.

BusinessMcc String False

The merchant category code for the account.

BusinessName String False

The publicly visible name of the business.

BusinessUrl String False

The publicly visible website of the business.

TosAcceptanceDate Datetime False

The Unix timestamp marking when the account representative accepted their service agreement.

TosAcceptanceIp String False

The IP address from which the account representative accepted their service agreement.

TosAcceptanceServiceAgreement String False

The user's service agreement type.

TosAcceptanceUserAgent String False

The user agent of the browser from which the account representative accepted their service agreement.

TransferSchedule String False

When payments collected will be automatically paid out to the bank account of the account holder.

Type String False

A type value is required when creating accounts. The standard type replaces managed: false, and the custom type replaces managed: true.

The allowed values are standard, express, custom.

RequirementsAggregate String True

The state of the information requests for the account, including what information is needed and by when it must be provided.

TransfersEnabled Boolean True

Whether or not Stripe will send automatic transfers for this account.

MetadataAggregate String False

The account metadata object.

Capabilities String False

In the Accounts API, the requested_capabilities property is now required at creation time for Custom accounts in all countries. See Account capabilities for more information.

CompanyAddressCity String False

City, district, suburb, town, or village.

CompanyAddressCountry String False

Two-letter country code.

CompanyAddressLine1 String False

Address line 1 (e.g., street, PO Box, or company name).

CompanyAddressLine2 String False

Address line 2 (e.g., apartment, suite, unit, or building).

CompanyAddressPostalCode String False

ZIP or postal code.

CompanyAddressState String False

State, county, province, or region.

CompanyDirectorsProvided Boolean False

Whether the company's directors have been provided.

CompanyExecutivesProvided Boolean False

Whether the company's executives have been provided.

CompanyName String False

The company's legal name.

CompanyOwnersProvided Boolean False

Whether the company's owners have been provided.

CompanyOwnershipDeclarationDate Datetime False

The Unix timestamp marking when the beneficial owner attestation was made.

CompanyOwnershipDeclarationIp String False

The IP address from which the beneficial owner attestation was made.

CompanyOwnershipDeclarationUserAgent String False

The user agent string from the browser where the beneficial owner attestation was made.

CompanyPhone String False

The company's phone number

CompanyStructure String False

The category identifying the legal structure of the company or legal entity.

CompanyTaxIdProvided Boolean False

Whether the company's business ID number was provided.

CompanyTaxIdRegistrar String False

The jurisdiction in which the tax_id is registered (Germany-based companies only).

CompanyVatIdProvided Boolean False

Whether the company's business VAT number was provided.

CompanyVerificationAggregate String False

A document for the company.

IndividualId String False

Unique identifier for the individual.

IndividualObject String False

String representing the object's type.

IndividualAccount String False

The account the individual is associated with.

IndividualAddressCity String False

City, district, suburb, town, or village.

IndividualAddressCountry String False

Two-letter country code.

IndividualAddressLine1 String False

Address line 1 (e.g., street, PO Box, or company name).

IndividualAddressLine2 String False

Address line 2 (e.g., apartment, suite, unit, or building).

IndividualAddressPostalCode String False

ZIP or postal code.

IndividualAddressState String False

State, county, province, or region.

IndividualDOBDay Integer False

The day of birth, between 1 and 31.

IndividualDOBMonth Integer False

The month of birth, between 1 and 12.

IndividualDOBYear Integer False

The four-digit year of birth.

IndividualEmail String False

The individual's email address.

IndividualFirstName String False

The individual's first name.

IndividualFutureRequirementsAggregate String True

nformation about future requirements for the individual.

IndividualGender String False

The individual's gender.

IndividualIdNumberProvided Boolean False

Whether the individual's personal ID number was provided..

IndividualLastName String False

The individual's last name.

IndividualMaidenName String False

The individual's maiden name.

IndividualMetadataAggregate String False

Metadata for the individual

IndividualNationality String False

The country where the person is a national.

IndividualPhone String False

The individual's phone number.

IndividualPoliticalExposure String False

Indicates if the person or any other closely related persons declares that they have held an important public job or function.

IndividualRegisteredAddressCity String False

City, district, suburb, town, or village.

IndividualRegisteredAddressCountry String False

Two-letter country code.

IndividualRegisteredAddressLine1 String False

Address line 1 (e.g., street, PO Box, or company name).

IndividualRegisteredAddressLine2 String False

Address line 2 (e.g., apartment, suite, unit, or building).

IndividualRegisteredAddressPostalCode String False

ZIP or postal code.

IndividualRegisteredAddressState String False

State, county, province, or region.

IndividualSSNLast4 String False

The last four digits of the individual's Social Security Number (U.S. only).

IndividualVerificationAggregate String False

The individual's verification document information.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AccountId String

The Id of the connected account

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462