Package com.adyen.model.checkout

Class PaymentCaptureRequest

java.lang.Object

com.adyen.model.checkout.PaymentCaptureRequest

public class PaymentCaptureRequest
extends Object

PaymentCaptureRequest

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_AMOUNT
static String	JSON_PROPERTY_LINE_ITEMS
static String	JSON_PROPERTY_MERCHANT_ACCOUNT
static String	JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
static String	JSON_PROPERTY_REFERENCE
static String	JSON_PROPERTY_SPLITS
static String	JSON_PROPERTY_SUB_MERCHANTS

Constructor Summary

Constructors

Constructor	Description
PaymentCaptureRequest()

Method Summary

Modifier and Type	Method	Description
PaymentCaptureRequest	addLineItemsItem(LineItem lineItemsItem)
PaymentCaptureRequest	addSplitsItem(Split splitsItem)
PaymentCaptureRequest	addSubMerchantsItem(SubMerchantInfo subMerchantsItem)
PaymentCaptureRequest	amount(Amount amount)
boolean	equals(Object o)	Return true if this PaymentCaptureRequest object is equal to o.
static PaymentCaptureRequest	fromJson(String jsonString)	Create an instance of PaymentCaptureRequest given an JSON string
Amount	getAmount()	Get amount
List<LineItem>	getLineItems()	Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
String	getMerchantAccount()	The merchant account that is used to process the payment.
PlatformChargebackLogic	getPlatformChargebackLogic()	Get platformChargebackLogic
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.
List<SubMerchantInfo>	getSubMerchants()	A List of sub-merchants.
int	hashCode()
PaymentCaptureRequest	lineItems(List<LineItem> lineItems)
PaymentCaptureRequest	merchantAccount(String merchantAccount)
PaymentCaptureRequest	platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
PaymentCaptureRequest	reference(String reference)
void	setAmount(Amount amount)
void	setLineItems(List<LineItem> lineItems)
void	setMerchantAccount(String merchantAccount)
void	setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
void	setReference(String reference)
void	setSplits(List<Split> splits)
void	setSubMerchants(List<SubMerchantInfo> subMerchants)
PaymentCaptureRequest	splits(List<Split> splits)
PaymentCaptureRequest	subMerchants(List<SubMerchantInfo> subMerchants)
String	toJson()	Convert an instance of PaymentCaptureRequest to an JSON string
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_AMOUNT

public static final String JSON_PROPERTY_AMOUNT

See Also:

Constant Field Values

JSON_PROPERTY_LINE_ITEMS

public static final String JSON_PROPERTY_LINE_ITEMS

See Also:

Constant Field Values

JSON_PROPERTY_MERCHANT_ACCOUNT

public static final String JSON_PROPERTY_MERCHANT_ACCOUNT

See Also:

Constant Field Values

JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC

public static final String JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC

See Also:

Constant Field Values

JSON_PROPERTY_REFERENCE

public static final String JSON_PROPERTY_REFERENCE

See Also:

Constant Field Values

JSON_PROPERTY_SPLITS

public static final String JSON_PROPERTY_SPLITS

See Also:

Constant Field Values

JSON_PROPERTY_SUB_MERCHANTS

public static final String JSON_PROPERTY_SUB_MERCHANTS

See Also:

Constant Field Values

Constructor Detail

PaymentCaptureRequest

public PaymentCaptureRequest()

Method Detail

amount

public PaymentCaptureRequest amount(Amount amount)

getAmount

public Amount getAmount()

Get amount

Returns:

amount

setAmount

public void setAmount(Amount amount)

lineItems

public PaymentCaptureRequest lineItems(List<LineItem> lineItems)

addLineItemsItem

public PaymentCaptureRequest addLineItemsItem(LineItem lineItemsItem)

getLineItems

public List<LineItem> getLineItems()

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

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItem> lineItems)

merchantAccount

public PaymentCaptureRequest 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)

platformChargebackLogic

public PaymentCaptureRequest platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)

getPlatformChargebackLogic

public PlatformChargebackLogic getPlatformChargebackLogic()

Get platformChargebackLogic

Returns:

platformChargebackLogic

setPlatformChargebackLogic

public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)

reference

public PaymentCaptureRequest reference(String reference)

getReference

public String getReference()

Your reference for the capture request. Maximum length: 80 characters.

Returns:

reference

setReference

public void setReference(String reference)

splits

public PaymentCaptureRequest splits(List<Split> splits)

addSplitsItem

public PaymentCaptureRequest 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/marketplaces-and-platforms/processing-payments#providing-split-information).

Returns:

splits

setSplits

public void setSplits(List<Split> splits)

subMerchants

public PaymentCaptureRequest subMerchants(List<SubMerchantInfo> subMerchants)

addSubMerchantsItem

public PaymentCaptureRequest addSubMerchantsItem(SubMerchantInfo subMerchantsItem)

getSubMerchants

public List<SubMerchantInfo> getSubMerchants()

A List of sub-merchants.

Returns:

subMerchants

setSubMerchants

public void setSubMerchants(List<SubMerchantInfo> subMerchants)

equals

public boolean equals(Object o)

Return true if this PaymentCaptureRequest object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromJson

public static PaymentCaptureRequest fromJson(String jsonString)
                                      throws com.fasterxml.jackson.core.JsonProcessingException

Create an instance of PaymentCaptureRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PaymentCaptureRequest

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentCaptureRequest

toJson

public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException

Convert an instance of PaymentCaptureRequest to an JSON string

Returns:

JSON string

Throws:

com.fasterxml.jackson.core.JsonProcessingException