com.braintreepayments.api.models

Class LocalPaymentRequest

java.lang.Object

com.braintreepayments.api.models.LocalPaymentRequest

public class LocalPaymentRequest
extends java.lang.Object

Builder used to construct an local payment request.

Constructor Summary

Constructors

Constructor and Description
LocalPaymentRequest()

Method Summary

Modifier and Type	Method and Description
LocalPaymentRequest	address(PostalAddress address)
LocalPaymentRequest	amount(java.lang.String amount)
LocalPaymentRequest	approvalUrl(java.lang.String approvalUrl)
LocalPaymentRequest	bic(java.lang.String bankIdentificationCode)
java.lang.String	build(java.lang.String returnUrl, java.lang.String cancelUrl)
LocalPaymentRequest	currencyCode(java.lang.String currencyCode)
LocalPaymentRequest	email(java.lang.String email)
PostalAddress	getAddress()
java.lang.String	getAmount()
java.lang.String	getApprovalUrl()
java.lang.String	getBic()
java.lang.String	getCurrencyCode()
java.lang.String	getEmail()
java.lang.String	getGivenName()
java.lang.String	getMerchantAccountId()
java.lang.String	getPaymentId()
java.lang.String	getPaymentType()
java.lang.String	getPaymentTypeCountryCode()
java.lang.String	getPhone()
boolean	getShippingAddressRequired()
java.lang.String	getSurname()
LocalPaymentRequest	givenName(java.lang.String givenName)
LocalPaymentRequest	merchantAccountId(java.lang.String merchantAccountId)
LocalPaymentRequest	paymentId(java.lang.String paymentId)
LocalPaymentRequest	paymentType(java.lang.String paymentType)
LocalPaymentRequest	paymentTypeCountryCode(java.lang.String paymentTypeCountryCode)
LocalPaymentRequest	phone(java.lang.String phone)
LocalPaymentRequest	shippingAddressRequired(boolean shippingAddressRequired)
LocalPaymentRequest	surname(java.lang.String surname)

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalPaymentRequest

public LocalPaymentRequest()

Method Detail

address

public LocalPaymentRequest address(PostalAddress address)

Parameters:

address - Optional - The address of the customer. An error will occur if this address is not valid.

Returns:

LocalPaymentRequest

amount

public LocalPaymentRequest amount(java.lang.String amount)

Parameters:

amount - Optional - The amount for the transaction.

Returns:

LocalPaymentRequest

approvalUrl

public LocalPaymentRequest approvalUrl(java.lang.String approvalUrl)

Parameters:

approvalUrl - The URL used for payment approval. Do not set this property.

Returns:

LocalPaymentRequest

bic

public LocalPaymentRequest bic(java.lang.String bankIdentificationCode)

Parameters:

bankIdentificationCode - Optional - the Bank Identification Code of the customer (specific to iDEAL transactions).

Returns:

LocalPaymentRequest

currencyCode

public LocalPaymentRequest currencyCode(java.lang.String currencyCode)

Parameters:

currencyCode - Optional - A valid ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

Returns:

LocalPaymentRequest

email

public LocalPaymentRequest email(java.lang.String email)

Parameters:

email - Optional - Payer email of the customer.

Returns:

LocalPaymentRequest

givenName

public LocalPaymentRequest givenName(java.lang.String givenName)

Parameters:

givenName - Optional - Given (first) name of the customer.

Returns:

LocalPaymentRequest

merchantAccountId

public LocalPaymentRequest merchantAccountId(java.lang.String merchantAccountId)

Parameters:

merchantAccountId - Optional - A non-default merchant account to use for tokenization.

Returns:

LocalPaymentRequest

paymentId

public LocalPaymentRequest paymentId(java.lang.String paymentId)

Parameters:

paymentId - The ID of the local payment after creation. Do not set this property.

Returns:

LocalPaymentRequest

paymentType

public LocalPaymentRequest paymentType(java.lang.String paymentType)

Parameters:

paymentType - - The type of payment

Returns:

LocalPaymentRequest

paymentTypeCountryCode

public LocalPaymentRequest paymentTypeCountryCode(java.lang.String paymentTypeCountryCode)

Parameters:

paymentTypeCountryCode - The country code of the local payment. This value must be one of the supported country codes for a given local payment type listed. For local payments supported in multiple countries, this value may determine which banks are presented to the customer.

Returns:

LocalPaymentRequest

See Also:

Supported Country Codes

phone

public LocalPaymentRequest phone(java.lang.String phone)

Parameters:

phone - Optional - Phone number of the customer.

Returns:

LocalPaymentRequest

shippingAddressRequired

public LocalPaymentRequest shippingAddressRequired(boolean shippingAddressRequired)

Parameters:

shippingAddressRequired - - Indicates whether or not the payment needs to be shipped. For digital goods, this should be false. Defaults to false.

Returns:

LocalPaymentRequest

surname

public LocalPaymentRequest surname(java.lang.String surname)

Parameters:

surname - Optional - Surname (last name) of the customer.

Returns:

LocalPaymentRequest

getAddress

public PostalAddress getAddress()

getAmount

public java.lang.String getAmount()

getApprovalUrl

public java.lang.String getApprovalUrl()

getBic

public java.lang.String getBic()

getCurrencyCode

public java.lang.String getCurrencyCode()

getEmail

public java.lang.String getEmail()

getGivenName

public java.lang.String getGivenName()

getMerchantAccountId

public java.lang.String getMerchantAccountId()

getPaymentId

public java.lang.String getPaymentId()

getPaymentType

public java.lang.String getPaymentType()

getPaymentTypeCountryCode

public java.lang.String getPaymentTypeCountryCode()

getPhone

public java.lang.String getPhone()

getShippingAddressRequired

public boolean getShippingAddressRequired()

getSurname

public java.lang.String getSurname()

build

public java.lang.String build(java.lang.String returnUrl,
                              java.lang.String cancelUrl)