Package com.broadleafcommerce.braintree.domain

Class BraintreeResponse

java.lang.Object

com.broadleafcommerce.braintree.domain.BraintreeResponse

public class BraintreeResponse
extends Object

This is summary object for all necessary responses for the current transaction types: - Authorize - Capture - AuthorizeAndCapture - Reverse - Refund More details: Payments Response description

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BraintreeResponse.Amount	A monetary amount with currency.
static class	BraintreeResponse.AuthorizePaymentMethod
static class	BraintreeResponse.CaptureTransaction
static class	BraintreeResponse.ChargePaymentMethod
static class	BraintreeResponse.Data	Object wrapper for each transaction type (payment method)
static class	BraintreeResponse.Edge
static class	BraintreeResponse.Error
static class	BraintreeResponse.ErrorExtension
static class	BraintreeResponse.Extensions
static class	BraintreeResponse.PaymentMethod	Top-level field representing a payment method.
static class	BraintreeResponse.Refund	A refund of a charge on a payment method, representing an attempt to send money from a previous transaction back to the customer.
static class	BraintreeResponse.RefundTransaction
static class	BraintreeResponse.ReverseTransaction
static class	BraintreeResponse.SearchResult
static class	BraintreeResponse.SearchTransaction
static class	BraintreeResponse.StatusHistory	Status event in the lifecycle of a payment.
static class	BraintreeResponse.Transaction	Transaction payload

Constructor Summary

Constructors

Constructor	Description
BraintreeResponse()

Method Summary

Modifier and Type	Method	Description
BraintreeResponse.Data	getData()	A successful query MUST return a JSON object with a data key whose value is a JSON object with the data you requested.
List<BraintreeResponse.Error>	getErrors()	Unlike a conventional REST API, GraphQL APIs do not rely on HTTP status codes to signal request outcomes.
BraintreeResponse.Extensions	getExtensions()	The API response MUST contain an extensions object.
void	setData(BraintreeResponse.Data data)	A successful query MUST return a JSON object with a data key whose value is a JSON object with the data you requested.
void	setErrors(List<BraintreeResponse.Error> errors)	Unlike a conventional REST API, GraphQL APIs do not rely on HTTP status codes to signal request outcomes.
void	setExtensions(BraintreeResponse.Extensions extensions)	The API response MUST contain an extensions object.

Methods inherited from class java.lang.Object

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

Constructor Details

BraintreeResponse

public BraintreeResponse()

Method Details

setExtensions

public void setExtensions(BraintreeResponse.Extensions extensions)

The API response MUST contain an extensions object. This object contains at least a requestId entry that is unique to the request and useful to Braintree Support should you need help debugging a request.

setData

public void setData(BraintreeResponse.Data data)

A successful query MUST return a JSON object with a data key whose value is a JSON object with the data you requested. Each key in the data object will exactly match those specified in the query.

setErrors

public void setErrors(List<BraintreeResponse.Error> errors)

Unlike a conventional REST API, GraphQL APIs do not rely on HTTP status codes to signal request outcomes. Our GraphQL API always return a JSON body with the 200 status code, even when there are errors. If an error occurred, the response body MUST include a top-level errors array that describes the error or errors

getExtensions

public BraintreeResponse.Extensions getExtensions()

The API response MUST contain an extensions object. This object contains at least a requestId entry that is unique to the request and useful to Braintree Support should you need help debugging a request.

getData

public BraintreeResponse.Data getData()

A successful query MUST return a JSON object with a data key whose value is a JSON object with the data you requested. Each key in the data object will exactly match those specified in the query.

getErrors

public List<BraintreeResponse.Error> getErrors()

Unlike a conventional REST API, GraphQL APIs do not rely on HTTP status codes to signal request outcomes. Our GraphQL API always return a JSON body with the 200 status code, even when there are errors. If an error occurred, the response body MUST include a top-level errors array that describes the error or errors