java.lang.Object
- com.braintreegateway.Request
- - com.braintreegateway.TransactionRequest

```
public class TransactionRequest
extends Request
```
Provides a fluent interface to build up requests around Transactions.

Field Summary

Fields
Modifier and Type	Field	Description
`private BigDecimal`	`amount`
`private TransactionAndroidPayCardRequest`	`androidPayCardRequest`
`private TransactionApplePayCardRequest`	`applePayCardRequest`
`private String`	`billingAddressId`
`private TransactionAddressRequest`	`billingAddressRequest`
`private String`	`channel`
`private TransactionCreditCardRequest`	`creditCardRequest`
`private String`	`currencyIsoCode`
`private String`	`customerId`
`private CustomerRequest`	`customerRequest`
`private Map<String,String>`	`customFields`
`private TransactionDescriptorRequest`	`descriptorRequest`
`private String`	`deviceData`
`private String`	`deviceSessionId`
`private BigDecimal`	`discountAmount`
`private String`	`exchangeRateQuoteId`
`private ExternalVaultRequest`	`externalVaultRequest`
`private Boolean`	`finalCapture`
`private Boolean`	`foreignRetailer`
`private String`	`fraudMerchantId`
`private TransactionIndustryRequest`	`industryRequest`
`private InstallmentRequest`	`installments`
`private String`	`merchantAccountId`
`private String`	`orderId`
`private String`	`paymentMethodNonce`
`private String`	`paymentMethodToken`
`private TransactionPayPalRequest`	`paypalRequest`
`private String`	`productSku`
`private String`	`purchaseOrderNumber`
`private Boolean`	`recurring`
`private RiskDataTransactionRequest`	`riskDataTransactionRequest`
`private Transaction.ScaExemption`	`scaExemption`
`private BigDecimal`	`serviceFeeAmount`
`private String`	`sharedBillingAddressId`
`private String`	`sharedCustomerId`
`private String`	`sharedPaymentMethodNonce`
`private String`	`sharedPaymentMethodToken`
`private String`	`sharedShippingAddressId`
`private String`	`shippingAddressId`
`private TransactionAddressRequest`	`shippingAddressRequest`
`private BigDecimal`	`shippingAmount`
`private BigDecimal`	`shippingTaxAmount`
`private String`	`shipsFromPostalCode`
`private String`	`source`
`private BigDecimal`	`taxAmount`
`private Boolean`	`taxExempt`
`private String`	`threeDSecureAuthenticationId`
`private TransactionThreeDSecurePassThruRequest`	`threeDSecurePassThruRequest`
`private String`	`threeDSecureToken`
`private Boolean`	`threeDSecureTransaction`
`private List<TransactionLineItemRequest>`	`transactionLineItemRequests`
`private TransactionOptionsRequest`	`transactionOptionsRequest`
`private Transaction.Type`	`type`
`private String`	`venmoSdkPaymentMethodCode`

Constructor Summary

Constructors
Constructor Description

TransactionRequest()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`TransactionRequest`	`amount(BigDecimal amount)`
`TransactionAndroidPayCardRequest`	`androidPayCardRequest()`
`TransactionApplePayCardRequest`	`applePayCardRequest()`
`TransactionAddressRequest`	`billingAddress()`
`TransactionRequest`	`billingAddressId(String billingAddressId)`
`protected RequestBuilder`	`buildRequest(String root)`
`TransactionRequest`	`channel(String channel)`
`TransactionCreditCardRequest`	`creditCard()`
`TransactionRequest`	`currencyIsoCode(String currencyIsoCode)`
`CustomerRequest`	`customer()`
`TransactionRequest`	`customerId(String customerId)`
`TransactionRequest`	`customField(String apiName, String value)`
`TransactionDescriptorRequest`	`descriptor()`
`TransactionRequest`	`deviceData(String deviceData)`
`TransactionRequest`	`deviceSessionId(String deviceSessionId)`	Deprecated.
`TransactionRequest`	`discountAmount(BigDecimal discountAmount)`
`TransactionRequest`	`exchangeRateQuoteId(String exchangeRateQuoteId)`
`ExternalVaultRequest`	`externalVault()`
`TransactionRequest`	`finalCapture(Boolean finalCapture)`
`TransactionRequest`	`foreignRetailer(Boolean foreignRetailer)`
`TransactionRequest`	`fraudMerchantId(String fraudMerchantId)`	Deprecated.
`TransactionIndustryRequest`	`industry()`
`InstallmentRequest`	`installments()`
`TransactionLineItemRequest`	`lineItem()`
`TransactionRequest`	`merchantAccountId(String merchantAccountId)`
`TransactionOptionsRequest`	`options()`
`TransactionRequest`	`orderId(String orderId)`
`TransactionRequest`	`paymentMethodNonce(String paymentMethodNonce)`
`TransactionRequest`	`paymentMethodToken(String paymentMethodToken)`
`TransactionPayPalRequest`	`paypalAccount()`
`TransactionRequest`	`productSku(String productSku)`
`TransactionRequest`	`purchaseOrderNumber(String purchaseOrderNumber)`
`TransactionRequest`	`recurring(Boolean recurring)`	Deprecated.
`RiskDataTransactionRequest`	`riskData()`
`TransactionRequest`	`scaExemption(Transaction.ScaExemption scaExemption)`
`TransactionRequest`	`serviceFeeAmount(BigDecimal fee)`
`TransactionRequest`	`sharedBillingAddressId(String sharedBillingAddressId)`
`TransactionRequest`	`sharedCustomerId(String sharedCustomerId)`
`TransactionRequest`	`sharedPaymentMethodNonce(String sharedPaymentMethodNonce)`
`TransactionRequest`	`sharedPaymentMethodToken(String sharedPaymentMethodToken)`
`TransactionRequest`	`sharedShippingAddressId(String sharedShippingAddressId)`
`TransactionAddressRequest`	`shippingAddress()`
`TransactionRequest`	`shippingAddressId(String shippingAddressId)`
`TransactionRequest`	`shippingAmount(BigDecimal shippingAmount)`
`TransactionRequest`	`shippingTaxAmount(BigDecimal shippingTaxAmount)`
`TransactionRequest`	`shipsFromPostalCode(String shipsFromPostalCode)`
`TransactionRequest`	`taxAmount(BigDecimal taxAmount)`
`TransactionRequest`	`taxExempt(Boolean taxExempt)`
`TransactionRequest`	`threeDSecureAuthenticationId(String threeDSecureAuthenticationId)`
`TransactionThreeDSecurePassThruRequest`	`threeDSecurePassThru()`
`TransactionRequest`	`threeDSecureToken(String threeDSecureToken)`	Deprecated. use threeDSecureAuthenticationID instead
`String`	`toQueryString()`
`String`	`toQueryString(String root)`
`String`	`toXML()`
`TransactionRequest`	`transactionSource(String source)`
`TransactionRequest`	`type(Transaction.Type type)`
`TransactionRequest`	`venmoSdkPaymentMethodCode(String venmoSdkPaymentMethodCode)`	Deprecated. - The Venmo SDK integration is Unsupported.

Methods inherited from class com.braintreegateway.Request
buildXMLElement, buildXMLElement, getKind, toGraphQLVariables

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

amount
```
private BigDecimal amount
```

androidPayCardRequest

private TransactionAndroidPayCardRequest androidPayCardRequest

applePayCardRequest

private TransactionApplePayCardRequest applePayCardRequest

billingAddressId
```
private String billingAddressId
```

billingAddressRequest

private TransactionAddressRequest billingAddressRequest

channel
```
private String channel
```

creditCardRequest

private TransactionCreditCardRequest creditCardRequest

currencyIsoCode
```
private String currencyIsoCode
```

customerId
```
private String customerId
```

customerRequest

private CustomerRequest customerRequest

customFields

private Map<String,String> customFields

descriptorRequest

private TransactionDescriptorRequest descriptorRequest

deviceData
```
private String deviceData
```

deviceSessionId
```
private String deviceSessionId
```

discountAmount
```
private BigDecimal discountAmount
```

exchangeRateQuoteId
```
private String exchangeRateQuoteId
```

externalVaultRequest

private ExternalVaultRequest externalVaultRequest

finalCapture
```
private Boolean finalCapture
```

foreignRetailer
```
private Boolean foreignRetailer
```

fraudMerchantId
```
private String fraudMerchantId
```

industryRequest

private TransactionIndustryRequest industryRequest

installments

private InstallmentRequest installments

merchantAccountId
```
private String merchantAccountId
```

orderId
```
private String orderId
```

paymentMethodNonce
```
private String paymentMethodNonce
```

paymentMethodToken
```
private String paymentMethodToken
```

paypalRequest

private TransactionPayPalRequest paypalRequest

productSku
```
private String productSku
```

purchaseOrderNumber
```
private String purchaseOrderNumber
```

recurring
```
private Boolean recurring
```

riskDataTransactionRequest

private RiskDataTransactionRequest riskDataTransactionRequest

scaExemption

private Transaction.ScaExemption scaExemption

serviceFeeAmount
```
private BigDecimal serviceFeeAmount
```

sharedBillingAddressId
```
private String sharedBillingAddressId
```

sharedCustomerId
```
private String sharedCustomerId
```

sharedPaymentMethodNonce

private String sharedPaymentMethodNonce

sharedPaymentMethodToken

private String sharedPaymentMethodToken

sharedShippingAddressId
```
private String sharedShippingAddressId
```

shippingAddressId
```
private String shippingAddressId
```

shippingAddressRequest

private TransactionAddressRequest shippingAddressRequest

shippingAmount
```
private BigDecimal shippingAmount
```

shippingTaxAmount
```
private BigDecimal shippingTaxAmount
```

shipsFromPostalCode
```
private String shipsFromPostalCode
```

source
```
private String source
```

taxAmount
```
private BigDecimal taxAmount
```

taxExempt
```
private Boolean taxExempt
```

threeDSecureAuthenticationId

private String threeDSecureAuthenticationId

threeDSecurePassThruRequest

private TransactionThreeDSecurePassThruRequest threeDSecurePassThruRequest

threeDSecureToken
```
private String threeDSecureToken
```

threeDSecureTransaction

private Boolean threeDSecureTransaction

transactionLineItemRequests

private List<TransactionLineItemRequest> transactionLineItemRequests

transactionOptionsRequest

private TransactionOptionsRequest transactionOptionsRequest

type
```
private Transaction.Type type
```

venmoSdkPaymentMethodCode

private String venmoSdkPaymentMethodCode

Constructor Detail
- TransactionRequest
```
public TransactionRequest()
```

Method Detail

amount

public TransactionRequest amount(BigDecimal amount)

androidPayCardRequest

public TransactionAndroidPayCardRequest androidPayCardRequest()

applePayCardRequest

public TransactionApplePayCardRequest applePayCardRequest()

billingAddress

public TransactionAddressRequest billingAddress()

billingAddressId

public TransactionRequest billingAddressId(String billingAddressId)

channel

public TransactionRequest channel(String channel)

creditCard

public TransactionCreditCardRequest creditCard()

currencyIsoCode

public TransactionRequest currencyIsoCode(String currencyIsoCode)

customer
```
public CustomerRequest customer()
```

customerId

public TransactionRequest customerId(String customerId)

customField

public TransactionRequest customField(String apiName,
                                      String value)

descriptor

public TransactionDescriptorRequest descriptor()

deviceData

public TransactionRequest deviceData(String deviceData)

deviceSessionId

@Deprecated
public TransactionRequest deviceSessionId(String deviceSessionId)

Deprecated.

discountAmount

public TransactionRequest discountAmount(BigDecimal discountAmount)

exchangeRateQuoteId

public TransactionRequest exchangeRateQuoteId(String exchangeRateQuoteId)

externalVault

public ExternalVaultRequest externalVault()

finalCapture

public TransactionRequest finalCapture(Boolean finalCapture)

foreignRetailer

public TransactionRequest foreignRetailer(Boolean foreignRetailer)

fraudMerchantId

@Deprecated
public TransactionRequest fraudMerchantId(String fraudMerchantId)

Deprecated.

industry

public TransactionIndustryRequest industry()

installments

public InstallmentRequest installments()

lineItem

public TransactionLineItemRequest lineItem()

merchantAccountId

public TransactionRequest merchantAccountId(String merchantAccountId)

options

public TransactionOptionsRequest options()

orderId

public TransactionRequest orderId(String orderId)

paymentMethodNonce

public TransactionRequest paymentMethodNonce(String paymentMethodNonce)

paymentMethodToken

public TransactionRequest paymentMethodToken(String paymentMethodToken)

paypalAccount

public TransactionPayPalRequest paypalAccount()

productSku

public TransactionRequest productSku(String productSku)

purchaseOrderNumber

public TransactionRequest purchaseOrderNumber(String purchaseOrderNumber)

recurring

@Deprecated
public TransactionRequest recurring(Boolean recurring)

Deprecated.

riskData

public RiskDataTransactionRequest riskData()

scaExemption

public TransactionRequest scaExemption(Transaction.ScaExemption scaExemption)

serviceFeeAmount

public TransactionRequest serviceFeeAmount(BigDecimal fee)

sharedBillingAddressId

public TransactionRequest sharedBillingAddressId(String sharedBillingAddressId)

sharedCustomerId

public TransactionRequest sharedCustomerId(String sharedCustomerId)

sharedPaymentMethodNonce

public TransactionRequest sharedPaymentMethodNonce(String sharedPaymentMethodNonce)

sharedPaymentMethodToken

public TransactionRequest sharedPaymentMethodToken(String sharedPaymentMethodToken)

sharedShippingAddressId

public TransactionRequest sharedShippingAddressId(String sharedShippingAddressId)

shippingAddress

public TransactionAddressRequest shippingAddress()

shippingAddressId

public TransactionRequest shippingAddressId(String shippingAddressId)

shippingAmount

public TransactionRequest shippingAmount(BigDecimal shippingAmount)

shipsFromPostalCode

public TransactionRequest shipsFromPostalCode(String shipsFromPostalCode)

taxAmount

public TransactionRequest taxAmount(BigDecimal taxAmount)

shippingTaxAmount

public TransactionRequest shippingTaxAmount(BigDecimal shippingTaxAmount)

taxExempt

public TransactionRequest taxExempt(Boolean taxExempt)

threeDSecureAuthenticationId

public TransactionRequest threeDSecureAuthenticationId(String threeDSecureAuthenticationId)

threeDSecurePassThru

public TransactionThreeDSecurePassThruRequest threeDSecurePassThru()

threeDSecureToken

@Deprecated
public TransactionRequest threeDSecureToken(String threeDSecureToken)

Deprecated.

use threeDSecureAuthenticationID instead

transactionSource

public TransactionRequest transactionSource(String source)

type

public TransactionRequest type(Transaction.Type type)

venmoSdkPaymentMethodCode
```
@Deprecated
public TransactionRequest venmoSdkPaymentMethodCode(String venmoSdkPaymentMethodCode)
```
Deprecated.
- The Venmo SDK integration is Unsupported. Please update your integration to use Pay with Venmo instead

toQueryString
```
public String toQueryString()
```
Overrides:

toQueryString in class Request

toQueryString

public String toQueryString(String root)

Overrides:: toQueryString in class Request

toXML
```
public String toXML()
```
Overrides:

toXML in class Request

buildRequest

protected RequestBuilder buildRequest(String root)

Class TransactionRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.braintreegateway.Request

Methods inherited from class java.lang.Object

Field Detail

amount

androidPayCardRequest

applePayCardRequest

billingAddressId

billingAddressRequest

channel

creditCardRequest

currencyIsoCode

customerId

customerRequest

customFields

descriptorRequest

deviceData

deviceSessionId

discountAmount

exchangeRateQuoteId

externalVaultRequest

finalCapture

foreignRetailer

fraudMerchantId

industryRequest

installments

merchantAccountId

orderId

paymentMethodNonce

paymentMethodToken

paypalRequest

productSku

purchaseOrderNumber

recurring

riskDataTransactionRequest

scaExemption

serviceFeeAmount

sharedBillingAddressId

sharedCustomerId

sharedPaymentMethodNonce

sharedPaymentMethodToken

sharedShippingAddressId

shippingAddressId

shippingAddressRequest

shippingAmount

shippingTaxAmount

shipsFromPostalCode

source

taxAmount

taxExempt

threeDSecureAuthenticationId

threeDSecurePassThruRequest

threeDSecureToken

threeDSecureTransaction

transactionLineItemRequests

transactionOptionsRequest

type

venmoSdkPaymentMethodCode

Constructor Detail

TransactionRequest

Method Detail

amount

androidPayCardRequest

applePayCardRequest

billingAddress

billingAddressId

channel

creditCard

currencyIsoCode

customer

customerId

customField

descriptor

deviceData

deviceSessionId

discountAmount

exchangeRateQuoteId