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 StringJSON_PROPERTY_AMOUNTstatic StringJSON_PROPERTY_APPLICATION_INFOstatic StringJSON_PROPERTY_LINE_ITEMSstatic StringJSON_PROPERTY_MERCHANT_ACCOUNTstatic StringJSON_PROPERTY_PLATFORM_CHARGEBACK_LOGICstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_SPLITSstatic StringJSON_PROPERTY_SUB_MERCHANTS
-
Constructor Summary
Constructors Constructor Description PaymentCaptureRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PaymentCaptureRequestaddLineItemsItem(LineItem lineItemsItem)PaymentCaptureRequestaddSplitsItem(Split splitsItem)PaymentCaptureRequestaddSubMerchantsItem(SubMerchantInfo subMerchantsItem)PaymentCaptureRequestamount(Amount amount)PaymentCaptureRequestapplicationInfo(ApplicationInfo applicationInfo)booleanequals(Object o)Return true if this PaymentCaptureRequest object is equal to o.static PaymentCaptureRequestfromJson(String jsonString)Create an instance of PaymentCaptureRequest given an JSON stringAmountgetAmount()Get amountApplicationInfogetApplicationInfo()Get applicationInfoList<LineItem>getLineItems()Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).StringgetMerchantAccount()The merchant account that is used to process the payment.PlatformChargebackLogicgetPlatformChargebackLogic()Get platformChargebackLogicStringgetReference()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.inthashCode()PaymentCaptureRequestlineItems(List<LineItem> lineItems)PaymentCaptureRequestmerchantAccount(String merchantAccount)PaymentCaptureRequestplatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)PaymentCaptureRequestreference(String reference)voidsetAmount(Amount amount)amountvoidsetApplicationInfo(ApplicationInfo applicationInfo)applicationInfovoidsetLineItems(List<LineItem> lineItems)Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).voidsetMerchantAccount(String merchantAccount)The merchant account that is used to process the payment.voidsetPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)platformChargebackLogicvoidsetReference(String reference)Your reference for the capture request.voidsetSplits(List<Split> splits)An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.voidsetSubMerchants(List<SubMerchantInfo> subMerchants)A List of sub-merchants.PaymentCaptureRequestsplits(List<Split> splits)PaymentCaptureRequestsubMerchants(List<SubMerchantInfo> subMerchants)StringtoJson()Convert an instance of PaymentCaptureRequest to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_AMOUNT
public static final String JSON_PROPERTY_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_APPLICATION_INFO
public static final String JSON_PROPERTY_APPLICATION_INFO
- 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
-
-
Method Detail
-
amount
public PaymentCaptureRequest amount(Amount amount)
-
getAmount
public Amount getAmount()
Get amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
amount- Parameters:
amount-
-
applicationInfo
public PaymentCaptureRequest applicationInfo(ApplicationInfo applicationInfo)
-
getApplicationInfo
public ApplicationInfo getApplicationInfo()
Get applicationInfo- Returns:
- applicationInfo
-
setApplicationInfo
public void setApplicationInfo(ApplicationInfo applicationInfo)
applicationInfo- Parameters:
applicationInfo-
-
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)
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.- Parameters:
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)
The merchant account that is used to process the payment.- Parameters:
merchantAccount-
-
platformChargebackLogic
public PaymentCaptureRequest platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
-
getPlatformChargebackLogic
public PlatformChargebackLogic getPlatformChargebackLogic()
Get platformChargebackLogic- Returns:
- platformChargebackLogic
-
setPlatformChargebackLogic
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
platformChargebackLogic- Parameters:
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)
Your reference for the capture request. Maximum length: 80 characters.- Parameters:
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 more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/).- Returns:
- splits
-
setSplits
public void setSplits(List<Split> splits)
An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/).- Parameters:
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)
A List of sub-merchants.- Parameters:
subMerchants-
-
equals
public boolean equals(Object o)
Return true if this PaymentCaptureRequest object is equal to o.
-
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
-
-