All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.braintreegateway.TransactionGateway Maven / Gradle / Ivy

package com.braintreegateway;

import com.braintreegateway.Transaction.Type;
import com.braintreegateway.exceptions.NotFoundException;
import com.braintreegateway.exceptions.UnexpectedException;
import com.braintreegateway.util.Http;
import com.braintreegateway.util.NodeWrapper;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

/**
 * Provides methods to interact with {@link Transaction Transactions}.
 * E.g. sales, credits, refunds, searches, etc.
 * This class does not need to be instantiated directly.
 * Instead, use {@link BraintreeGateway#transaction()} to get an instance of this class:
 *
 * 
 * BraintreeGateway gateway = new BraintreeGateway(...);
 * gateway.transaction().create(...)
 * 
* * For more detailed information on {@link Transaction Transactions}, see https://developer.paypal.com/braintree/docs/reference/response/transaction/java */ public class TransactionGateway { private Http http; private Configuration configuration; public TransactionGateway(Http http, Configuration configuration) { this.http = http; this.configuration = configuration; } /** * Submits the transaction with the given id to be adjusted for the given amount which must be less than or equal to the authorization amount. * @param id of the transaction to to be adjusted. * @param amount to be adjusted. * @return {@link Result}. */ public Result adjustAuthorization(String id, BigDecimal amount) { TransactionRequest request = new TransactionRequest().amount(amount); return adjustAuthorization(id, request); } /** * Submits the transaction with the given id to be adjusted for the given amount which must be less than or equal to the authorization amount. * @param id of the transaction to to be adjusted. * @param request is the TransactionRequest object with amount details. * @return {@link Result}. */ public Result adjustAuthorization(String id, TransactionRequest request) { NodeWrapper response = http.put(configuration.getMerchantPath() + "/transactions/" + id + "/adjust_authorization", request); return new Result(response, Transaction.class); } public Result cloneTransaction(String id, TransactionCloneRequest request) { NodeWrapper response = http.post(configuration.getMerchantPath() + "/transactions/" + id + "/clone", request); return new Result(response, Transaction.class); } /** * Creates a credit {@link Transaction}. * @param request the request. * @return a {@link Result} */ public Result credit(TransactionRequest request) { NodeWrapper response = http.post(configuration.getMerchantPath() + "/transactions", request.type(Type.CREDIT)); return new Result(response, Transaction.class); } /** * Finds a {@link Transaction} by id. * @param id the id of the {@link Transaction}. * @return the {@link Transaction} or raises a {@link com.braintreegateway.exceptions.NotFoundException}. */ public Transaction find(String id) { if (id == null || id.trim().equals("")) { throw new NotFoundException(); } return new Transaction(http.get(configuration.getMerchantPath() + "/transactions/" + id)); } /** * Refunds all or part of a previous sale {@link Transaction}. * @param id the id of the (sale) {@link Transaction} to refund. * @return a {@link Result}. */ public Result refund(String id) { NodeWrapper response = http.post(configuration.getMerchantPath() + "/transactions/" + id + "/refund"); return new Result(response, Transaction.class); } public Result refund(String id, BigDecimal amount) { TransactionRequest request = new TransactionRequest().amount(amount); NodeWrapper response = http.post(configuration.getMerchantPath() + "/transactions/" + id + "/refund", request); return new Result(response, Transaction.class); } public Result refund(String id, TransactionRefundRequest request) { NodeWrapper response = http.post(configuration.getMerchantPath() + "/transactions/" + id + "/refund", request); return new Result(response, Transaction.class); } /** * Creates a sale {@link Transaction}. * @param request the request. * @return a {@link Result}. */ public Result sale(TransactionRequest request) { NodeWrapper response = http.post(configuration.getMerchantPath() + "/transactions", request.type(Type.SALE)); return new Result(response, Transaction.class); } /** * Finds all Transactions that match the query and returns a {@link ResourceCollection}. * See: https://developer.paypal.com/braintree/docs/reference/request/transaction/search/java * @param query the search query * @return a {@link ResourceCollection} or raises a {@link UnexpectedException}. */ public ResourceCollection search(TransactionSearchRequest query) { NodeWrapper node = http.post(configuration.getMerchantPath() + "/transactions/advanced_search_ids", query); if (node.getElementName().equals("search-results")) { return new ResourceCollection(new TransactionPager(this, query), node); } else { throw new UnexpectedException("No search results found."); } } List fetchTransactions(TransactionSearchRequest query, List ids) { query.ids().in(ids); NodeWrapper response = http.post(configuration.getMerchantPath() + "/transactions/advanced_search", query); if (response.getElementName().equals("credit-card-transactions")) { List items = new ArrayList(); for (NodeWrapper node : response.findAll("transaction")) { items.add(new Transaction(node)); } return items; } else { throw new UnexpectedException("No credit card transaction results found."); } } /** * Cancels a pending release of a transaction with the given id from escrow. * @param id of the transaction to cancel release from escrow of. * @return a {@link Result}. */ public Result cancelRelease(String id) { TransactionRequest request = new TransactionRequest(); NodeWrapper response = http.put(configuration.getMerchantPath() + "/transactions/" + id + "/cancel_release", request); return new Result(response, Transaction.class); } /** * Holds the transaction with the given id for escrow. * @param id of the transaction to hold for escrow. * @return a {@link Result}. */ public Result holdInEscrow(String id) { TransactionRequest request = new TransactionRequest(); NodeWrapper response = http.put(configuration.getMerchantPath() + "/transactions/" + id + "/hold_in_escrow", request); return new Result(response, Transaction.class); } /** * Submits the transaction with the given id for release. * @param id of the transaction to submit for release. * @return a {@link Result}. */ public Result releaseFromEscrow(String id) { TransactionRequest request = new TransactionRequest(); NodeWrapper response = http.put(configuration.getMerchantPath() + "/transactions/" + id + "/release_from_escrow", request); return new Result(response, Transaction.class); } /** * Submits the transaction with the given id for settlement. * @param id of the transaction to submit for settlement. * @return a {@link Result}. */ public Result submitForSettlement(String id) { TransactionRequest request = new TransactionRequest(); return submitForSettlement(id, request); } /** * Submits the transaction with the given id to be settled for the given amount which must be less than or equal to the authorization amount. * @param id of the transaction to submit for settlement. * @param amount to settle. must be less than or equal to the authorization amount. * @return {@link Result}. */ public Result submitForSettlement(String id, BigDecimal amount) { TransactionRequest request = new TransactionRequest().amount(amount); return submitForSettlement(id, request); } /** * Submits the transaction with the given id to be settled along with a TransactionRequest object. * @param id of the transaction to submit for settlement. * @param request the request. * @return {@link Result}. */ public Result submitForSettlement(String id, TransactionRequest request) { NodeWrapper response = http.put(configuration.getMerchantPath() + "/transactions/" + id + "/submit_for_settlement", request); return new Result(response, Transaction.class); } /** * Updates details for a transaction that has been submitted for settlement. * @param id of the transaction to update the details for. * @param request the request. * @return {@link Result}. */ public Result updateDetails(String id, TransactionRequest request) { NodeWrapper response = http.put(configuration.getMerchantPath() + "/transactions/" + id + "/update_details", request); return new Result(response, Transaction.class); } /** * Voids the transaction with the given id. * @param id of the transaction to void. * @return {@link Result}. */ public Result voidTransaction(String id) { NodeWrapper response = http.put(configuration.getMerchantPath() + "/transactions/" + id + "/void"); return new Result(response, Transaction.class); } /** * Submits a partial settlement transaction for the given id. * @param id of the transaction to add the partial settlement transaction for. * @param amount of the partial settlement * @return {@link Result}. */ public Result submitForPartialSettlement(String id, BigDecimal amount) { TransactionRequest request = new TransactionRequest().amount(amount); return submitForPartialSettlement(id, request); } /** * Submits a partial settlement transaction for the given id. * @param id of the transaction to add the partial settlement transaction for. * @param request the request. * @return {@link Result}. */ public Result submitForPartialSettlement(String id, TransactionRequest request) { NodeWrapper response = http.post(configuration.getMerchantPath() + "/transactions/" + id + "/submit_for_partial_settlement", request); return new Result(response, Transaction.class); } /** * Updates custom field values for a given transaction * @param id of the transaction being updated. * @param request a TransactionRequest object containing custom field info.. * @return {@link Result}. */ public Result updateCustomFields(String id, TransactionRequest request) { NodeWrapper response = http.put(configuration.getMerchantPath() + "/transactions/" + id + "/custom_fields", request); return new Result(response, Transaction.class); } /** * Supplement the transaction with package tracking details * @param id of the transaction to supplement the package details for * @param packageTrackingRequest the package tracking request related to the transaction * @return {@link Result} */ public Result packageTracking(String id, PackageTrackingRequest packageTrackingRequest) { NodeWrapper response = http.post(configuration.getMerchantPath() + "/transactions/" + id + "/shipments", packageTrackingRequest); return new Result(response, Transaction.class); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy