Package com.stripe.param.tax

Class TransactionCreateReversalParams.Builder

java.lang.Object

com.stripe.param.tax.TransactionCreateReversalParams.Builder

Enclosing class:

TransactionCreateReversalParams

public static class TransactionCreateReversalParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TransactionCreateReversalParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
TransactionCreateReversalParams.Builder	addAllLineItem(List<TransactionCreateReversalParams.LineItem> elements)	Add all elements to `lineItems` list.
TransactionCreateReversalParams.Builder	addExpand(String element)	Add an element to `expand` list.
TransactionCreateReversalParams.Builder	addLineItem(TransactionCreateReversalParams.LineItem element)	Add an element to `lineItems` list.
TransactionCreateReversalParams	build()	Finalize and obtain parameter instance from this builder.
TransactionCreateReversalParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
TransactionCreateReversalParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
TransactionCreateReversalParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
TransactionCreateReversalParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
TransactionCreateReversalParams.Builder	setFlatAmount(Long flatAmount)	A flat amount to reverse across the entire transaction, in the smallest currency unit in negative.
TransactionCreateReversalParams.Builder	setMode(TransactionCreateReversalParams.Mode mode)	Required. If partial, the provided line item or shipping cost amounts are reversed.
TransactionCreateReversalParams.Builder	setOriginalTransaction(String originalTransaction)	Required. The ID of the Transaction to partially or fully reverse.
TransactionCreateReversalParams.Builder	setReference(String reference)	Required. A custom identifier for this reversal, such as myOrder_123-refund_1, which must be unique across all transactions.
TransactionCreateReversalParams.Builder	setShippingCost(TransactionCreateReversalParams.ShippingCost shippingCost)	The shipping cost to reverse.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public TransactionCreateReversalParams build()

Finalize and obtain parameter instance from this builder.

addExpand

public TransactionCreateReversalParams.Builder addExpand(String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See TransactionCreateReversalParams.expand for the field documentation.

addAllExpand

public TransactionCreateReversalParams.Builder addAllExpand(List<String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See TransactionCreateReversalParams.expand for the field documentation.

putExtraParam

public TransactionCreateReversalParams.Builder putExtraParam(String key,
 Object value)

Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransactionCreateReversalParams.extraParams for the field documentation.

putAllExtraParam

public TransactionCreateReversalParams.Builder putAllExtraParam(Map<String,Object> map)

Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransactionCreateReversalParams.extraParams for the field documentation.

setFlatAmount

public TransactionCreateReversalParams.Builder setFlatAmount(Long flatAmount)

A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes.

addLineItem

public TransactionCreateReversalParams.Builder addLineItem(TransactionCreateReversalParams.LineItem element)

Add an element to `lineItems` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See TransactionCreateReversalParams.lineItems for the field documentation.

addAllLineItem

public TransactionCreateReversalParams.Builder addAllLineItem(List<TransactionCreateReversalParams.LineItem> elements)

Add all elements to `lineItems` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See TransactionCreateReversalParams.lineItems for the field documentation.

putMetadata

public TransactionCreateReversalParams.Builder putMetadata(String key,
 String value)

Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransactionCreateReversalParams.metadata for the field documentation.

putAllMetadata

public TransactionCreateReversalParams.Builder putAllMetadata(Map<String,String> map)

Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See TransactionCreateReversalParams.metadata for the field documentation.

setMode

public TransactionCreateReversalParams.Builder setMode(TransactionCreateReversalParams.Mode mode)

Required. If partial, the provided line item or shipping cost amounts are reversed. If full, the original transaction is fully reversed.

setOriginalTransaction

public TransactionCreateReversalParams.Builder setOriginalTransaction(String originalTransaction)

Required. The ID of the Transaction to partially or fully reverse.

setReference

public TransactionCreateReversalParams.Builder setReference(String reference)

Required. A custom identifier for this reversal, such as myOrder_123-refund_1, which must be unique across all transactions. The reference helps identify this reversal transaction in exported tax reports.

setShippingCost

public TransactionCreateReversalParams.Builder setShippingCost(TransactionCreateReversalParams.ShippingCost shippingCost)

The shipping cost to reverse.