Package com.stripe.param

Class CreditNotePreviewParams.Refund.Builder

java.lang.Object

com.stripe.param.CreditNotePreviewParams.Refund.Builder

Enclosing class:

CreditNotePreviewParams.Refund

public static class CreditNotePreviewParams.Refund.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreditNotePreviewParams.Refund	build()	Finalize and obtain parameter instance from this builder.
CreditNotePreviewParams.Refund.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
CreditNotePreviewParams.Refund.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
CreditNotePreviewParams.Refund.Builder	setAmountRefunded(Long amountRefunded)	Amount of the refund that applies to this credit note, in cents (or local equivalent).
CreditNotePreviewParams.Refund.Builder	setPaymentRecordRefund(CreditNotePreviewParams.Refund.PaymentRecordRefund paymentRecordRefund)	The PaymentRecord refund details to link to this credit note.
CreditNotePreviewParams.Refund.Builder	setRefund(String refund)	ID of an existing refund to link this credit note to.
CreditNotePreviewParams.Refund.Builder	setType(CreditNotePreviewParams.Refund.Type type)	Type of the refund, one of refund or payment_record_refund.

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 CreditNotePreviewParams.Refund build()

Finalize and obtain parameter instance from this builder.

setAmountRefunded

public CreditNotePreviewParams.Refund.Builder setAmountRefunded(Long amountRefunded)

Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.

putExtraParam

public CreditNotePreviewParams.Refund.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 CreditNotePreviewParams.Refund.extraParams for the field documentation.

putAllExtraParam

public CreditNotePreviewParams.Refund.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 CreditNotePreviewParams.Refund.extraParams for the field documentation.

setPaymentRecordRefund

public CreditNotePreviewParams.Refund.Builder setPaymentRecordRefund(CreditNotePreviewParams.Refund.PaymentRecordRefund paymentRecordRefund)

The PaymentRecord refund details to link to this credit note. Required when type is payment_record_refund.

setRefund

public CreditNotePreviewParams.Refund.Builder setRefund(String refund)

ID of an existing refund to link this credit note to. Required when type is refund.

setType

public CreditNotePreviewParams.Refund.Builder setType(CreditNotePreviewParams.Refund.Type type)

Type of the refund, one of refund or payment_record_refund. Defaults to refund.