PaymentStatusUpdateWebhook (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.PaymentStatusUpdateWebhook

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class PaymentStatusUpdateWebhook
extends Object

Fired when the status of a payment has changed.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ADJUSTED_REFERENCE`
`static String`	`SERIALIZED_NAME_ADJUSTED_START_DATE`
`static String`	`SERIALIZED_NAME_ENVIRONMENT`
`static String`	`SERIALIZED_NAME_ERROR`
`static String`	`SERIALIZED_NAME_NEW_PAYMENT_STATUS`
`static String`	`SERIALIZED_NAME_OLD_PAYMENT_STATUS`
`static String`	`SERIALIZED_NAME_ORIGINAL_REFERENCE`
`static String`	`SERIALIZED_NAME_ORIGINAL_START_DATE`
`static String`	`SERIALIZED_NAME_PAYMENT_ID`
`static String`	`SERIALIZED_NAME_TIMESTAMP`
`static String`	`SERIALIZED_NAME_TRANSACTION_ID`
`static String`	`SERIALIZED_NAME_WEBHOOK_CODE`
`static String`	`SERIALIZED_NAME_WEBHOOK_TYPE`

Constructor Summary

Constructors
Constructor and Description

PaymentStatusUpdateWebhook()

Constructors
Constructor and Description
`PaymentStatusUpdateWebhook()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PaymentStatusUpdateWebhook`	`adjustedReference(String adjustedReference)`
`PaymentStatusUpdateWebhook`	`adjustedStartDate(LocalDate adjustedStartDate)`
`PaymentStatusUpdateWebhook`	`environment(WebhookEnvironmentValues environment)`
`boolean`	`equals(Object o)`
`PaymentStatusUpdateWebhook`	`error(PlaidError error)`
`String`	`getAdjustedReference()` The value of the reference sent to the bank after adjustment to pass bank validation rules.
`LocalDate`	`getAdjustedStartDate()` The start date sent to the bank after adjusting for holidays or weekends.
`WebhookEnvironmentValues`	`getEnvironment()` Get environment
`PlaidError`	`getError()` Get error
`PaymentInitiationPaymentStatus`	`getNewPaymentStatus()` Get newPaymentStatus
`PaymentInitiationPaymentStatus`	`getOldPaymentStatus()` Get oldPaymentStatus
`String`	`getOriginalReference()` The original value of the reference when creating the payment.
`LocalDate`	`getOriginalStartDate()` The original value of the `start_date` provided during the creation of a standing order.
`String`	`getPaymentId()` The `payment_id` for the payment being updated
`OffsetDateTime`	`getTimestamp()` The timestamp of the update, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g.
`String`	`getTransactionId()` The transaction ID that this payment is associated with, if any.
`String`	`getWebhookCode()` `PAYMENT_STATUS_UPDATE`
`String`	`getWebhookType()` `PAYMENT_INITIATION`
`int`	`hashCode()`
`PaymentStatusUpdateWebhook`	`newPaymentStatus(PaymentInitiationPaymentStatus newPaymentStatus)`
`PaymentStatusUpdateWebhook`	`oldPaymentStatus(PaymentInitiationPaymentStatus oldPaymentStatus)`
`PaymentStatusUpdateWebhook`	`originalReference(String originalReference)`
`PaymentStatusUpdateWebhook`	`originalStartDate(LocalDate originalStartDate)`
`PaymentStatusUpdateWebhook`	`paymentId(String paymentId)`
`void`	`setAdjustedReference(String adjustedReference)`
`void`	`setAdjustedStartDate(LocalDate adjustedStartDate)`
`void`	`setEnvironment(WebhookEnvironmentValues environment)`
`void`	`setError(PlaidError error)`
`void`	`setNewPaymentStatus(PaymentInitiationPaymentStatus newPaymentStatus)`
`void`	`setOldPaymentStatus(PaymentInitiationPaymentStatus oldPaymentStatus)`
`void`	`setOriginalReference(String originalReference)`
`void`	`setOriginalStartDate(LocalDate originalStartDate)`
`void`	`setPaymentId(String paymentId)`
`void`	`setTimestamp(OffsetDateTime timestamp)`
`void`	`setTransactionId(String transactionId)`
`void`	`setWebhookCode(String webhookCode)`
`void`	`setWebhookType(String webhookType)`
`PaymentStatusUpdateWebhook`	`timestamp(OffsetDateTime timestamp)`
`String`	`toString()`
`PaymentStatusUpdateWebhook`	`transactionId(String transactionId)`
`PaymentStatusUpdateWebhook`	`webhookCode(String webhookCode)`
`PaymentStatusUpdateWebhook`	`webhookType(String webhookType)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_WEBHOOK_TYPE

public static final String SERIALIZED_NAME_WEBHOOK_TYPE

See Also:: Constant Field Values

SERIALIZED_NAME_WEBHOOK_CODE

public static final String SERIALIZED_NAME_WEBHOOK_CODE

See Also:: Constant Field Values

SERIALIZED_NAME_PAYMENT_ID

public static final String SERIALIZED_NAME_PAYMENT_ID

See Also:: Constant Field Values

SERIALIZED_NAME_TRANSACTION_ID

public static final String SERIALIZED_NAME_TRANSACTION_ID

See Also:: Constant Field Values

SERIALIZED_NAME_NEW_PAYMENT_STATUS

public static final String SERIALIZED_NAME_NEW_PAYMENT_STATUS

See Also:: Constant Field Values

SERIALIZED_NAME_OLD_PAYMENT_STATUS

public static final String SERIALIZED_NAME_OLD_PAYMENT_STATUS

See Also:: Constant Field Values

SERIALIZED_NAME_ORIGINAL_REFERENCE

public static final String SERIALIZED_NAME_ORIGINAL_REFERENCE

See Also:: Constant Field Values

SERIALIZED_NAME_ADJUSTED_REFERENCE

public static final String SERIALIZED_NAME_ADJUSTED_REFERENCE

See Also:: Constant Field Values

SERIALIZED_NAME_ORIGINAL_START_DATE

public static final String SERIALIZED_NAME_ORIGINAL_START_DATE

See Also:: Constant Field Values

SERIALIZED_NAME_ADJUSTED_START_DATE

public static final String SERIALIZED_NAME_ADJUSTED_START_DATE

See Also:: Constant Field Values

SERIALIZED_NAME_TIMESTAMP

public static final String SERIALIZED_NAME_TIMESTAMP

See Also:: Constant Field Values

SERIALIZED_NAME_ERROR

public static final String SERIALIZED_NAME_ERROR

See Also:: Constant Field Values

SERIALIZED_NAME_ENVIRONMENT

public static final String SERIALIZED_NAME_ENVIRONMENT

See Also:: Constant Field Values

Constructor Detail
- PaymentStatusUpdateWebhook
```
public PaymentStatusUpdateWebhook()
```

Method Detail

webhookType

public PaymentStatusUpdateWebhook webhookType(String webhookType)

getWebhookType
```
public String getWebhookType()
```
`PAYMENT_INITIATION`

Returns:

webhookType

setWebhookType

public void setWebhookType(String webhookType)

webhookCode

public PaymentStatusUpdateWebhook webhookCode(String webhookCode)

getWebhookCode
```
public String getWebhookCode()
```
`PAYMENT_STATUS_UPDATE`

Returns:

webhookCode

setWebhookCode

public void setWebhookCode(String webhookCode)

paymentId

public PaymentStatusUpdateWebhook paymentId(String paymentId)

getPaymentId
```
public String getPaymentId()
```
The `payment_id` for the payment being updated

Returns:

paymentId

setPaymentId

public void setPaymentId(String paymentId)

transactionId

public PaymentStatusUpdateWebhook transactionId(String transactionId)

getTransactionId
```
@Nullable
public String getTransactionId()
```
The transaction ID that this payment is associated with, if any. This is present only when a payment was initiated using virtual accounts.

Returns:

transactionId

setTransactionId

public void setTransactionId(String transactionId)

newPaymentStatus

public PaymentStatusUpdateWebhook newPaymentStatus(PaymentInitiationPaymentStatus newPaymentStatus)

getNewPaymentStatus

public PaymentInitiationPaymentStatus getNewPaymentStatus()

Get newPaymentStatus

Returns:: newPaymentStatus

setNewPaymentStatus

public void setNewPaymentStatus(PaymentInitiationPaymentStatus newPaymentStatus)

oldPaymentStatus

public PaymentStatusUpdateWebhook oldPaymentStatus(PaymentInitiationPaymentStatus oldPaymentStatus)

getOldPaymentStatus

public PaymentInitiationPaymentStatus getOldPaymentStatus()

Get oldPaymentStatus

Returns:: oldPaymentStatus

setOldPaymentStatus

public void setOldPaymentStatus(PaymentInitiationPaymentStatus oldPaymentStatus)

originalReference

public PaymentStatusUpdateWebhook originalReference(String originalReference)

getOriginalReference
```
@Nullable
public String getOriginalReference()
```
The original value of the reference when creating the payment.

Returns:

originalReference

setOriginalReference

public void setOriginalReference(String originalReference)

adjustedReference

public PaymentStatusUpdateWebhook adjustedReference(String adjustedReference)

getAdjustedReference
```
@Nullable
public String getAdjustedReference()
```
The value of the reference sent to the bank after adjustment to pass bank validation rules.

Returns:

adjustedReference

setAdjustedReference

public void setAdjustedReference(String adjustedReference)

originalStartDate

public PaymentStatusUpdateWebhook originalStartDate(LocalDate originalStartDate)

getOriginalStartDate
```
@Nullable
public LocalDate getOriginalStartDate()
```
The original value of the `start_date` provided during the creation of a standing order. If the payment is not a standing order, this field will be `null`.

Returns:

originalStartDate

setOriginalStartDate

public void setOriginalStartDate(LocalDate originalStartDate)

adjustedStartDate

public PaymentStatusUpdateWebhook adjustedStartDate(LocalDate adjustedStartDate)

getAdjustedStartDate
```
@Nullable
public LocalDate getAdjustedStartDate()
```
The start date sent to the bank after adjusting for holidays or weekends. Will be provided in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). If the start date did not require adjustment, or if the payment is not a standing order, this field will be `null`.

Returns:

adjustedStartDate

setAdjustedStartDate

public void setAdjustedStartDate(LocalDate adjustedStartDate)

timestamp

public PaymentStatusUpdateWebhook timestamp(OffsetDateTime timestamp)

getTimestamp
```
public OffsetDateTime getTimestamp()
```
The timestamp of the update, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g. `\"2017-09-14T14:42:19.350Z\"`

Returns:

timestamp

setTimestamp

public void setTimestamp(OffsetDateTime timestamp)

error

public PaymentStatusUpdateWebhook error(PlaidError error)

getError

@Nullable
public PlaidError getError()

Get error

Returns:: error

setError

public void setError(PlaidError error)

environment

public PaymentStatusUpdateWebhook environment(WebhookEnvironmentValues environment)

getEnvironment

public WebhookEnvironmentValues getEnvironment()

Get environment

Returns:: environment

setEnvironment

public void setEnvironment(WebhookEnvironmentValues environment)

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

Class PaymentStatusUpdateWebhook

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_WEBHOOK_TYPE

SERIALIZED_NAME_WEBHOOK_CODE

SERIALIZED_NAME_PAYMENT_ID

SERIALIZED_NAME_TRANSACTION_ID

SERIALIZED_NAME_NEW_PAYMENT_STATUS

SERIALIZED_NAME_OLD_PAYMENT_STATUS

SERIALIZED_NAME_ORIGINAL_REFERENCE

SERIALIZED_NAME_ADJUSTED_REFERENCE

SERIALIZED_NAME_ORIGINAL_START_DATE

SERIALIZED_NAME_ADJUSTED_START_DATE

SERIALIZED_NAME_TIMESTAMP

SERIALIZED_NAME_ERROR

SERIALIZED_NAME_ENVIRONMENT

Constructor Detail

PaymentStatusUpdateWebhook

Method Detail

webhookType

getWebhookType

setWebhookType

webhookCode

getWebhookCode

setWebhookCode

paymentId

getPaymentId

setPaymentId

transactionId

getTransactionId

setTransactionId

newPaymentStatus

getNewPaymentStatus

setNewPaymentStatus

oldPaymentStatus

getOldPaymentStatus

setOldPaymentStatus

originalReference

getOriginalReference

setOriginalReference

adjustedReference

getAdjustedReference

setAdjustedReference

originalStartDate

getOriginalStartDate

setOriginalStartDate

adjustedStartDate

getAdjustedStartDate

setAdjustedStartDate

timestamp

getTimestamp

setTimestamp

error

getError

setError

environment

getEnvironment

setEnvironment

equals

hashCode

toString