Package com.braintreegateway

Class BraintreeGateway

java.lang.Object

com.braintreegateway.BraintreeGateway

public class BraintreeGateway
extends Object

This is the primary interface to the Braintree Gateway. It is used to interact with:

• Addresses
• CreditCards
• Customers
• Subscriptions
• Transactions

Quick Start Example:

 import java.math.BigDecimal;
 import com.braintreegateway.*;

 public class BraintreeExample {

     public static void main(String[] args) {
         BraintreeGateway gateway = new BraintreeGateway(Environment.SANDBOX, "the_merchant_id", "the_public_key", "the_private_key");

         TransactionRequest request = new TransactionRequest().amount(new BigDecimal("100.00")).creditCard().number("4111111111111111").expirationDate("05/2012").done();

         Transaction transaction = gateway.transaction().sale(request).getTarget();
         System.out.println("Transaction ID: " + transaction.getId());
         System.out.println("Status: " + transaction.getStatus());
     }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	configuration
GraphQLClient	graphQLClient
private Http	http

Constructor Summary

Constructors

Constructor	Description
BraintreeGateway(Environment environment, String merchantId, String publicKey, String privateKey)	Instantiates a BraintreeGateway.
BraintreeGateway(String accessToken)
BraintreeGateway(String clientId, String clientSecret)
BraintreeGateway(String environment, String merchantId, String publicKey, String privateKey)

Method Summary

Modifier and Type	Method	Description
AddOnGateway	addOn()	Returns an AddOnGateway for interacting with AddOn objects.
AddressGateway	address()	Returns an AddressGateway for interacting with Address objects.
ClientTokenGateway	clientToken()
CreditCardGateway	creditCard()	Returns an CreditCardGateway for interacting with CreditCard objects.
CreditCardVerificationGateway	creditCardVerification()
CustomerGateway	customer()	Returns an CustomerGateway for interacting with Customer objects.
DiscountGateway	discount()	Returns an DiscountGateway for interacting with Discount objects.
DisputeGateway	dispute()	Returns a DisputeGateway for interacting with Dispute objects.
DocumentUploadGateway	documentUpload()
ExchangeRateQuoteGateway	exchangeRateQuote()
static BraintreeGateway	forPartner(Environment environment, String partnerId, String publicKey, String privateKey)	Returns a BraintreeGateway specifically for Partner usage.
Configuration	getConfiguration()
MerchantGateway	merchant()
MerchantAccountGateway	merchantAccount()	Returns an MerchantAccountGateway for interacting with MerchantAccount objects.
OAuthGateway	oauth()
PaymentMethodGateway	paymentMethod()
PaymentMethodNonceGateway	paymentMethodNonce()
PayPalAccountGateway	paypalAccount()
PlanGateway	plan()	Returns an PlanGateway for interacting with Plan objects.
ReportGateway	report()
SepaDirectDebitAccountGateway	sepaDirectDebitAccount()
void	setProxy(String url, Integer port)
SettlementBatchSummaryGateway	settlementBatchSummary()
SubscriptionGateway	subscription()	Returns an SubscriptionGateway for interacting with Subscription objects.
TestingGateway	testing()
ThreeDSecureGateway	threeDSecure()	Returns an ThreeDSecureGateway for interacting with 3D Secure.
TransactionGateway	transaction()	Returns an TransactionGateway for interacting with Transaction objects.
TransactionLineItemGateway	transactionLineItem()	Returns an TransactionLineItemGateway for interacting with TransactionLineItem objects.
UsBankAccountGateway	usBankAccount()
UsBankAccountVerificationGateway	usBankAccountVerification()
WebhookNotificationGateway	webhookNotification()
WebhookTestingGateway	webhookTesting()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configuration

private Configuration configuration

http

private Http http

graphQLClient

public GraphQLClient graphQLClient

Constructor Detail

BraintreeGateway

public BraintreeGateway(Environment environment,
                        String merchantId,
                        String publicKey,
                        String privateKey)

Instantiates a BraintreeGateway. Use the values provided by Braintree.

Parameters:

environment - Either Environment.SANDBOX or Environment.PRODUCTION.

merchantId - the merchant id provided by Braintree.

publicKey - the public key provided by Braintree.

privateKey - the private key provided by Braintree.

BraintreeGateway

public BraintreeGateway(String environment,
                        String merchantId,
                        String publicKey,
                        String privateKey)

BraintreeGateway

public BraintreeGateway(String clientId,
                        String clientSecret)

BraintreeGateway

public BraintreeGateway(String accessToken)

Method Detail

forPartner

public static BraintreeGateway forPartner(Environment environment,
                                          String partnerId,
                                          String publicKey,
                                          String privateKey)

Returns a BraintreeGateway specifically for Partner usage. Unless you are a partner, use the regular constructor instead.

Parameters:

environment - Either Environment.SANDBOX or Environment.PRODUCTION.

partnerId - the partner id provided by Braintree.

publicKey - the public key provided by Braintree.

privateKey - the private key provided by Braintree.

Returns:

a BraintreeGateway specifically for Partner usage

addOn

public AddOnGateway addOn()

Returns an AddOnGateway for interacting with AddOn objects.

Returns:

an AddOnGateway.

address

public AddressGateway address()

Returns an AddressGateway for interacting with Address objects.

Returns:

an AddressGateway.

clientToken

public ClientTokenGateway clientToken()

creditCard

public CreditCardGateway creditCard()

Returns an CreditCardGateway for interacting with CreditCard objects.

Returns:

an CreditCardGateway.

creditCardVerification

public CreditCardVerificationGateway creditCardVerification()

usBankAccountVerification

public UsBankAccountVerificationGateway usBankAccountVerification()

customer

public CustomerGateway customer()

Returns an CustomerGateway for interacting with Customer objects.

Returns:

an CustomerGateway.

discount

public DiscountGateway discount()

Returns an DiscountGateway for interacting with Discount objects.

Returns:

an DiscountGateway.

dispute

public DisputeGateway dispute()

Returns a DisputeGateway for interacting with Dispute objects.

Returns:

an DisputeGateway.

getConfiguration

public Configuration getConfiguration()

setProxy

public void setProxy(String url,
                     Integer port)

paymentMethod

public PaymentMethodGateway paymentMethod()

paymentMethodNonce

public PaymentMethodNonceGateway paymentMethodNonce()

paypalAccount

public PayPalAccountGateway paypalAccount()

sepaDirectDebitAccount

public SepaDirectDebitAccountGateway sepaDirectDebitAccount()

usBankAccount

public UsBankAccountGateway usBankAccount()

plan

public PlanGateway plan()

Returns an PlanGateway for interacting with Plan objects.

Returns:

an PlanGateway.

settlementBatchSummary

public SettlementBatchSummaryGateway settlementBatchSummary()

subscription

public SubscriptionGateway subscription()

Returns an SubscriptionGateway for interacting with Subscription objects.

Returns:

an SubscriptionGateway.

threeDSecure

public ThreeDSecureGateway threeDSecure()

Returns an ThreeDSecureGateway for interacting with 3D Secure.

Returns:

an ThreeDSecureGateway.

transaction

public TransactionGateway transaction()

Returns an TransactionGateway for interacting with Transaction objects.

Returns:

an TransactionGateway.

transactionLineItem

public TransactionLineItemGateway transactionLineItem()

Returns an TransactionLineItemGateway for interacting with TransactionLineItem objects.

Returns:

an TransactionLineItemGateway.

webhookNotification

public WebhookNotificationGateway webhookNotification()

webhookTesting

public WebhookTestingGateway webhookTesting()

merchantAccount

public MerchantAccountGateway merchantAccount()

Returns an MerchantAccountGateway for interacting with MerchantAccount objects.

Returns:

an MerchantAccountGateway.

merchant

public MerchantGateway merchant()

oauth

public OAuthGateway oauth()

testing

public TestingGateway testing()

documentUpload

public DocumentUploadGateway documentUpload()

report

public ReportGateway report()

exchangeRateQuote

public ExchangeRateQuoteGateway exchangeRateQuote()