Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For more information on the endpoints and options see Braintree references at https://developers.braintreepayments.com/reference/overview

 

Endpoint prefix addOn

The following endpoints can be invoked with the prefix addOn as follows:

 

braintree://addOn/endpoint
Endpoint
Shorthand Alias
Options
Result Body Type
all  List<com.braintreegateway.Addon>

Endpoint prefix address

The following endpoints can be invoked with the prefix address as follows:

 

braintree://address/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
create customerId, requestcom.braintreegateway.Result<com.braintreegateway.Address>
delete customerId, idcom.braintreegateway.Result<com.braintreegateway.Address> 
find customerId, idcom.braintreegateway.Address
update customerId, id, requestcom.braintreegateway.Result<com.braintreegateway.Address> 
URI Options for address
Name
Type
customerIdString
requestcom.braintreegateway.AddressRequest
idString

Endpoint prefix clientToken

The following endpoints can be invoked with the prefix clientToken as follows:

 

braintree://clientToken/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
generate  requestString
URI Options for clientToken
Name
Type
requestcom.braintreegateway.ClientTokenrequest

Endpoint prefix creditCardVerification

The following endpoints can be invoked with the prefix creditCardverification as follows:

 

braintree://creditCardVerification/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
find  idcom.braintreegateway.CreditCardVerification
search querycom.braintreegateway.ResourceCollection<com.braintreegateway.CreditCardVerification>
URI Options for creditCardVerification
Name
Type
idString
querycom.braintreegateway.CreditCardVerificationSearchRequest

Endpoint prefix customer

The following endpoints can be invoked with the prefix customer as follows:

 

braintree://customer/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
all   
create requestcom.braintreegateway.Result<com.braintreegateway.Customer>
delete idcom.braintreegateway.Result<com.braintreegateway.Customer>
find idcom.braintreegateway.Customer
search querycom.braintreegateway.ResourceCollection<com.braintreegateway.Customer>
update id, requestcom.braintreegateway.Result<com.braintreegateway.Customer>
URI Options for customer
Name
Type
idString
requestcom.braintreegateway.CustomerRequest
querycom.braintreegateway.CustomerSearchRequest

Endpoint prefix discount

The following endpoints can be invoked with the prefix discount as follows:

 

braintree://discount/endpoint
Endpoint
Shorthand Alias
Options
Result Body Type
all  List<com.braintreegateway.Discount>


Endpoint prefix merchantAccount

The following endpoints can be invoked with the prefix merchantAccount as follows:

 

braintree://merchantAccount/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
create requestcom.braintreegateway.Result<com.braintreegateway.MerchantAccount>
find idcom.braintreegateway.MerchantAccount
update id, requestcom.braintreegateway.Result<com.braintreegateway.MerchantAccount>
URI Options for merchantAccount
Name
Type
idString
requestcom.braintreegateway.MerchantAccountRequest

Endpoint prefix paymentMethod

The following endpoints can be invoked with the prefix paymentMethod as follows:

 

braintree://paymentMethod/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
create requestcom.braintreegateway.Result<com.braintreegateway.PaymentMethod>
delete tokencom.braintreegateway.Result<com.braintreegateway.PaymentMethod>
find tokencom.braintreegateway.PaymentMethod
update token, requestcom.braintreegateway.Result<com.braintreegateway.PaymentMethod>
URI Options for paymentMethod
Name
Type
tokenString
requestcom.braintreegateway.PaymentMethodRequest

Endpoint prefix paymentMethodNonce

The following endpoints can be invoked with the prefix paymentMethodNonce as follows:

 

braintree://paymentMethodNonce/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
create paymentMethodTokencom.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce>
find paymentMethodNoncecom.braintreegateway.PaymentMethodNonce
URI Options for paymentMethodNonce
Name
Type
paymentMethodTokenString
paymentMethodNonceString

Endpoint prefix plan

The following endpoints can be invoked with the prefix plan as follows:

 

braintree://plan/endpoint
Endpoint
Shorthand Alias
Options
Result Body Type
all  List<com.braintreegateway.Plan>

 

Endpoint prefix settlementBatchSummary

The following endpoints can be invoked with the prefix settlementBatchSummary as follows:

 

braintree://settlementBatchSummary/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
generate  requestcom.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary>
URI Options for settlementBatchSummary
Name
Type
settlementDateCalendar
groupByCustomFieldString

Endpoint prefix subscription

The following endpoints can be invoked with the prefix subscription as follows:

 

braintree://subscription/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
cancel  id com.braintreegateway.Result<com.braintreegateway.Subscription>
create requestcom.braintreegateway.Result<com.braintreegateway.Subscription>
delete customerId, idcom.braintreegateway.Result<com.braintreegateway.Subscription>
find idcom.braintreegateway.Subscription
retryCharge subscriptionId, amountcom.braintreegateway.Result<com.braintreegateway.Transaction>
search searchRequestcom.braintreegateway.ResourceCollection<com.braintreegateway.Subscription>
update id, requestcom.braintreegateway.Result<com.braintreegateway.Subscription>
URI Options for subscription
Name
Type
idString
requestcom.braintreegateway.SubscriptionRequest
customerIdString
subscriptionIdString
amountBigDecimal
searchRequestcom.braintreegateway.SubscriptionSearchRequest.

 

Endpoint prefix transaction

The following endpoints can be invoked with the prefix transaction as follows:

 

braintree://transaction/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
cancelRelease idcom.braintreegateway.Result<com.braintreegateway.Transaction>
cloneTransaction id, cloneRequestcom.braintreegateway.Result<com.braintreegateway.Transaction>
credit requestcom.braintreegateway.Result<com.braintreegateway.Transaction>
find idcom.braintreegateway.Transaction
holdInEscrow idcom.braintreegateway.Result<com.braintreegateway.Transaction>
releaseFromEscrow idcom.braintreegateway.Result<com.braintreegateway.Transaction>
refund id, amountcom.braintreegateway.Result<com.braintreegateway.Transaction>
sale requestcom.braintreegateway.Result<com.braintreegateway.Transaction>
search querycom.braintreegateway.ResourceCollection<com.braintreegateway.Transaction>
submitForPartialSettlement id, amountcom.braintreegateway.Result<com.braintreegateway.Transaction>
submitForSettlement id, amount, requestcom.braintreegateway.Result<com.braintreegateway.Transaction>
voidTransaction idcom.braintreegateway.Result<com.braintreegateway.Transaction>
URI Options for transaction
Name
Type
idString
requestcom.braintreegateway.TransactionCloneRequest
cloneRequestcom.braintreegateway.TransactionCloneRequest
amountBigDecimal
querycom.braintreegateway.TransactionSearchRequest

Endpoint prefix webhookNotification

The following endpoints can be invoked with the prefix webhookNotification as follows:

 

braintree://webhookNotification/endpoint?[options]
Endpoint
Shorthand Alias
Options
Result Body Type
parse  signature, payloadcom.braintreegateway.WebhookNotification
verify challengeString
URI Options for webhookNotification
Name
Type
signatureString
payloadString
challengeString

 

Consumer Endpoints

Any of the producer endpoints can be used as a consumer endpoint. Consumer endpoints can use Scheduled Poll Consumer Options with a consumer. prefix to schedule endpoint invocation. By default Consumer endpoints that return an array or collection will generate one exchange per element, and their routes will be executed once for each exchange. To change this behavior use the property consumer.splitResults=true to return a single exchange for the entire list or array. 

Message Headers

Any URI option can be provided in a message header for producer endpoints with a CamelBraintree. prefix.

Message body

All result message bodies utilize objects provided by the Braintree Java SDK. Producer endpoints can specify the option name for incoming message body in the inBody endpoint parameter.

Use cases

Code Block
languagexml
titleBlueprint
<?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 http://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>