MuleSoft Connector for Stripe

Build 21.0.7930

Transfers

Create, update, and query the available transfers in Stripe.

Table Specific Information

Select

Server-Side Query Support

The connector 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 connector.

  • Id, Destination support the following operators:=.

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 retreive:

-a Transfer by specifying its Id:

SELECT * FROM Transfers WHERE Id='tr_12345678'

-Transfers created after a specific date (Created may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range):

SELECT * FROM Transfers WHERE Created>'12/2/2015'

Insert

Currency, Amount, and Destination are required to insert into this table. The Destination is the Id of a connected Stripe account:

INSERT INTO Transfers (Amount, Currency, Destination) VALUES (1000, 'USD', 'acct_19abC2DFGl5DVRzj' )

Update

To update a transfer set a description and specify an Id in the WHERE clause:

UPDATE Transfers SET Description='New desc' WHERE Id='tr_123456788' )

Delete

Delete is not supported.

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the transfer.

Currency String False

The currency.

Amount Integer False

Amount (in cents) to be transferred to your bank account.

AmountReversed Integer False

Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

ApplicationFee String False

The application fee.

BalanceTransaction String False

Balance transaction that describes the impact of this transfer on your account balance.

Created Datetime True

Time that this record of the transfer was first created.

Date Datetime True

Date the transfer is scheduled to arrive in the bank. This doesn't factor in delays like weekends or bank holidays.

Description String False

Internal-only description of the transfer.

Destination String False

The Id of the bank account, card, or Stripe account the transfer was sent to.

DestinationPayment String True

If the destination is a Stripe account, this will be the Id of the payment that the destination account received for the transfer.

FailureCode String True

Error code explaining reason for transfer failure if available.

FailureMessage String True

Message to user further explaining reason for transfer failure if available.

Reversed Boolean True

Whether or not the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

SourceTransaction String False

The Id of the charge (or other transaction) that was used to fund the transfer. If null, the transfer was funded from the available balance.

SourceType String False

The source balance this transfer came from.

StatementDescriptor String False

Extra information about a transfer to be displayed on the user's bank statement.

Status String True

Current status of the transfer.

Type String True

The type of the transfer.Can be card, bank_account, or stripe_account.

MetadataAggregate String False

The transfer metadata object.

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 to get transfers for.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930