TransactionRequest (Braintree Gateway Java Client Library 2.107.0 API)

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 and Description
`private BigDecimal`	`amount`
`private TransactionApplePayCardRequest`	`applePayCardRequest`
`private String`	`billingAddressId`
`private TransactionAddressRequest`	`billingAddressRequest`
`private String`	`channel`
`private TransactionCreditCardRequest`	`creditCardRequest`
`private String`	`customerId`
`private CustomerRequest`	`customerRequest`
`private Map<String,String>`	`customFields`
`private TransactionDescriptorRequest`	`descriptorRequest`
`private String`	`deviceData`
`private String`	`deviceSessionId`
`private BigDecimal`	`discountAmount`
`private ExternalVaultRequest`	`externalVaultRequest`
`private String`	`fraudMerchantId`
`private TransactionIndustryRequest`	`industryRequest`
`private String`	`merchantAccountId`
`private String`	`orderId`
`private String`	`paymentMethodNonce`
`private String`	`paymentMethodToken`
`private TransactionPayPalRequest`	`paypalRequest`
`private String`	`purchaseOrderNumber`
`private Boolean`	`recurring`
`private RiskDataTransactionRequest`	`riskDataTransactionRequest`
`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 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 and Description

TransactionRequest()

Constructors
Constructor and Description
`TransactionRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransactionRequest`	`amount(BigDecimal amount)`
`TransactionApplePayCardRequest`	`applePayCardRequest()`
`TransactionAddressRequest`	`billingAddress()`
`TransactionRequest`	`billingAddressId(String billingAddressId)`
`protected RequestBuilder`	`buildRequest(String root)`
`TransactionRequest`	`channel(String channel)`
`TransactionCreditCardRequest`	`creditCard()`
`CustomerRequest`	`customer()`
`TransactionRequest`	`customerId(String customerId)`
`TransactionRequest`	`customField(String apiName, String value)`
`TransactionDescriptorRequest`	`descriptor()`
`TransactionRequest`	`deviceData(String deviceData)`
`TransactionRequest`	`deviceSessionId(String deviceSessionId)`
`TransactionRequest`	`discountAmount(BigDecimal discountAmount)`
`ExternalVaultRequest`	`externalVault()`
`TransactionRequest`	`fraudMerchantId(String fraudMerchantId)`
`String`	`getKind()`
`TransactionIndustryRequest`	`industry()`
`TransactionLineItemRequest`	`lineItem()`
`TransactionRequest`	`merchantAccountId(String merchantAccountId)`
`TransactionOptionsRequest`	`options()`
`TransactionRequest`	`orderId(String orderId)`
`TransactionRequest`	`paymentMethodNonce(String paymentMethodNonce)`
`TransactionRequest`	`paymentMethodToken(String paymentMethodToken)`
`TransactionPayPalRequest`	`paypalAccount()`
`TransactionRequest`	`purchaseOrderNumber(String purchaseOrderNumber)`
`TransactionRequest`	`recurring(Boolean recurring)`
`RiskDataTransactionRequest`	`riskData()`
`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`	`shipsFromPostalCode(String shipsFromPostalCode)`
`TransactionRequest`	`taxAmount(BigDecimal taxAmount)`
`TransactionRequest`	`taxExempt(Boolean taxExempt)`
`TransactionRequest`	`threeDSecureAuthenticationId(String threeDSecureAuthenticationId)`
`TransactionThreeDSecurePassThruRequest`	`threeDSecurePassThru()`
`TransactionRequest`	`threeDSecureToken(String threeDSecureToken)`
`String`	`toQueryString()`
`String`	`toQueryString(String root)`
`String`	`toXML()`
`TransactionRequest`	`transactionSource(String source)`
`TransactionRequest`	`type(Transaction.Type type)`
`TransactionRequest`	`venmoSdkPaymentMethodCode(String venmoSdkPaymentMethodCode)`

Methods inherited from class com.braintreegateway.Request
buildXMLElement, buildXMLElement, 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
```

billingAddressRequest

private TransactionAddressRequest billingAddressRequest

deviceData
```
private String deviceData
```

creditCardRequest

private TransactionCreditCardRequest creditCardRequest

paypalRequest

private TransactionPayPalRequest paypalRequest

channel
```
private String channel
```

customerId
```
private String customerId
```

deviceSessionId
```
private String deviceSessionId
```

fraudMerchantId
```
private String fraudMerchantId
```

customerRequest

private CustomerRequest customerRequest

customFields

private Map<String,String> customFields

merchantAccountId
```
private String merchantAccountId
```

orderId
```
private String orderId
```

paymentMethodToken
```
private String paymentMethodToken
```

purchaseOrderNumber
```
private String purchaseOrderNumber
```

recurring
```
private Boolean recurring
```

source
```
private String source
```

shippingAddressId
```
private String shippingAddressId
```

billingAddressId
```
private String billingAddressId
```

applePayCardRequest

private TransactionApplePayCardRequest applePayCardRequest

descriptorRequest

private TransactionDescriptorRequest descriptorRequest

industryRequest

private TransactionIndustryRequest industryRequest

shippingAddressRequest

private TransactionAddressRequest shippingAddressRequest

transactionOptionsRequest

private TransactionOptionsRequest transactionOptionsRequest

threeDSecurePassThruRequest

private TransactionThreeDSecurePassThruRequest threeDSecurePassThruRequest

taxAmount
```
private BigDecimal taxAmount
```

taxExempt
```
private Boolean taxExempt
```

shippingAmount
```
private BigDecimal shippingAmount
```

discountAmount
```
private BigDecimal discountAmount
```

shipsFromPostalCode
```
private String shipsFromPostalCode
```

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

venmoSdkPaymentMethodCode

private String venmoSdkPaymentMethodCode

paymentMethodNonce
```
private String paymentMethodNonce
```

serviceFeeAmount
```
private BigDecimal serviceFeeAmount
```

threeDSecureToken
```
private String threeDSecureToken
```

threeDSecureTransaction

private Boolean threeDSecureTransaction

threeDSecureAuthenticationId

private String threeDSecureAuthenticationId

sharedPaymentMethodToken

private String sharedPaymentMethodToken

sharedPaymentMethodNonce

private String sharedPaymentMethodNonce

sharedCustomerId
```
private String sharedCustomerId
```

sharedShippingAddressId
```
private String sharedShippingAddressId
```

sharedBillingAddressId
```
private String sharedBillingAddressId
```

riskDataTransactionRequest

private RiskDataTransactionRequest riskDataTransactionRequest

transactionLineItemRequests

private List<TransactionLineItemRequest> transactionLineItemRequests

externalVaultRequest

private ExternalVaultRequest externalVaultRequest

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

Method Detail

amount

public TransactionRequest amount(BigDecimal amount)

billingAddress

public TransactionAddressRequest billingAddress()

deviceData

public TransactionRequest deviceData(String deviceData)

channel

public TransactionRequest channel(String channel)

creditCard

public TransactionCreditCardRequest creditCard()

paypalAccount

public TransactionPayPalRequest paypalAccount()

serviceFeeAmount

public TransactionRequest serviceFeeAmount(BigDecimal fee)

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

customerId

public TransactionRequest customerId(String customerId)

customField

public TransactionRequest customField(String apiName,
                                      String value)

deviceSessionId

public TransactionRequest deviceSessionId(String deviceSessionId)

fraudMerchantId

public TransactionRequest fraudMerchantId(String fraudMerchantId)

descriptor

public TransactionDescriptorRequest descriptor()

industry

public TransactionIndustryRequest industry()

getKind
```
public String getKind()
```
Overrides:

getKind in class Request

merchantAccountId

public TransactionRequest merchantAccountId(String merchantAccountId)

options

public TransactionOptionsRequest options()

threeDSecurePassThru

public TransactionThreeDSecurePassThruRequest threeDSecurePassThru()

orderId

public TransactionRequest orderId(String orderId)

paymentMethodToken

public TransactionRequest paymentMethodToken(String paymentMethodToken)

purchaseOrderNumber

public TransactionRequest purchaseOrderNumber(String purchaseOrderNumber)

recurring

public TransactionRequest recurring(Boolean recurring)

transactionSource

public TransactionRequest transactionSource(String source)

shippingAddress

public TransactionAddressRequest shippingAddress()

shippingAddressId

public TransactionRequest shippingAddressId(String shippingAddressId)

billingAddressId

public TransactionRequest billingAddressId(String billingAddressId)

taxAmount

public TransactionRequest taxAmount(BigDecimal taxAmount)

taxExempt

public TransactionRequest taxExempt(Boolean taxExempt)

shippingAmount

public TransactionRequest shippingAmount(BigDecimal shippingAmount)

discountAmount

public TransactionRequest discountAmount(BigDecimal discountAmount)

shipsFromPostalCode

public TransactionRequest shipsFromPostalCode(String shipsFromPostalCode)

venmoSdkPaymentMethodCode

public TransactionRequest venmoSdkPaymentMethodCode(String venmoSdkPaymentMethodCode)

paymentMethodNonce

public TransactionRequest paymentMethodNonce(String paymentMethodNonce)

threeDSecureToken

public TransactionRequest threeDSecureToken(String threeDSecureToken)

threeDSecureAuthenticationId

public TransactionRequest threeDSecureAuthenticationId(String threeDSecureAuthenticationId)

sharedPaymentMethodToken

public TransactionRequest sharedPaymentMethodToken(String sharedPaymentMethodToken)

sharedPaymentMethodNonce

public TransactionRequest sharedPaymentMethodNonce(String sharedPaymentMethodNonce)

sharedCustomerId

public TransactionRequest sharedCustomerId(String sharedCustomerId)

sharedShippingAddressId

public TransactionRequest sharedShippingAddressId(String sharedShippingAddressId)

sharedBillingAddressId

public TransactionRequest sharedBillingAddressId(String sharedBillingAddressId)

riskData

public RiskDataTransactionRequest riskData()

lineItem

public TransactionLineItemRequest lineItem()

applePayCardRequest

public TransactionApplePayCardRequest applePayCardRequest()

externalVault

public ExternalVaultRequest externalVault()

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

type

public TransactionRequest type(Transaction.Type type)

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

billingAddressRequest

deviceData

creditCardRequest

paypalRequest

channel

customerId

deviceSessionId

fraudMerchantId

customerRequest

customFields

merchantAccountId

orderId

paymentMethodToken

purchaseOrderNumber

recurring

source

shippingAddressId

billingAddressId

applePayCardRequest

descriptorRequest

industryRequest

shippingAddressRequest

transactionOptionsRequest

threeDSecurePassThruRequest

taxAmount

taxExempt

shippingAmount

discountAmount

shipsFromPostalCode

type

venmoSdkPaymentMethodCode

paymentMethodNonce

serviceFeeAmount

threeDSecureToken

threeDSecureTransaction

threeDSecureAuthenticationId

sharedPaymentMethodToken

sharedPaymentMethodNonce

sharedCustomerId

sharedShippingAddressId

sharedBillingAddressId

riskDataTransactionRequest

transactionLineItemRequests

externalVaultRequest

Constructor Detail

TransactionRequest

Method Detail

amount

billingAddress

deviceData

channel

creditCard

paypalAccount

serviceFeeAmount

customer

customerId

customField

deviceSessionId

fraudMerchantId

descriptor

industry

getKind

merchantAccountId

options

threeDSecurePassThru

orderId

paymentMethodToken

purchaseOrderNumber

recurring

transactionSource

shippingAddress

shippingAddressId