Braintree
Since Camel 2.17
Only producer is supported
The Braintree component provides access to Braintree Payments trough through theirs Java SDK.
All client applications need API credential in order to process payments. In order to use camel-braintree with your account, you’ll need to create a new Sandbox or Production account.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-braintree</artifactId>
<version>${camel-version}</version>
</dependency>Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
Configuring Component Options
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.
A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
Component Options
The Braintree component supports 3 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean | |
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean | |
Component configuration. | BraintreeConfiguration |
Endpoint Options
The Braintree endpoint is configured using URI syntax:
braintree:apiName/methodName
with the following path and query parameters:
Path Parameters (2 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
Required What kind of operation to perform. Enum values:
| BraintreeApiName | ||
Required What sub operation to use for the selected operation. Enum values:
| String |
Query Parameters (13 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
The environment Either SANDBOX or PRODUCTION. | String | ||
Sets the name of a parameter to be passed in the exchange In Body. | String | ||
The merchant id provided by Braintree. | String | ||
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean | |
Set read timeout for http calls. | Integer | ||
Set logging level for http calls, see java.util.logging.Level. Enum values:
| String | ||
Set log category to use to log http calls. | Braintree | String | |
Sets whether to enable the BraintreeLogHandler. It may be desirable to set this to 'false' where an existing JUL - SLF4J logger bridge is on the classpath. This option can also be configured globally on the BraintreeComponent. | true | boolean | |
The proxy host. | String | ||
The proxy port. | Integer | ||
The access token granted by a merchant to another in order to process transactions on their behalf. Used in place of environment, merchant id, public key and private key fields. | String | ||
The private key provided by Braintree. | String | ||
The public key provided by Braintree. | String |
API Parameters (17 APIs)
The Braintree endpoint is an API based component and has additional parameters based on which API name and API method is used. The API name and API method is located in the endpoint URI as the apiName/methodName path parameters:
braintree:apiName/methodName
There are 17 API names as listed in the table below:
| API Name | Type | Description |
|---|---|---|
Producer | Provides methods to create, delete, find, and update Address objects | |
Producer | Generates client tokens, which are used to authenticate requests made directly on behalf of merchants This class does not need to be instantiated directly | |
Producer | To verify credit card information | |
Producer | Provides methods to create, delete, find, and update Customer objects | |
Producer | Provides methods to interact with Dispute objects | |
Producer | API to upload evidence documents | |
Producer | Provides methods to create, find, and update MerchantAccount objects | |
Producer | ||
Producer | Provides methods to interact with payments | |
Producer | Provides methods to interact with nonce payments | |
Producer | ||
Producer | Provides methods to interact with reports | |
Producer | Provides methods to interact wit settlement summaries | |
Producer | Provides methods to interact with Subscriptions | |
Producer | Provides methods to interact with Transactions | |
Producer | ||
Producer | To retrieve notifications via webhooks |
Each API is documented in the following sections to come.
API: address
Only producer is supported
The address API is defined in the syntax as follows:
braintree:address/methodName?[parameters]The 4 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Creates an Address for a Customer | ||
Deletes a Customer’s Address | ||
Finds a Customer’s Address | ||
Updates a Customer’s Address |
Method create
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Address> create(String customerId, com.braintreegateway.AddressRequest request);
The braintree/create API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
customerId | The id of the Customer | String |
request | The request object | AddressRequest |
Method delete
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Address> delete(String customerId, String id);
The braintree/delete API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
customerId | The id of the Customer | String |
id | The id of the Address to delete | String |
Method find
Signatures:
-
com.braintreegateway.Address find(String customerId, String id);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
customerId | The id of the Customer | String |
id | The id of the Address | String |
Method update
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Address> update(String customerId, String id, com.braintreegateway.AddressRequest request);
The braintree/update API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
customerId | The id of the Customer | String |
id | The id of the Address | String |
request | The request object containing the AddressRequest parameters | AddressRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: clientToken
Only producer is supported
The clientToken API is defined in the syntax as follows:
braintree:clientToken/methodName?[parameters]The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Method generate
Signatures:
-
String generate();
-
String generate(com.braintreegateway.ClientTokenRequest request);
The braintree/generate API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | ClientTokenRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: creditCardVerification
Only producer is supported
The creditCardVerification API is defined in the syntax as follows:
braintree:creditCardVerification/methodName?[parameters]The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method create
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.CreditCardVerification> create(com.braintreegateway.CreditCardVerificationRequest request);
The braintree/create API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | CreditCardVerificationRequest |
Method find
Signatures:
-
com.braintreegateway.CreditCardVerification find(String id);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | String |
Method search
Signatures:
-
com.braintreegateway.ResourceCollection<com.braintreegateway.CreditCardVerification> search(com.braintreegateway.CreditCardVerificationSearchRequest query);
The braintree/search API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
query | CreditCardVerificationSearchRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: customer
Only producer is supported
The customer API is defined in the syntax as follows:
braintree:customer/methodName?[parameters]The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Creates a Customer | ||
Deletes a Customer by id | ||
Finds a Customer by id | ||
Finds all Transactions that match the query and returns a ResourceCollection | ||
Updates a Customer |
Method create
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Customer> create(com.braintreegateway.CustomerRequest request);
The braintree/create API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | The request | CustomerRequest |
Method delete
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Customer> delete(String id);
The braintree/delete API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | The id of the Customer | String |
Method find
Signatures:
-
com.braintreegateway.Customer find(String id);
-
com.braintreegateway.Customer find(String id, String associationFilterId);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
associationFilterId | The id of the association filter to use | String |
id | The id of the Customer | String |
Method search
Signatures:
-
com.braintreegateway.ResourceCollection<com.braintreegateway.Customer> search(com.braintreegateway.CustomerSearchRequest query);
The braintree/search API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
query | The request query to use for search | CustomerSearchRequest |
Method update
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Customer> update(String id, com.braintreegateway.CustomerRequest request);
The braintree/update API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | The id of the Customer | String |
request | The request | CustomerRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: dispute
Only producer is supported
The dispute API is defined in the syntax as follows:
braintree:dispute/methodName?[parameters]The 7 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Accept a Dispute, given a dispute ID | ||
Add File Evidence to a Dispute, given an ID and a FileEvidenceRequest File evidence request | ||
Add Text Evidence to a Dispute, given an ID and content | ||
Finalize a Dispute, given an ID | ||
Returns a Dispute, given an ID | ||
Remove Evidence from a Dispute, given an ID and a DisputeEvidence ID | ||
Finds all Disputes that match the query |
Method accept
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Dispute> accept(String id);
The braintree/accept API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | The dispute id to accept | String |
Method addFileEvidence
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addFileEvidence(String disputeId, String documentId);
-
com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addFileEvidence(String disputeId, com.braintreegateway.FileEvidenceRequest fileEvidenceRequest);
The braintree/addFileEvidence API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
disputeId | The dispute id to add text evidence to | String |
documentId | The document id of a previously uploaded document | String |
fileEvidenceRequest | The file evidence request for the dispute | FileEvidenceRequest |
Method addTextEvidence
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addTextEvidence(String id, String content);
-
com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addTextEvidence(String id, com.braintreegateway.TextEvidenceRequest textEvidenceRequest);
The braintree/addTextEvidence API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
content | The content of the text evidence for the dispute | String |
id | The dispute id to add text evidence to | String |
textEvidenceRequest | The text evidence request for the dispute | TextEvidenceRequest |
Method finalize
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Dispute> finalize(String id);
The braintree/finalize API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | The dispute id to finalize | String |
Method find
Signatures:
-
com.braintreegateway.Dispute find(String id);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | The dispute id to find | String |
Method removeEvidence
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Dispute> removeEvidence(String disputeId, String evidenceId);
The braintree/removeEvidence API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
disputeId | The dispute id to remove evidence from | String |
evidenceId | The evidence id to remove | String |
Method search
Signatures:
-
com.braintreegateway.PaginatedCollection<com.braintreegateway.Dispute> search(com.braintreegateway.DisputeSearchRequest query);
The braintree/search API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
query | The query for what disputes to find | DisputeSearchRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: documentUpload
Only producer is supported
The documentUpload API is defined in the syntax as follows:
braintree:documentUpload/methodName?[parameters]The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Method create
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.DocumentUpload> create(com.braintreegateway.DocumentUploadRequest request);
The braintree/create API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | DocumentUploadRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: merchantAccount
Only producer is supported
The merchantAccount API is defined in the syntax as follows:
braintree:merchantAccount/methodName?[parameters]The 5 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Method create
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.MerchantAccount> create(com.braintreegateway.MerchantAccountRequest request);
The braintree/create API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | MerchantAccountRequest |
Method createForCurrency
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.MerchantAccount> createForCurrency(com.braintreegateway.MerchantAccountCreateForCurrencyRequest request);
The braintree/createForCurrency API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
currencyRequest | MerchantAccountCreateForCurrencyRequest |
Method fetchMerchantAccounts
Signatures:
-
com.braintreegateway.PaginatedResult<com.braintreegateway.MerchantAccount> fetchMerchantAccounts(int page);
The braintree/fetchMerchantAccounts API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
page | Integer |
Method find
Signatures:
-
com.braintreegateway.MerchantAccount find(String id);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | String |
Method update
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.MerchantAccount> update(String id, com.braintreegateway.MerchantAccountRequest request);
The braintree/update API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | String | |
request | MerchantAccountRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: oauth
Only producer is supported
The oauth API is defined in the syntax as follows:
braintree:oauth/methodName?[parameters]The 4 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Method connectUrl
Signatures:
-
String connectUrl(com.braintreegateway.OAuthConnectUrlRequest request);
The braintree/connectUrl API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
connectRequest | OAuthConnectUrlRequest |
Method createTokenFromCode
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.OAuthCredentials> createTokenFromCode(com.braintreegateway.OAuthCredentialsRequest request);
The braintree/createTokenFromCode API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | OAuthCredentialsRequest |
Method createTokenFromRefreshToken
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.OAuthCredentials> createTokenFromRefreshToken(com.braintreegateway.OAuthCredentialsRequest request);
The braintree/createTokenFromRefreshToken API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | OAuthCredentialsRequest |
Method revokeAccessToken
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.OAuthResult> revokeAccessToken(String accessToken);
The braintree/revokeAccessToken API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
accessToken | String |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: paymentMethod
Only producer is supported
The paymentMethod API is defined in the syntax as follows:
braintree:paymentMethod/methodName?[parameters]The 6 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method create
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> create(com.braintreegateway.PaymentMethodRequest request);
The braintree/create API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | PaymentMethodRequest |
Method delete
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token);
-
com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token, com.braintreegateway.PaymentMethodDeleteRequest request);
The braintree/delete API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
deleteRequest | PaymentMethodDeleteRequest | |
token | String |
Method find
Signatures:
-
com.braintreegateway.PaymentMethod find(String token);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
token | String |
Method grant
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> grant(String token);
-
com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> grant(String token, com.braintreegateway.PaymentMethodGrantRequest grantRequest);
The braintree/grant API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
grantRequest | PaymentMethodGrantRequest | |
token | String |
Method revoke
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> revoke(String token);
The braintree/revoke API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
token | String |
Method update
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> update(String token, com.braintreegateway.PaymentMethodRequest request);
The braintree/update API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | PaymentMethodRequest | |
token | String |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: paymentMethodNonce
Only producer is supported
The paymentMethodNonce API is defined in the syntax as follows:
braintree:paymentMethodNonce/methodName?[parameters]The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method create
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(String paymentMethodToken);
-
com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(com.braintreegateway.PaymentMethodNonceRequest request);
The braintree/create API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
paymentMethodToken | String | |
request | PaymentMethodNonceRequest |
Method find
Signatures:
-
com.braintreegateway.PaymentMethodNonce find(String paymentMethodNonce);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
paymentMethodNonce | String |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: plan
Only producer is supported
The plan API is defined in the syntax as follows:
braintree:plan/methodName?[parameters]The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method create
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Plan> create(com.braintreegateway.PlanRequest request);
The braintree/create API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | PlanRequest |
Method find
Signatures:
-
com.braintreegateway.Plan find(String id);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | String |
Method update
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Plan> update(String id, com.braintreegateway.PlanRequest request);
The braintree/update API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | String | |
request | PlanRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: report
Only producer is supported
The report API is defined in the syntax as follows:
braintree:report/methodName?[parameters]The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Retrieves a Transaction-Level Fee Report |
Method transactionLevelFees
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.TransactionLevelFeeReport> transactionLevelFees(com.braintreegateway.TransactionLevelFeeReportRequest request);
The braintree/transactionLevelFees API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | The request | TransactionLevelFeeReportRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: settlementBatchSummary
Only producer is supported
The settlementBatchSummary API is defined in the syntax as follows:
braintree:settlementBatchSummary/methodName?[parameters]The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Method generate
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate);
-
com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate, String groupByCustomField);
The braintree/generate API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
groupByCustomField | String | |
settlementDate | Calendar |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: subscription
Only producer is supported
The subscription API is defined in the syntax as follows:
braintree:subscription/methodName?[parameters]The 7 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Cancels the Subscription with the given id | ||
Creates a Subscription | ||
Finds a Subscription by id | ||
Search for a Subscription | ||
Updates a Subscription |
Method cancel
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Subscription> cancel(String id);
The braintree/cancel API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | Of the Subscription to cancel | String |
Method create
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Subscription> create(com.braintreegateway.SubscriptionRequest request);
The braintree/create API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | The request | SubscriptionRequest |
Method delete
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Subscription> delete(String customerId, String id);
The braintree/delete API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
customerId | String | |
id | String |
Method find
Signatures:
-
com.braintreegateway.Subscription find(String id);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | The id of the Subscription | String |
Method retryCharge
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId);
-
com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId, Boolean submitForSettlement);
-
com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId, java.math.BigDecimal amount);
-
com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId, java.math.BigDecimal amount, Boolean submitForSettlement);
The braintree/retryCharge API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
amount | BigDecimal | |
submitForSettlement | Boolean | |
subscriptionId | String |
Method search
Signatures:
-
com.braintreegateway.ResourceCollection<com.braintreegateway.Subscription> search(com.braintreegateway.SubscriptionSearchRequest searchRequest);
The braintree/search API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
searchRequest | The SubscriptionSearchRequest | SubscriptionSearchRequest |
Method update
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Subscription> update(String id, com.braintreegateway.SubscriptionRequest request);
The braintree/update API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | The id of the Subscription | String |
request | The request | SubscriptionRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: transaction
Only producer is supported
The transaction API is defined in the syntax as follows:
braintree:transaction/methodName?[parameters]The 15 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Submits the transaction with the given id to be adjusted for the given amount which must be less than or equal to the authorization amount | ||
Cancels a pending release of a transaction with the given id from escrow | ||
Creates a credit Transaction | ||
Finds a Transaction by id | ||
Holds the transaction with the given id for escrow | ||
Refunds all or part of a previous sale Transaction | ||
Submits the transaction with the given id for release | ||
Creates a sale Transaction | ||
Finds all Transactions that match the query and returns a ResourceCollection | ||
Submits a partial settlement transaction for the given id | ||
Submits the transaction with the given id to be settled along with a TransactionRequest object | ||
Updates custom field values for a given transaction | ||
Updates details for a transaction that has been submitted for settlement | ||
Voids the transaction with the given id |
Method adjustAuthorization
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> adjustAuthorization(String id, com.braintreegateway.TransactionRequest request);
-
com.braintreegateway.Result<com.braintreegateway.Transaction> adjustAuthorization(String id, java.math.BigDecimal amount);
The braintree/adjustAuthorization API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
amount | To be adjusted | BigDecimal |
id | Of the transaction to to be adjusted | String |
request | Is the TransactionRequest object with amount details | TransactionRequest |
Method cancelRelease
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> cancelRelease(String id);
The braintree/cancelRelease API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | Of the transaction to cancel release from escrow of | String |
Method cloneTransaction
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> cloneTransaction(String id, com.braintreegateway.TransactionCloneRequest request);
The braintree/cloneTransaction API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
cloneRequest | TransactionCloneRequest | |
id | String |
Method credit
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> credit(com.braintreegateway.TransactionRequest request);
The braintree/credit API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | The request | TransactionRequest |
Method find
Signatures:
-
com.braintreegateway.Transaction find(String id);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | The id of the Transaction | String |
Method holdInEscrow
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> holdInEscrow(String id);
The braintree/holdInEscrow API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | Of the transaction to hold for escrow | String |
Method refund
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> refund(String id);
-
com.braintreegateway.Result<com.braintreegateway.Transaction> refund(String id, com.braintreegateway.TransactionRefundRequest request);
-
com.braintreegateway.Result<com.braintreegateway.Transaction> refund(String id, java.math.BigDecimal amount);
The braintree/refund API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
amount | BigDecimal | |
id | String | |
refundRequest | TransactionRefundRequest |
Method releaseFromEscrow
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> releaseFromEscrow(String id);
The braintree/releaseFromEscrow API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | Of the transaction to submit for release | String |
Method sale
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> sale(com.braintreegateway.TransactionRequest request);
The braintree/sale API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
request | The request | TransactionRequest |
Method search
Signatures:
-
com.braintreegateway.ResourceCollection<com.braintreegateway.Transaction> search(com.braintreegateway.TransactionSearchRequest query);
The braintree/search API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
query | The search query | TransactionSearchRequest |
Method submitForPartialSettlement
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> submitForPartialSettlement(String id, com.braintreegateway.TransactionRequest request);
-
com.braintreegateway.Result<com.braintreegateway.Transaction> submitForPartialSettlement(String id, java.math.BigDecimal amount);
The braintree/submitForPartialSettlement API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
amount | Of the partial settlement | BigDecimal |
id | Of the transaction to add the partial settlement transaction for | String |
request | The request | TransactionRequest |
Method submitForSettlement
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> submitForSettlement(String id);
-
com.braintreegateway.Result<com.braintreegateway.Transaction> submitForSettlement(String id, com.braintreegateway.TransactionRequest request);
-
com.braintreegateway.Result<com.braintreegateway.Transaction> submitForSettlement(String id, java.math.BigDecimal amount);
The braintree/submitForSettlement API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
amount | To settle. must be less than or equal to the authorization amount. | BigDecimal |
id | Of the transaction to submit for settlement | String |
request | The request | TransactionRequest |
Method updateCustomFields
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> updateCustomFields(String id, com.braintreegateway.TransactionRequest request);
The braintree/updateCustomFields API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | Of the transaction being updated | String |
request | A TransactionRequest object containing custom field info.. | TransactionRequest |
Method updateDetails
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> updateDetails(String id, com.braintreegateway.TransactionRequest request);
The braintree/updateDetails API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | Of the transaction to update the details for | String |
request | The request | TransactionRequest |
Method voidTransaction
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> voidTransaction(String id);
The braintree/voidTransaction API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
id | Of the transaction to void | String |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: usBankAccount
Only producer is supported
The usBankAccount API is defined in the syntax as follows:
braintree:usBankAccount/methodName?[parameters]The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
Method find
Signatures:
-
com.braintreegateway.UsBankAccount find(String token);
The braintree/find API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
token | String |
Method sale
Signatures:
-
com.braintreegateway.Result<com.braintreegateway.Transaction> sale(String token, com.braintreegateway.TransactionRequest transactionRequest);
The braintree/sale API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
token | String | |
transactionRequest | TransactionRequest |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
API: webhookNotification
Only producer is supported
The webhookNotification API is defined in the syntax as follows:
braintree:webhookNotification/methodName?[parameters]The 3 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)
| Method | Alias | Description |
|---|---|---|
Method parse
Signatures:
-
com.braintreegateway.WebhookNotification parse(String signature, String payload);
The braintree/parse API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
payload | String | |
signature | String |
Method parseWithoutSignatureVerification
Signatures:
-
com.braintreegateway.WebhookNotification parseWithoutSignatureVerification(String payload);
The braintree/parseWithoutSignatureVerification API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
payload | String |
Method verify
Signatures:
-
String verify(String challenge);
The braintree/verify API method has the parameters listed in the table below:
| Parameter | Description | Type |
|---|---|---|
challenge | String |
In addition to the parameters above, the braintree API can also use any of the Query Parameters (13 parameters).
Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelBraintree.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelBraintree.myParameterNameHere header.
Examples
OSGi Blueprint
<?xml version="1.0"?>
<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:cm="http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0"
xsi:schemaLocation="
http://aries.apache.org/blueprint/xmlns/blueprint-cm/v1.0.0 http://aries.apache.org/schemas/blueprint-cm/blueprint-cm-1.0.0.xsd
http://www.osgi.org/xmlns/blueprint/v1.0.0 https://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd
http://camel.apache.org/schema/blueprint http://camel.apache.org/schema/blueprint/camel-blueprint.xsd">
<cm:property-placeholder id="placeholder" persistent-id="camel.braintree">
</cm:property-placeholder>
<bean id="braintree" class="org.apache.camel.component.braintree.BraintreeComponent">
<property name="configuration">
<bean class="org.apache.camel.component.braintree.BraintreeConfiguration">
<property name="environment" value="${environment}"/>
<property name="merchantId" value="${merchantId}"/>
<property name="publicKey" value="${publicKey}"/>
<property name="privateKey" value="${privateKey}"/>
</bean>
</property>
</bean>
<camelContext trace="true" xmlns="http://camel.apache.org/schema/blueprint" id="braintree-example-context">
<route id="braintree-example-route">
<from uri="direct:generateClientToken"/>
<to uri="braintree://clientToken/generate"/>
<to uri="stream:out"/>
</route>
</camelContext>
</blueprint>More Information
For more information on the endpoints and options see Braintree references at https://developers.braintreepayments.com/reference/overview
Spring Boot Auto-Configuration
When using braintree with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-braintree-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 4 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean | |
Component configuration. The option is a org.apache.camel.component.braintree.BraintreeConfiguration type. | BraintreeConfiguration | ||
Whether to enable auto configuration of the braintree component. This is enabled by default. | Boolean | ||
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | Boolean |