Namespace | http://www.mulesoft.org/schema/mule/stripe |
---|---|
Schema Location | http://www.mulesoft.org/schema/mule/stripe/current/mule-stripe.xsd (View Schema) |
Schema Version | 1.0 |
Minimum Mule Version | 3.2 |
Anypoint Connector
Configuration | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Configure an instance of this module
|
Message Processors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Cancel a Subscription
| |||||||||||
Capture a Charge
| |||||||||||
Create an Account
| |||||||||||
Create an Application Fee Refund
Refunds an application fee that has previously been collected but not yet refunded.
| |||||||||||
Create a Bank Account Token
Creates a single use token that wraps the details of a bank account.
| |||||||||||
Create a BitCoin Receiver
Creates a Bitcoin receiver object that can be used to accept bitcoin payments from your customer.
| |||||||||||
Create a Card
Note that this is only available for Customers at this time, as Recipients (of Transfers) have been deprecated by Stripe.
| |||||||||||
Create a Card Token
| |||||||||||
Create a Charge
| |||||||||||
Create a Coupon
| |||||||||||
Create a Customer
| |||||||||||
Create a file upload
To upload a file to Stripe, you'll need to send a request of type multipart/form-data.
| |||||||||||
Create an invoice
Invoices are statements of what a customer owes for a particular billing period, including subscriptions, invoice items, and any automatic proration adjustments if necessary.
| |||||||||||
Create a Plan
| |||||||||||
Create a Refund
When you create a new refund, you must specify a charge to create it on.
| |||||||||||
Create a Subscription
| |||||||||||
Delete a Card
| |||||||||||
Delete a Coupon
| |||||||||||
Delete a Customer
| |||||||||||
Delete a Plan
| |||||||||||
List Active Subscriptions
| |||||||||||
List All Application Fee Refunds
You can see a list of the refunds belonging to a specific application fee.
| |||||||||||
List all Application Fees
| |||||||||||
List all Balance History
| |||||||||||
List All Bitcoin Receivers
Returns a list of your receivers.
| |||||||||||
List all Charges
| |||||||||||
List all Coupons
| |||||||||||
List all Customer Cards
Note that this is only available for Customers at this time, as Recipients (of Transfers) have been deprecated by Stripe.
| |||||||||||
List all Customers
| |||||||||||
List All Events
List events, going back up to 30 days.
| |||||||||||
List All Plans
| |||||||||||
List All Refunds
You can see a list of the refunds belonging to a specific charge.
| |||||||||||
Pay an invoice
| |||||||||||
Retrieve an Account's Details
| |||||||||||
List all Invoices
| |||||||||||
Retrieve an Application Fee
| |||||||||||
Retrieve an Application Fee Refund
By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.
| |||||||||||
Retrieve the balance
| |||||||||||
Retrieve a Balance Transaction
| |||||||||||
Retrieve a Bitcoin Receiver
Retrieves the Bitcoin receiver with the given ID.
| |||||||||||
Retrieve a Card
Note that this is only available for Customers at this time, as Recipients (of Transfers) have been deprecated by Stripe.
| |||||||||||
Retrieve a Charge
| |||||||||||
Retrieve a Coupon
| |||||||||||
Retrieve a Customer
| |||||||||||
Retrieve a Event
Retrieves the Event with the given ID
| |||||||||||
Retrieve an Invoice
| |||||||||||
Retrieve an invoice's line items
When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items.
| |||||||||||
Retrieve a Plan
| |||||||||||
Retrieve a Refund
By default, you can see the 10 most recent refunds stored directly on the charge object, but you can also retrieve details about a specific refund stored on the charge.
| |||||||||||
Retrieve a Subscription
| |||||||||||
Retrieve a Token
Retrieves the token with the given ID
| |||||||||||
Retrieve an upcoming invoice
At any time, you can preview the upcoming invoice for a customer.
| |||||||||||
Update an Account
You may only update accounts that you manage.
| |||||||||||
Update an Application Fee Refund
Updates the specified application fee refund by setting the values of the parameters passed.
| |||||||||||
Update a Card
Note that this is only available for Customers at this time, as Recipients (of Transfers) have been deprecated by Stripe.
| |||||||||||
Update a Charge
Updates the specified charge by setting the values of the parameters passed.
| |||||||||||
Update a Coupon
Updates the metadata of a coupon.
| |||||||||||
Update a Customer.
| |||||||||||
Update an invoice
| |||||||||||
Update a Plan
| |||||||||||
Update a Refund
Updates the specified refund by setting the values of the parameters passed.
| |||||||||||
Update a Subscription
Note that Stripe uses a specific policy around prorating changed subscriptions.
|
To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:
<mule xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:stripe="http://www.mulesoft.org/schema/mule/stripe" xsi:schemaLocation=" http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd http://www.mulesoft.org/schema/mule/stripe http://www.mulesoft.org/schema/mule/stripe/current/mule-stripe.xsd"> <!-- here goes your flows and configuration elements --> </mule>
Cancel a Subscription
<stripe:cancel-subscription config-ref="" customerId="#[map-payload:customerId]" subscriptionId="#[map-payload:subscriptionId]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the customer to cancel the subscription of | String | */* | UTF-8 | ||
ID of subscription to cancel. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Subscription | Returns the deleted subscription object. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Capture a Charge
<stripe:capture-charge config-ref="" id="#[map-payload:id]" amount="#[map-payload:amount]" statementDescriptor="#[map-payload:statementDescriptor]" receiptEmail="#[map-payload:receiptEmail]" applicationFee="#[map-payload:applicationFee]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id of the charge to capture | String | */* | UTF-8 | ||
0 | The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. | int | */* | ||
0 | An application fee to add on to this charge. Can only be used with Stripe Connect. | int | */* | ||
Optional. An arbitrary string to be displayed on your customer's credit card statement. This may be up to 22 characters. As an example, if your website is RunClub and the item you're charging for is a race ticket, you may want to specify a statement_descriptor of RunClub 5K race ticket. The statement description may not include <>"' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all. | String | */* | UTF-8 | ||
Optional. The email the receipt should be sent to | String | */* | UTF-8 |
Return Type | Description |
---|---|
Charge | Returns the charge object, with an updated captured property (set to true). Capturing a charge will always succeed, unless the charge is already refunded, expired, captured, or an invalid capture amount is specified, in which case this method will throw an error. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create an Account
<stripe:create-account config-ref="" > <stripe:create-account-parameters ref="#[map-payload:createAccountParameters]"/> </stripe:create-account>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
#[payload] | Wrapper for the complex parameter set | CreateAccountParameters | */* |
Return Type | Description |
---|---|
Account | Returns an account object if the call succeeded. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create an Application Fee Refund Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account that the fee was originally collected from. You can optionally refund only part of an application fee. You can do so as many times as you wish until the entire fee has been refunded. Once entirely refunded, an application fee can't be refunded again. This method will throw an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.
<stripe:create-application-fee-refund config-ref="" id="#[map-payload:id]" amount="#[map-payload:amount]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the application fee to be refunded. | String | */* | UTF-8 | ||
0 | A positive integer in cents representing how much of this fee to refund. Can only refund up to the unrefunded amount remaining of the fee. | int | */* |
Return Type | Description |
---|---|
ApplicationFee | Returns the application fee refund object if the refund succeeded. Throws an error if the fee has already been refunded or an invalid fee identifier was provided. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a Bank Account Token Creates a single use token that wraps the details of a bank account. This token can be used in place of a bank account Map with any API method. These tokens can only be used once: by attaching them to a recipient.
<stripe:create-bank-account-token config-ref="" bankAccountId="#[map-payload:bankAccountId]"> <stripe:bank-account ref="#[map-payload:bankAccount]"/> </stripe:create-bank-account-token>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. The bank account's ID, or... | String | */* | UTF-8 | ||
#[payload] | ... Otherwise, if you do not pass a bank account ID, a Map containing a the account details | BankAccount | */* |
Return Type | Description |
---|---|
Token | The created bank account token object is returned if successful. Otherwise, this call throws an error. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a BitCoin Receiver Creates a Bitcoin receiver object that can be used to accept bitcoin payments from your customer. The receiver exposes a Bitcoin address and is created with a bitcoin to USD exchange rate that is valid for 10 minutes.
<stripe:create-bitcoin-receiver config-ref="" amount="#[map-payload:amount]" currency="#[map-payload:currency]" email="#[map-payload:email]" description="#[map-payload:description]" refundMispayments="#[map-payload:refundMispayments]"> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:create-bitcoin-receiver>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The amount of currency that you will be paid | int | */* | |||
USD | The currency to which the bitcoin will be converted. You will be paid out in this currency. Only USD is currently supported. | String | */* | UTF-8 | |
The email address of the customer. | String | */* | UTF-8 | ||
Optional. A description of the receiver | String | */* | UTF-8 | ||
false | A flag that indicates whether you would like Stripe to automatically handle refunds for any mispayments to the receiver. | boolean | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format. | Map<String, Object> |
Return Type | Description |
---|---|
BitcoinReceiver | Returns a Bitcoin receiver object if the call succeeded. The returned object will include the Bitcoin address of the receiver and the bitcoin amount required to fill it. The call will throw an error if a currency other than USD or an amount greater than $15,000.00 is specified. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a Card Note that this is only available for Customers at this time, as Recipients (of Transfers) have been deprecated by Stripe. Stripe Connect is the recommended means for transferring funds.
<stripe:create-card config-ref="" ownerId="#[map-payload:ownerId]" sourceToken="#[map-payload:sourceToken]"> <stripe:source ref="#[map-payload:source]"/> </stripe:create-card>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID for the Customer or Recipient | String | */* | UTF-8 | ||
Optional. The source can either be a token, like the ones returned by Stripe.js, | String | */* | UTF-8 | ||
#[payload] | Or a dictionary containing a user’s credit card details (with the options shown below). Whenever you create a new card for a customer, Stripe will automatically validate the card. | Source | */* |
Return Type | Description |
---|---|
Card | Returns the created Card. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a Card Token
<stripe:create-card-token config-ref="" cardId="#[map-payload:cardId]" customer="#[map-payload:customer]"> <stripe:card ref="#[map-payload:card]"/> </stripe:create-card-token>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer... | String | */* | UTF-8 | ||
#[payload] | ... Otherwise, if you do not pass a customer, a Map containing a user's credit card details | Source | */* | ||
Optional. For use with Stripe Connect only; this can only be used with an OAuth access token or Stripe-Account header.. For more details, see the shared customers documentation. A customer (owned by the application's account) to create a token for. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Token | The created card token object is returned if successful. Otherwise, this call throws an error. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a Charge
<stripe:create-charge config-ref="" > <stripe:create-charge-parameters ref="#[map-payload:createChargeParameters]"/> </stripe:create-charge>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
#[payload] | Wrapper object for Create Charge Parameters | CreateChargeParameters | */* |
Return Type | Description |
---|---|
Charge | Returns the created Charge. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a Coupon
<stripe:create-coupon config-ref="" id="#[map-payload:id]" duration="#[map-payload:duration]" amountOff="#[map-payload:amountOff]" currency="#[map-payload:currency]" durationInMonths="#[map-payload:durationInMonths]" maxRedemptions="#[map-payload:maxRedemptions]" percentOff="#[map-payload:percentOff]" redeemBy="#[map-payload:redeemBy]" > <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:create-coupon>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. Unique string of your choice that will be used to identify this coupon when applying it a customer. This is often a specific code you’ll give to your customer to use when signing up (e.g. FALL25OFF). If you don’t want to specify a particular code, you can leave the ID blank and we’ll generate a random code for you. | String | */* | UTF-8 | ||
Specifies how long the discount will be in effect. Can be forever, once, or repeating. | String | */* | UTF-8 | ||
0 | A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed) | int | */* | ||
Optional. Currency of the amount_off parameter (required if amount_off is passed) | String | */* | UTF-8 | ||
0 | Required only if duration is repeating If duration is repeating, a positive integer that specifies the number of months the discount will be in effect | int | */* | ||
0 | A positive integer specifying the number of times the coupon can be redeemed before it’s no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. | int | */* | ||
0 | A positive integer between 1 and 100 that represents the discount the coupon will apply (required if amount_off is not passed) | int | */* | ||
Optional. Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a coupon object. It can be useful for storing additional information about the coupon in a structured format. | Map<String, Object> |
Return Type | Description |
---|---|
Coupon | Coupon created |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a Customer
<stripe:create-customer config-ref="" accountBalance="#[map-payload:accountBalance]" couponCode="#[map-payload:couponCode]" description="#[map-payload:description]" email="#[map-payload:email]"> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:create-customer>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
0 | An integer amount in cents that is the starting account balance for your customer. A negative amount represents a credit that will be used before attempting any charges to the customer’s card; a positive amount will be added to the next invoice. | int | */* | ||
Optional. If you provide a coupon code, the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount. | String | */* | UTF-8 | ||
Optional. An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. | String | */* | UTF-8 | ||
Optional. Customer’s email address. | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format. | Map<String, Object> |
Return Type | Description |
---|---|
Customer | Customer created |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a file upload To upload a file to Stripe, you'll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
<stripe:create-file-upload config-ref="" file="#[map-payload:file]" purpose="#[map-payload:purpose]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the multipart/form-data protocol). | String | */* | UTF-8 | ||
The purpose of the uploaded file. Possible values are identity_document, dispute_evidence. | FilePurpose | */* |
Return Type | Description |
---|---|
FileUpload | Returns the file object. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create an invoice Invoices are statements of what a customer owes for a particular billing period, including subscriptions, invoice items, and any automatic proration adjustments if necessary. Once an invoice is created, payment is automatically attempted. Note that the payment, while automatic, does not happen exactly at the time of invoice creation. If you have configured webhooks, the invoice will wait until one hour after the last webhook is successfully sent (or the last webhook times out after failing). Any customer credit on the account is applied before determining how much is due for that invoice (the amount that will be actually charged). If the amount due for the invoice is less than 50 cents (the minimum for a charge), we add the amount to the customer's running account balance to be added to the next invoice. If this amount is negative, it will act as a credit to offset the next invoice. Note that the customer account balance does not include unpaid invoices; it only includes balances that need to be taken into account when calculating the amount due for the next invoice.
<stripe:create-invoice config-ref="" customerId="#[map-payload:customerId]" applicationFee="#[map-payload:applicationFee]" description="#[map-payload:description]" statementDescriptor="#[map-payload:statementDescriptor]" subscription="#[map-payload:subscription]" taxPercent="#[map-payoad:taxPercent]"> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:create-invoice>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The customer to create the invoice for | String | */* | UTF-8 | ||
0 | A fee in cents that will be applied to the invoice and transferred to the application owner’s Stripe account. | int | */* | ||
Optional. The invoice description | String | */* | UTF-8 | ||
Optional. Extra information about a charge for the customer’s credit card statement. | String | */* | UTF-8 | ||
Optional. The ID of the subscription to invoice. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will exclude pending invoice items that pertain to other subscriptions. | String | */* | UTF-8 | ||
0.0 | The percent tax rate applied to the invoice, represented as a decimal number. | double | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | Arbitrary key-value pairs to attach to the invoice | Map<String, Object> |
Return Type | Description |
---|---|
Invoice | Returns the invoice object if there are pending invoice items to invoice. Throws an error if there are no pending invoice items or if the customer ID provided is invalid. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a Plan
<stripe:create-plan config-ref="" id="#[map-payload:id]" amount="#[map-payload:amount]" currency="#[map-payload:currency]" interval="#[map-payload:interval]" intervalCount="#[map-payload:intervalCount]" planName="#[map-payload:planName]" trialPeriodDays="#[map-payload:trialPeriodDays]" statementDescriptor="#[map-payload:statementDescriptor]"> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:create-plan>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Unique string of your choice that will be used to identify this plan when subscribing a customer. This could be an identifier like "gold" or a primary key from your own database. | String | */* | UTF-8 | ||
A positive integer in cents (or 0 for a free plan) representing how much to charge (on a recurring basis). | int | */* | |||
3-letter ISO code for currency. | String | */* | UTF-8 | ||
Specifies billing frequency. Either day, week, month or year. | String | */* | UTF-8 | ||
1 | The number of intervals between each subscription billing. For example, interval=month and interval_count=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). | int | */* | ||
Name of the plan, to be displayed on invoices and in the web interface. | String | */* | UTF-8 | ||
0 | Specifies a trial period in (an integer number of) days. If you include a trial period, the customer won't be billed for the first time until the trial period ends. If the customer cancels before the trial period is over, she'll never be billed at all. | int | */* | ||
Optional. An arbitrary string to be displayed on your customer's credit card statement. This may be up to22 characters. | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a plan object. It can be useful for storing additional information about the plan in a structured format. | Map<String, Object> |
Return Type | Description |
---|---|
Plan | Plan the created Plan |
Payload Class | Description |
---|---|
StripeConnectorException | when there is an issue creating a Plan |
Create a Refund When you create a new refund, you must specify a charge to create it on. Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged. The fees you were originally charged are also refunded. You can optionally refund only part of a charge. You can do so as many times as you wish until the entire charge has been refunded. Once entirely refunded, a charge can't be refunded again. This method will throw an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.
<stripe:create-refund config-ref="" id="#[map-payload:id]" amount="#[map-payload:amount]" refundApplicationFee="#[map-payload:refundApplicationFee]" reason="#[map-payload:reason]" > <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:create-refund>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the charge to be refunded. | String | */* | UTF-8 | ||
0 | A positive integer in cents representing how much of this charge to refund. Can only refund up to the unrefunded amount remaining of the charge. | int | */* | ||
false | Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Else, the application fee will be refunded with an amount proportional to the amount of the charge refunded. An application fee can only be refunded by the application that created the charge. | boolean | */* | ||
Optional. String indicating the reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer. Specifying fraudulent as the reason when you believe the charge to be fraudulent will help us improve our fraud detection algorithms. | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a refund object. It can be useful for storing additional information about the refund in a structured format. You can unset an individual key by setting its value to null and then saving. To clear all keys, set metadata to null, then save. | Map<String, Object> |
Return Type | Description |
---|---|
Refund | Returns the refund object if the refund succeeded. Throws an error if the charge has already been refunded or an invalid charge identifier was provided. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Create a Subscription
<stripe:create-subscription config-ref=""> <stripe:create-subscription-parameters ref="#[map-payload:createSubscriptionParameters]"/> </stripe:create-subscription>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
#[payload] | The Wrapped Subscription Parameters | CreateSubscriptionParameters | */* |
Return Type | Description |
---|---|
Subscription | Returns the newly created subscription object if the call succeeded. If the customer has no card or the attempted charge fails, this call throws an error (unless the specified plan is free or has a trial period). |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Delete a Card
<stripe:delete-card config-ref="" ownerId="#[map-payload:ownerId]" id="#[map-payload:id]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the owner of the card. | String | */* | UTF-8 | ||
The ID of the card to be deleted. | String | */* | UTF-8 |
Return Type | Description |
---|---|
DeletedCard | Returns the deleted card object. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Delete a Coupon
<stripe:delete-coupon config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the coupon to be deleted. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Object | An object with the deleted coupon's ID and a deleted flag upon success. Otherwise, this call throws an error, such as if the coupon has already been deleted. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Delete a Customer
<stripe:retrieve-customer config-ref="" id="#[map-payload:id]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the customer to be deleted. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Object | Returns an object with a deleted parameter on success. If the customer ID does not exist, this call throws an error. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Delete a Plan
<stripe:retrieve-plan config-ref="" id="#[map-payload:id]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id of the plan to delete | String | */* | UTF-8 |
Return Type | Description |
---|---|
Object | Object JSON containing success or failure |
Payload Class | Description |
---|---|
StripeConnectorException | when there is an issue deleting a Plan |
List Active Subscriptions
<stripe:list-active-subscriptions config-ref="" customerId="#[map-payload:customerId]" endingBefore="#[map-payload:endingBefore]" limit="#[map-payload:limit]" startingAfter="#[map-payoad:startingAfter]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the customer whose subscriptions will be retrieved | String | */* | UTF-8 | ||
Optional. 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. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 |
Return Type | Description |
---|---|
CustomerSubscriptionCollection | Returns a list of the customer's active subscriptions. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List All Application Fee Refunds You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds
<stripe:list-all-application-fee-refunds config-ref="" id="#[map-payload:id]" endingBefore="#[map-payload:endingBefore]" limit="#[map-payload:limit]" startingAfter="#[map-payload:startingAfter]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the application fee whose refunds will be retrieved. | String | */* | UTF-8 | ||
Optional. 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. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 |
Return Type | Description |
---|---|
FeeRefundCollection | A Map with a data property that contains an array of up to limit refunds, starting after starting_after. Each entry in the array is a separate application fee refund object. If no more refunds are available, the resulting array will be empty. If you provide a non-existent application fee ID, this call throws an error. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List all Application Fees
<stripe:list-all-application-fees config-ref="" charge="#[map-payload:charge]" createdTimestamp="#[map-payload:createdTimestamp]" endingBefore="#[map-payload:endingBefore]" limit="#[map-payload:limit]" startingAfter="#[map-payload:startingAfter]" > <stripe:created ref="#[map-payload:created]"/> </stripe:list-all-application-fees>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. Only return application fees for the charge specified by this charge ID. | String | */* | UTF-8 | ||
Optional. A filter on the list based on the created field. The value can be a string with an integer Unix timestamp,... | String | */* | UTF-8 | ||
#[payload] | Or it can be a dictionary with the following options: gt, gte, lt, lte | TimeRange | */* | ||
Optional. 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. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 |
Return Type | Description |
---|---|
ApplicationFeeCollection | Returns Application Fee |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List all Balance History
<stripe:list-all-balance-history config-ref=""> <stripe:list-all-balance-history-parameters ref="#[map-payload:listAllBalanceHistoryParameters]"/> </stripe:list-all-balance-history>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | Wrapper object for list all balance history parameters | ListAllBalanceHistoryParameters |
Return Type | Description |
---|---|
BalanceTransactionCollection | Returns a balance object for the API key used. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List All Bitcoin Receivers Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.
<stripe:list-all-bitcoin-receivers config-ref="" active="#[map-payload:active]" endingBefore="#[map-payload:endingBefore]" filled="#[map-payload:filled]" limit="#[map-payload:limit]" startingAfter="#[map-payload:startingAfter]" uncapturedFunds="#[map-payload:uncapturedFunds]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. Filter for active receivers. | String | */* | UTF-8 | ||
Optional. 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. | String | */* | UTF-8 | ||
Optional. Filter for filled receivers. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 | ||
Optional. Filter for receivers with uncaptured funds. | String | */* | UTF-8 |
Return Type | Description |
---|---|
BitcoinReceiverCollection | A Map with a data property that contains an array of up to limit Bitcoin receivers, starting after receiver starting_after. Each entry in the array is a separate Bitcoin receiver object. If no more receivers are available, the resulting array will be empty. This request should never throw an error. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List all Charges
<stripe:list-all-charges config-ref="" createdTimestamp="#[map-payload:createdTimestamp]" customer="#[map-payload:customer]" endingBefore="#[map-payload:endingBefore]" limit="#[map-payload:limit]" startingAfter="#[map-payoad:startingAfter]"> <stripe:created ref="#[map-payload:created]"/> </stripe:list-all-charges>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, | String | */* | UTF-8 | ||
#[payload] | ... or it can be a dictionary with the following options: gt, gte, lt, lte | TimeRange | */* | ||
Optional. Only return charges for the customer specified by this customer ID. | String | */* | UTF-8 | ||
Optional. 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. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 |
Return Type | Description |
---|---|
ChargeCollection | A Map with a data property that contains an array of up to limit charges, starting after charge starting_after. Each entry in the array is a separate charge object. If no more charges are available, the resulting array will be empty. If you provide a non-existent customer ID, this call throws an error. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List all Coupons
<stripe:list-all-coupons config-ref=""> <stripe:list-all-coupons-parameters ref="#[map-payload:listAllCouponsParameters]"/> </stripe:list-all-coupons>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A wrapper class for the parameters | ListAllCouponsParameters |
Return Type | Description |
---|---|
CouponCollection | A Map with a data property that contains an array of up to limit coupons, starting after coupon starting_after. Each entry in the array is a separate coupon object. If no more coupons are available, the resulting array will be empty. This request should never throw an error. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List all Customer Cards Note that this is only available for Customers at this time, as Recipients (of Transfers) have been deprecated by Stripe. Stripe Connect is the recommended means for transferring funds.
<stripe:list-all-customer-cards config-ref="" ownerId="#[map-payload:ownerId]" endingBefore="#[map-payload:endingBefore]" limit="#[map-payload:limit]" startingAfter="#[map-payoad:startingAfter]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the customer whose cards will be retrieved | String | */* | UTF-8 | ||
Optional. 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. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 |
Return Type | Description |
---|---|
PaymentSourceCollection | Returns a list of the cards stored on the customer or recipient. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List all Customers
<stripe:list-all-customers config-ref="" limit="#[map-payload:limit]" startingAfter="#[map-payload:startingAfter]" endingBefore="#[map-payload:endingBefore]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
0 | A limit on the number of records to fetch in a batch | int | */* | ||
Optional. A cursor (id) for use in pagination. | String | */* | UTF-8 | ||
Optional. A cursor for use in pagination. ending_before is an object ID that defines your place in the list. | String | */* | UTF-8 |
Return Type | Description |
---|---|
CustomerCollection | CustomerCollection of Customers found |
Payload Class | Description |
---|---|
StripeConnectorException | when there is an issue listing customers |
List All Events List events, going back up to 30 days.
<stripe:list-all-events config-ref="" createdTimestamp="#[map-payload:createdTimestamp]" endingBefore="#[map-payload:endingBefore]" limit="#[map-payload:limit]" startingAfter="#[map-payload:startingAfter]" type="#[map-payload:type]"> <stripe:created ref="#[map-payload:created]"/> </stripe:list-all-events>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp | String | */* | UTF-8 | ||
#[payload] | Or it can be a dictionary with the following options: gt, gte, lt, lte | TimeRange | */* | ||
Optional. 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. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 | ||
Optional. A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property | String | */* | UTF-8 |
Return Type | Description |
---|---|
EventCollection | A Map with a data property that contains an array of up to limit events, starting after event starting_after, sorted in reverse chronological order. Each entry in the array is a separate event object. If no more events are available, the resulting array will be empty. This request should never throw an error. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List All Plans
<stripe:list-all-plans config-ref=""> <stripe:list-all-plans-parameters ref="#[map-payload:listAllPlansParameters]"/> </stripe:list-all-plans>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | An object that wraps the parameters for List All Plans | ListAllPlansParameters |
Return Type | Description |
---|---|
PlanCollection | PlanCollection the plans that matched the criteria |
Payload Class | Description |
---|---|
StripeConnectorException | when there is an issue listing plans |
List All Refunds You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
<stripe:list-all-refunds config-ref="" chargeId="#[map-payload:chargeId]" endingBefore="#[map-payload:endingBefore]" limit="#[map-payload:limit]" startingAfter="#[map-payoad:startingAfter]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the charge whose refunds will be retrieved. | String | */* | UTF-8 | ||
Optional. 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. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 |
Return Type | Description |
---|---|
ChargeRefundCollection | Returns a list of the charge's refunds |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Pay an invoice
<stripe:pay-invoice config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The invoice id | String | */* | UTF-8 |
Return Type | Description |
---|---|
Invoice | Returns the invoice object |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve an Account's Details
<stripe:retrieve-account config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the account to be retrieved. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Account | Returns Account |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
List all Invoices
<stripe:retrieve-all-invoices config-ref="" customerId="#[map-payload:customerId]" dateTimestamp="#[map-payload:dateTimestamp]" endingBefore="#[map-payload:endingBefore]" limit="#[map-payload:limit]" startingAfter="#[map-payload:startingAfter]"> <stripe:date ref="#[map-payload:date]"/> </stripe:retrieve-all-invoices>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Optional. The id of the customer | String | */* | UTF-8 | ||
Optional. A filter on the list based on the object date field. The value can be a string with an integer Unix timestamp,... | String | */* | UTF-8 | ||
#[payload] | Or it can be a dictionary with the following options: gt, gte, lt, lte | TimeRange | */* | ||
Optional. 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. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 |
Return Type | Description |
---|---|
InvoiceCollection | Returns the collection of invoices |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve an Application Fee
<stripe:retrieve-application-fee config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the fee to be retrieved. | String | */* | UTF-8 |
Return Type | Description |
---|---|
ApplicationFee | Returns Application Fee |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve an Application Fee Refund By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.
<stripe:retrieve-application-fee-refund config-ref="" id="#[map-payload:id]" fee="#[map-payload:fee]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the refund to retrieve | String | */* | UTF-8 | ||
ID of the Application Fee refunded | String | */* | UTF-8 |
Return Type | Description |
---|---|
FeeRefund | Returns the application fee refund object if the refund succeeded. Throws an error if the fee has already been refunded or an invalid fee identifier was provided. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve the balance
<stripe:retrieve-balance config-ref=""/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. |
Return Type | Description |
---|---|
Balance | Returns a balance object for the API key used. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Balance Transaction
<stripe:retrieve-balance-transaction config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id of the transaction | String | */* | UTF-8 |
Return Type | Description |
---|---|
BalanceTransaction | Returns a balance transaction if a valid balance transaction ID was provided. Throws an error otherwise. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Bitcoin Receiver Retrieves the Bitcoin receiver with the given ID.
<stripe:retrieve-bitcoin-receiver config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the receiver to retrieve | String | */* | UTF-8 |
Return Type | Description |
---|---|
BitcoinReceiver | Returns a Bitcoin receiver if a valid ID was provided. Throws an error otherwise. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Card Note that this is only available for Customers at this time, as Recipients (of Transfers) have been deprecated by Stripe. Stripe Connect is the recommended means for transferring funds.
<stripe:retrieve-card config-ref="" ownerId="#[map-payload:ownerId]" id="#[map-payload:id]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the owner of the card. | String | */* | UTF-8 | ||
The ID of the card to be retrieved. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Card | Returns the retrieved Card. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Charge
<stripe:retrieve-charge config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the charge to be retrieved. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Charge | Returns a charge object if a valid identifier was provided, and throws an error otherwise. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Coupon
<stripe:retrieve-coupon config-ref="" id="#[map-payload:id]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the desired coupon. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Coupon | Coupon retrieved |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Customer
<stripe:retrieve-customer config-ref="" id="#[map-payload:id]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the customer to be retrieved. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Customer | Returns a customer object if a valid identifier was provided. When requesting the ID of a customer that has been deleted, a subset of the customer's information will be returned, including a "deleted" property, which will be true. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Event Retrieves the Event with the given ID
<stripe:retrieve-event config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the desired event | String | */* | UTF-8 |
Return Type | Description |
---|---|
Event | Returns a event if a valid ID was provided. Throws an error otherwise. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve an Invoice
<stripe:retrieve-invoice config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the desired invoice | String | */* | UTF-8 |
Return Type | Description |
---|---|
Invoice | Returns the invoice requested. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve an invoice's line items When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
<stripe:retrieve-invoice-line-items config-ref="" id="#[map-payload:id]" customer="#[map-payload:customer]" endingBefore="#[map-payload:endingBefore]" limit="#[map-payload:limit]" startingAfter="#[map-payload:startingAfter]" subscription="#[map-payload:subscription]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id of the invoice containing the lines to be retrieved | String | */* | UTF-8 | ||
Optional. In the case of upcoming invoices, the customer of the upcoming invoice is required. In other cases it is ignored. | String | */* | UTF-8 | ||
Optional. 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. | String | */* | UTF-8 | ||
0 | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | int | */* | ||
Optional. 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. | String | */* | UTF-8 | ||
Optional. In the case of upcoming invoices, the subscription of the upcoming invoice is optional. In other cases it is ignored. | String | */* | UTF-8 |
Return Type | Description |
---|---|
InvoiceLineItemCollection | Returns the collection of invoice line items |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Plan
<stripe:retrieve-plan config-ref="" id="#[map-payload:id]" />
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id of the plan to retrieve | String | */* | UTF-8 |
Return Type | Description |
---|---|
Plan | Plan the retrieved Plan |
Payload Class | Description |
---|---|
StripeConnectorException | when there is an issue retrieving a Plan |
Retrieve a Refund By default, you can see the 10 most recent refunds stored directly on the charge object, but you can also retrieve details about a specific refund stored on the charge.
<stripe:retrieve-refund config-ref="" id="#[map-payload:id]" chargeId="#[map-payload:chargeId]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the refund | String | */* | UTF-8 | ||
The identifier of the Charge refunded. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Refund | Returns Returns the refund object if found. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Subscription
<stripe:retrieve-subscription config-ref="" customerId="#[map-payload:customerId]" subscriptionId="#[map-payload:subscriptionId]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the customer to create the subscription on | String | */* | UTF-8 | ||
ID of subscription to retrieve. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Subscription | Returns the subscription object. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve a Token Retrieves the token with the given ID
<stripe:retrieve-token config-ref="" id="#[map-payload:id]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the desired token | String | */* | UTF-8 |
Return Type | Description |
---|---|
Token | Returns a token if a valid ID was provided. Throws an error otherwise. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Retrieve an upcoming invoice At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer. Note that when you are viewing an upcoming invoice, you are simply viewing a preview -- the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
<stripe:retrieve-upcoming-invoice config-ref="" customerId="#[map-payload:customerId]" subscription="#[map-payload:subscription]"/>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the customer whose upcoming invoice you'd like to retrieve. | String | */* | UTF-8 | ||
Optional. The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. | String | */* | UTF-8 |
Return Type | Description |
---|---|
Invoice | Returns an invoice if a valid customer ID was provided. Throws an error otherwise. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Update an Account You may only update accounts that you manage. To update your own account, you can currently only do so via the dashboard.
<stripe:update-account config-ref="" > <stripe:update-account-parameters ref="#[map-payload:updateAccountParameters]"/> </stripe:update-account>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
#[payload] | Wrapper for the Update Account Parameters | UpdateAccountParameters | */* |
Return Type | Description |
---|---|
Account | Returns an account object if the call succeeded. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Update an Application Fee Refund Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request only accepts metadata as an argument.
<stripe:update-application-fee-refund config-ref="" id="#[map-payload:id]" fee="#[map-payload:fee]"> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:update-application-fee-refund>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the refund. | String | */* | UTF-8 | ||
The identifier of the Application Fee refunded | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a refund object. It can be useful for storing additional information about the refund in a structured format. You can unset an individual key by setting its value to null and then saving. | Map<String, Object> |
Return Type | Description |
---|---|
FeeRefund | Returns the application fee refund object if the refund succeeded. Throws an error if the fee has already been refunded or an invalid fee identifier was provided. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Update a Card Note that this is only available for Customers at this time, as Recipients (of Transfers) have been deprecated by Stripe. Stripe Connect is the recommended means for transferring funds.
<stripe:update-card config-ref="" ownerId="#[map-payload:ownerId]" id="#[map-payload:id]" addressCity="#[map-payload:addressCity]" addressCountry="#[map-payload:addressCountry]" addressLine1="#[map-payload:addressLine1]" addressLine2="#[map-payload:addressLine2]" addressState="#[map-payload:addressState]" addressZip="#[map-payload:addressZip]" expMonth="#[map-payload:expMonth]" expYear="#[map-payload:expYear]" cardName="#[map-payload:cardName]"> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:update-card>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the owner of the card. | String | */* | UTF-8 | ||
The ID of the card to be updated. | String | */* | UTF-8 | ||
Optional. The City component of the Card Address | String | */* | UTF-8 | ||
Optional. The Country component of the Card Address | String | */* | UTF-8 | ||
Optional. The Address, Line 1, component of the Card Address | String | */* | UTF-8 | ||
Optional. The Address, Line 2, component of the Card Address | String | */* | UTF-8 | ||
Optional. The State component of the Card Address | String | */* | UTF-8 | ||
Optional. The Zipcode component of the Card Address | String | */* | UTF-8 | ||
Optional. The Card's expiry month | String | */* | UTF-8 | ||
Optional. The Card's expiry year | String | */* | UTF-8 | ||
Optional. The name for the card | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | Arbitrary metadata to attach to the card | Map<String, Object> |
Return Type | Description |
---|---|
Card | Returns the updated Card. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Update a Charge Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the description, metadata, receipt_emailand fraud_details as arguments.
<stripe:update-charge config-ref="" id="#[map-payload:id]" description="#[map-payload:description]" receiptEmail="#[map-payload:receiptEmail]"> <stripe:metadata ref="#[map-payload:metadata]"/> <stripe:fraud-details ref="#[map-payload:fraudDetails]"/> </stripe:update-charge>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id of the charge to update | String | */* | UTF-8 | ||
Optional. An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing. | String | */* | UTF-8 | ||
Optional. The email address to send this charge's receipt to. The receipt will not be sent until the charge is paid. If this charge is for a customer, the email address specified here will override the customer's email address. Receipts will not be sent for test mode charges. If receipt_email is specified for a charge in live mode, a receipt will be sent regardless of your email settings. | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a charge object. It can be useful for storing additional information about the customer in a structured format. It's often a good idea to store an email address in metadata for tracking later. | Map<String, Object> | |
Optional. A set of key/value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a user_report key with a value of fraudulent. If you believe a charge is safe, include a user_report key with a value of safe. Note that you must refund a charge before setting the user_report to fraudulent. Stripe will use the information you send to improve our fraud detection algorithms. | Map<String, String> |
Return Type | Description |
---|---|
Charge | Returns the created Charge. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Update a Coupon Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
<stripe:update-coupon config-ref="" id="#[map-payload:id]" > <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:update-coupon>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The ID of the coupon to be updated. | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a coupon object. It can be useful for storing additional information about the coupon in a structured format. | Map<String, Object> |
Return Type | Description |
---|---|
Coupon | Coupon updated |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Update a Customer. Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the card parameter, that becomes the customer's active card to be used for all charges in the future. When you update a customer to a new valid card: for each of the customer's current subscriptions, if the subscription is in the past_due state, then the latest unpaid, unclosed invoice for the subscription will be retried (note that this retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice). (Note also that no invoices pertaining to subscriptions in the unpaid state, or invoices pertaining to canceled subscriptions, will be retried as a result of updating the customer's card.) This request accepts mostly the same arguments as the customer creation call.
<stripe:update-customer config-ref="" id="#[map-payload:id]" accountBalance="#[map-payload:accountBalance]" couponCode="#[map-payload:couponCode]" description="#[map-payload:description]" email="#[map-payload:email]"> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:update-customer>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The id of the Customer to update | String | */* | UTF-8 | ||
0 | An integer amount in cents that is the starting account balance for your customer. A negative amount represents a credit that will be used before attempting any charges to the customer’s card; a positive amount will be added to the next invoice. | int | */* | ||
Optional. If you provide a coupon code, the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount. | String | */* | UTF-8 | ||
Optional. An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. | String | */* | UTF-8 | ||
Optional. Customer’s email address. | String | */* | UTF-8 | ||
Optional. A token for a given source | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format. | Map<String, Object> |
Return Type | Description |
---|---|
Customer | Customer updated |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Update an invoice
<stripe:create-invoice config-ref="" customerId="#[map-payload:customerId]" applicationFee="#[map-payload:applicationFee]" description="#[map-payload:description]" statementDescriptor="#[map-payload:statementDescriptor]" subscription="#[map-payload:subscription]" taxPercent="#[map-payoad:taxPercent]"> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:create-invoice>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The invoice to update | String | */* | UTF-8 | ||
0 | A fee in cents that will be applied to the invoice and transferred to the application owner’s Stripe account. | int | */* | ||
false | Boolean representing whether an invoice is closed or not. To close an invoice, pass true. | boolean | */* | ||
Optional. The invoice description | String | */* | UTF-8 | ||
false | Boolean representing whether an invoice is forgiven or not. To forgive an invoice, pass true. Forgiving an invoice instructs us to update the subscription status as if the invoice were succcessfully paid. Once an invoice has been forgiven, it cannot be unforgiven or reopened. | boolean | */* | ||
Optional. Extra information about a charge for the customer’s credit card statement. | String | */* | UTF-8 | ||
0.0 | The percent tax rate applied to the invoice, represented as a decimal number. | double | */* |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | Arbitrary key-value pairs to attach to the invoice | Map<String, Object> |
Return Type | Description |
---|---|
Invoice | Returns the invoice object |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Update a Plan
<stripe:update-plan config-ref="" id="#[map-payload:id]" planName="#[map-payload:planName]" statementDescriptor="#[map-payload:statementDescriptor]" > <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:update-plan>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
Of the plan to update | String | */* | UTF-8 | ||
Optional. Name of the plan, to be displayed on invoices and in the web interface. | String | */* | UTF-8 | ||
Optional. An arbitrary string to be displayed on your customer's credit card statement. This may be up to22 characters. | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a plan object. It can be useful for storing additional information about the plan in a structured format. | Map<String, Object> |
Return Type | Description |
---|---|
Plan | Plan the updated Plan |
Payload Class | Description |
---|---|
StripeConnectorException | when there is an issue updating a Plan |
Update a Refund Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request only accepts metadata as an argument.
<stripe:update-refund config-ref="" id="#[map-payload:id]" chargeId="#[map-payload:chargeId]"> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:update-refund>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
The identifier of the refund | String | */* | UTF-8 | ||
The identifier of the Charge refunded. | String | */* | UTF-8 |
Name | Default Value | Description | Java Type |
---|---|---|---|
#[payload] | A set of key/value pairs that you can attach to a refund object. It can be useful for storing additional information about the refund in a structured format. | Map<String, Object> |
Return Type | Description |
---|---|
Refund | Returns the updated refund. |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |
Update a Subscription Note that Stripe uses a specific policy around prorating changed subscriptions. If you want to use this endpoint, consider the documentation at https://stripe.com/docs/api/java#update_subscription closely.
<stripe:update-subscription config-ref="" > <stripe:update-subscription-parameters ref="#[map-payload:updateSubscriptionParameters]"/> <stripe:metadata ref="#[map-payload:metadata]"/> </stripe:update-subscription>
Name | Default Value | Description | Java Type | MIME Type | Encoding |
---|---|---|---|---|---|
Optional. Specify which configuration to use. | |||||
#[payload] | Wrapper for the complex Update Subscription Parameters | UpdateSubscriptionParameters | */* |
Return Type | Description |
---|---|
Subscription | Returns the updated Subscription |
Payload Class | Description |
---|---|
StripeConnectorException | when there is a problem with the Connector |