java.lang.Object
- com.adyen.model.checkout.PaymentCaptureResponse

public class PaymentCaptureResponse
extends Object

PaymentCaptureResponse

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PaymentCaptureResponse.StatusEnum
The status of your request.

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_PAYMENT_PSP_REFERENCE`
`static String`	`JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC`
`static String`	`JSON_PROPERTY_PSP_REFERENCE`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_SPLITS`
`static String`	`JSON_PROPERTY_STATUS`
`static String`	`JSON_PROPERTY_SUB_MERCHANTS`

Constructor Summary

Constructors
Constructor Description

PaymentCaptureResponse()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentCaptureResponse`	`addLineItemsItem(LineItem lineItemsItem)`
`PaymentCaptureResponse`	`addSplitsItem(Split splitsItem)`
`PaymentCaptureResponse`	`addSubMerchantsItem(SubMerchantInfo subMerchantsItem)`
`PaymentCaptureResponse`	`amount(Amount amount)`
`boolean`	`equals(Object o)`	Return true if this PaymentCaptureResponse object is equal to o.
`static PaymentCaptureResponse`	`fromJson(String jsonString)`	Create an instance of PaymentCaptureResponse 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.
`String`	`getPaymentPspReference()`	The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to capture.
`PlatformChargebackLogic`	`getPlatformChargebackLogic()`	Get platformChargebackLogic
`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.
`PaymentCaptureResponse.StatusEnum`	`getStatus()`	The status of your request.
`List<SubMerchantInfo>`	`getSubMerchants()`	List of sub-merchants.
`int`	`hashCode()`
`PaymentCaptureResponse`	`lineItems(List<LineItem> lineItems)`
`PaymentCaptureResponse`	`merchantAccount(String merchantAccount)`
`PaymentCaptureResponse`	`paymentPspReference(String paymentPspReference)`
`PaymentCaptureResponse`	`platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)`
`PaymentCaptureResponse`	`pspReference(String pspReference)`
`PaymentCaptureResponse`	`reference(String reference)`
`void`	`setAmount(Amount amount)`	amount
`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).
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account that is used to process the payment.
`void`	`setPaymentPspReference(String paymentPspReference)`	The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to capture.
`void`	`setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)`	platformChargebackLogic
`void`	`setPspReference(String pspReference)`	Adyen's 16-character reference associated with the capture request.
`void`	`setReference(String reference)`	Your reference for the capture request.
`void`	`setSplits(List<Split> splits)`	An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms.
`void`	`setStatus(PaymentCaptureResponse.StatusEnum status)`	The status of your request.
`void`	`setSubMerchants(List<SubMerchantInfo> subMerchants)`	List of sub-merchants.
`PaymentCaptureResponse`	`splits(List<Split> splits)`
`PaymentCaptureResponse`	`status(PaymentCaptureResponse.StatusEnum status)`
`PaymentCaptureResponse`	`subMerchants(List<SubMerchantInfo> subMerchants)`
`String`	`toJson()`	Convert an instance of PaymentCaptureResponse 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_PAYMENT_PSP_REFERENCE
```
public static final String JSON_PROPERTY_PAYMENT_PSP_REFERENCE
```
    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_PSP_REFERENCE
```
public static final String JSON_PROPERTY_PSP_REFERENCE
```
    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_STATUS
```
public static final String JSON_PROPERTY_STATUS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SUB_MERCHANTS
```
public static final String JSON_PROPERTY_SUB_MERCHANTS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaymentCaptureResponse
```
public PaymentCaptureResponse()
```
- Method Detail
  - amount
```
public PaymentCaptureResponse amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - lineItems
```
public PaymentCaptureResponse lineItems(List<LineItem> lineItems)
```
  - addLineItemsItem
```
public PaymentCaptureResponse 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 PaymentCaptureResponse 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 -
  - paymentPspReference
```
public PaymentCaptureResponse 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)
```
    The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to capture.
    
    Parameters:
    
    paymentPspReference -
  - platformChargebackLogic
```
public PaymentCaptureResponse platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
  - getPlatformChargebackLogic
```
public PlatformChargebackLogic getPlatformChargebackLogic()
```
    Get platformChargebackLogic
    
    Returns:
    
    platformChargebackLogic
  - setPlatformChargebackLogic
```
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
    platformChargebackLogic
    
    Parameters:
    
    platformChargebackLogic -
  - pspReference
```
public PaymentCaptureResponse 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)
```
    Adyen's 16-character reference associated with the capture request.
    
    Parameters:
    
    pspReference -
  - reference
```
public PaymentCaptureResponse reference(String reference)
```
  - getReference
```
public String getReference()
```
    Your reference for the capture request.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
    Your reference for the capture request.
    
    Parameters:
    
    reference -
  - splits
```
public PaymentCaptureResponse splits(List<Split> splits)
```
  - addSplitsItem
```
public PaymentCaptureResponse 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 -
  - status
```
public PaymentCaptureResponse status(PaymentCaptureResponse.StatusEnum status)
```
  - getStatus
```
public PaymentCaptureResponse.StatusEnum getStatus()
```
    The status of your request. This will always have the value **received**.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(PaymentCaptureResponse.StatusEnum status)
```
    The status of your request. This will always have the value **received**.
    
    Parameters:
    
    status -
  - subMerchants
```
public PaymentCaptureResponse subMerchants(List<SubMerchantInfo> subMerchants)
```
  - addSubMerchantsItem
```
public PaymentCaptureResponse addSubMerchantsItem(SubMerchantInfo subMerchantsItem)
```
  - getSubMerchants
```
public List<SubMerchantInfo> getSubMerchants()
```
    List of sub-merchants.
    
    Returns:
    
    subMerchants
  - setSubMerchants
```
public void setSubMerchants(List<SubMerchantInfo> subMerchants)
```
    List of sub-merchants.
    
    Parameters:
    
    subMerchants -
  - equals
```
public boolean equals(Object o)
```
    Return true if this PaymentCaptureResponse 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 PaymentCaptureResponse fromJson(String jsonString)
                                       throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of PaymentCaptureResponse given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentCaptureResponse
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentCaptureResponse
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of PaymentCaptureResponse to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class PaymentCaptureResponse

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_LINE_ITEMS

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_PAYMENT_PSP_REFERENCE

JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC

JSON_PROPERTY_PSP_REFERENCE

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_SPLITS

JSON_PROPERTY_STATUS

JSON_PROPERTY_SUB_MERCHANTS

Constructor Detail

PaymentCaptureResponse

Method Detail

amount

getAmount

setAmount

lineItems

addLineItemsItem

getLineItems

setLineItems

merchantAccount

getMerchantAccount

setMerchantAccount

paymentPspReference

getPaymentPspReference

setPaymentPspReference

platformChargebackLogic

getPlatformChargebackLogic

setPlatformChargebackLogic

pspReference

getPspReference

setPspReference

reference

getReference

setReference

splits

addSplitsItem

getSplits

setSplits

status

getStatus

setStatus

subMerchants

addSubMerchantsItem

getSubMerchants

setSubMerchants

equals

hashCode

toString

fromJson

toJson