Package com.adyen.model.checkout

Class PaymentCaptureResource

java.lang.Object

com.adyen.model.checkout.PaymentCaptureResource

public class PaymentCaptureResource
extends Object

PaymentCaptureResource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentCaptureResource.StatusEnum	The status of your request.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_AMOUNT
static String	SERIALIZED_NAME_MERCHANT_ACCOUNT
static String	SERIALIZED_NAME_PAYMENT_PSP_REFERENCE
static String	SERIALIZED_NAME_PSP_REFERENCE
static String	SERIALIZED_NAME_REFERENCE
static String	SERIALIZED_NAME_SPLITS
static String	SERIALIZED_NAME_STATUS

Constructor Summary

Constructors

Constructor	Description
PaymentCaptureResource()

Method Summary

Modifier and Type	Method	Description
PaymentCaptureResource	addLineItemsItem(LineItem lineItemsItem)
PaymentCaptureResource	addSplitsItem(Split splitsItem)
PaymentCaptureResource	amount(Amount amount)
boolean	equals(Object o)
Amount	getAmount()	Get amount
List<LineItem>	getLineItems()	Price and product information of the captured items, required for [partial captures](https://docs.adyen.com/online-payments/capture#partial-capture).
String	getMerchantAccount()	The merchant account that is used to process the payment.
String	getPaymentPspReference()	The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to capture.
String	getPspReference()	Adyen's 16-character reference associated with the capture request.
String	getReference()	Your reference for the capture request.
List<Split>	getSplits()	An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.
PaymentCaptureResource.StatusEnum	getStatus()	The status of your request.
int	hashCode()
PaymentCaptureResource	lineItems(List<LineItem> lineItems)
PaymentCaptureResource	merchantAccount(String merchantAccount)
PaymentCaptureResource	paymentPspReference(String paymentPspReference)
PaymentCaptureResource	pspReference(String pspReference)
PaymentCaptureResource	reference(String reference)
void	setAmount(Amount amount)
void	setLineItems(List<LineItem> lineItems)
void	setMerchantAccount(String merchantAccount)
void	setPaymentPspReference(String paymentPspReference)
void	setPspReference(String pspReference)
void	setReference(String reference)
void	setSplits(List<Split> splits)
void	setStatus(PaymentCaptureResource.StatusEnum status)
PaymentCaptureResource	splits(List<Split> splits)
PaymentCaptureResource	status(PaymentCaptureResource.StatusEnum status)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_MERCHANT_ACCOUNT

public static final String SERIALIZED_NAME_MERCHANT_ACCOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_PAYMENT_PSP_REFERENCE

public static final String SERIALIZED_NAME_PAYMENT_PSP_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_PSP_REFERENCE

public static final String SERIALIZED_NAME_PSP_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_REFERENCE

public static final String SERIALIZED_NAME_REFERENCE

See Also:

Constant Field Values

SERIALIZED_NAME_SPLITS

public static final String SERIALIZED_NAME_SPLITS

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

Constructor Detail

PaymentCaptureResource

public PaymentCaptureResource()

Method Detail

amount

public PaymentCaptureResource amount(Amount amount)

getAmount

public Amount getAmount()

Get amount

Returns:

amount

setAmount

public void setAmount(Amount amount)

lineItems

public PaymentCaptureResource lineItems(List<LineItem> lineItems)

addLineItemsItem

public PaymentCaptureResource addLineItemsItem(LineItem lineItemsItem)

getLineItems

public List<LineItem> getLineItems()

Price and product information of the captured items, required for [partial captures](https://docs.adyen.com/online-payments/capture#partial-capture). > This field is required for partial captures with 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, Zip and Atome.

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItem> lineItems)

merchantAccount

public PaymentCaptureResource merchantAccount(String merchantAccount)

getMerchantAccount

public String getMerchantAccount()

The merchant account that is used to process the payment.

Returns:

merchantAccount

setMerchantAccount

public void setMerchantAccount(String merchantAccount)

paymentPspReference

public PaymentCaptureResource paymentPspReference(String paymentPspReference)

getPaymentPspReference

public String getPaymentPspReference()

The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to capture.

Returns:

paymentPspReference

setPaymentPspReference

public void setPaymentPspReference(String paymentPspReference)

pspReference

public PaymentCaptureResource pspReference(String pspReference)

getPspReference

public String getPspReference()

Adyen's 16-character reference associated with the capture request.

Returns:

pspReference

setPspReference

public void setPspReference(String pspReference)

reference

public PaymentCaptureResource reference(String reference)

getReference

public String getReference()

Your reference for the capture request.

Returns:

reference

setReference

public void setReference(String reference)

splits

public PaymentCaptureResource splits(List<Split> splits)

addSplitsItem

public PaymentCaptureResource addSplitsItem(Split splitsItem)

getSplits

public List<Split> getSplits()

An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).

Returns:

splits

setSplits

public void setSplits(List<Split> splits)

status

public PaymentCaptureResource status(PaymentCaptureResource.StatusEnum status)

getStatus

public PaymentCaptureResource.StatusEnum getStatus()

The status of your request. This will always have the value **received**.

Returns:

status

setStatus

public void setStatus(PaymentCaptureResource.StatusEnum status)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object