Package com.plaid.client.model
Class PaymentInitiationPayment
java.lang.Object
com.plaid.client.model.PaymentInitiationPayment
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2021-10-15T19:47:39.714Z[GMT]")
public class PaymentInitiationPayment
extends java.lang.Object
PaymentInitiationPayment defines a payment initiation payment
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PaymentInitiationPayment.StatusEnum
The status of the payment. -
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SERIALIZED_NAME_ADJUSTED_REFERENCE
static java.lang.String
SERIALIZED_NAME_AMOUNT
static java.lang.String
SERIALIZED_NAME_BACS
static java.lang.String
SERIALIZED_NAME_EMI_ACCOUNT_ID
static java.lang.String
SERIALIZED_NAME_IBAN
static java.lang.String
SERIALIZED_NAME_INITIATED_REFUNDS
static java.lang.String
SERIALIZED_NAME_LAST_STATUS_UPDATE
static java.lang.String
SERIALIZED_NAME_PAYMENT_ID
static java.lang.String
SERIALIZED_NAME_RECIPIENT_ID
static java.lang.String
SERIALIZED_NAME_REFERENCE
static java.lang.String
SERIALIZED_NAME_REFUND_DETAILS
static java.lang.String
SERIALIZED_NAME_SCHEDULE
static java.lang.String
SERIALIZED_NAME_STATUS
-
Constructor Summary
Constructors Constructor Description PaymentInitiationPayment()
-
Method Summary
Modifier and Type Method Description PaymentInitiationPayment
addInitiatedRefundsItem(PaymentInitiationRefund initiatedRefundsItem)
PaymentInitiationPayment
adjustedReference(java.lang.String adjustedReference)
PaymentInitiationPayment
amount(PaymentAmount amount)
PaymentInitiationPayment
bacs(SenderBACSNullable bacs)
PaymentInitiationPayment
emiAccountId(java.lang.String emiAccountId)
boolean
equals(java.lang.Object o)
java.lang.String
getAdjustedReference()
The value of the reference sent to the bank after adjustment to pass bank validation rules.PaymentAmount
getAmount()
Get amountSenderBACSNullable
getBacs()
Get bacsjava.lang.String
getEmiAccountId()
The EMI (E-Money Institution) account that this payment is associated with, if any.java.lang.String
getIban()
The International Bank Account Number (IBAN) for the sender, if specified in the `/payment_initiation/payment/create` call.java.util.List<PaymentInitiationRefund>
getInitiatedRefunds()
Initiated refunds associated with the payment.java.time.OffsetDateTime
getLastStatusUpdate()
The date and time of the last time the `status` was updated, in IS0 8601 formatjava.lang.String
getPaymentId()
The ID of the payment.java.lang.String
getRecipientId()
The ID of the recipientjava.lang.String
getReference()
A reference for the payment.ExternalPaymentRefundDetails
getRefundDetails()
Get refundDetailsExternalPaymentScheduleGet
getSchedule()
Get schedulePaymentInitiationPayment.StatusEnum
getStatus()
The status of the payment.int
hashCode()
PaymentInitiationPayment
iban(java.lang.String iban)
PaymentInitiationPayment
initiatedRefunds(java.util.List<PaymentInitiationRefund> initiatedRefunds)
PaymentInitiationPayment
lastStatusUpdate(java.time.OffsetDateTime lastStatusUpdate)
PaymentInitiationPayment
paymentId(java.lang.String paymentId)
PaymentInitiationPayment
recipientId(java.lang.String recipientId)
PaymentInitiationPayment
reference(java.lang.String reference)
PaymentInitiationPayment
refundDetails(ExternalPaymentRefundDetails refundDetails)
PaymentInitiationPayment
schedule(ExternalPaymentScheduleGet schedule)
void
setAdjustedReference(java.lang.String adjustedReference)
void
setAmount(PaymentAmount amount)
void
setBacs(SenderBACSNullable bacs)
void
setEmiAccountId(java.lang.String emiAccountId)
void
setIban(java.lang.String iban)
void
setInitiatedRefunds(java.util.List<PaymentInitiationRefund> initiatedRefunds)
void
setLastStatusUpdate(java.time.OffsetDateTime lastStatusUpdate)
void
setPaymentId(java.lang.String paymentId)
void
setRecipientId(java.lang.String recipientId)
void
setReference(java.lang.String reference)
void
setRefundDetails(ExternalPaymentRefundDetails refundDetails)
void
setSchedule(ExternalPaymentScheduleGet schedule)
void
setStatus(PaymentInitiationPayment.StatusEnum status)
PaymentInitiationPayment
status(PaymentInitiationPayment.StatusEnum status)
java.lang.String
toString()
-
Field Details
-
SERIALIZED_NAME_PAYMENT_ID
public static final java.lang.String SERIALIZED_NAME_PAYMENT_ID- See Also:
- Constant Field Values
-
SERIALIZED_NAME_AMOUNT
public static final java.lang.String SERIALIZED_NAME_AMOUNT- See Also:
- Constant Field Values
-
SERIALIZED_NAME_STATUS
public static final java.lang.String SERIALIZED_NAME_STATUS- See Also:
- Constant Field Values
-
SERIALIZED_NAME_RECIPIENT_ID
public static final java.lang.String SERIALIZED_NAME_RECIPIENT_ID- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REFERENCE
public static final java.lang.String SERIALIZED_NAME_REFERENCE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ADJUSTED_REFERENCE
public static final java.lang.String SERIALIZED_NAME_ADJUSTED_REFERENCE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LAST_STATUS_UPDATE
public static final java.lang.String SERIALIZED_NAME_LAST_STATUS_UPDATE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SCHEDULE
public static final java.lang.String SERIALIZED_NAME_SCHEDULE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REFUND_DETAILS
public static final java.lang.String SERIALIZED_NAME_REFUND_DETAILS- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BACS
public static final java.lang.String SERIALIZED_NAME_BACS- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IBAN
public static final java.lang.String SERIALIZED_NAME_IBAN- See Also:
- Constant Field Values
-
SERIALIZED_NAME_INITIATED_REFUNDS
public static final java.lang.String SERIALIZED_NAME_INITIATED_REFUNDS- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EMI_ACCOUNT_ID
public static final java.lang.String SERIALIZED_NAME_EMI_ACCOUNT_ID- See Also:
- Constant Field Values
-
-
Constructor Details
-
PaymentInitiationPayment
public PaymentInitiationPayment()
-
-
Method Details
-
paymentId
-
getPaymentId
public java.lang.String getPaymentId()The ID of the payment. Like all Plaid identifiers, the `payment_id` is case sensitive.- Returns:
- paymentId
-
setPaymentId
public void setPaymentId(java.lang.String paymentId) -
amount
-
getAmount
Get amount- Returns:
- amount
-
setAmount
-
status
-
getStatus
The status of the payment. `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed. `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete. `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete. `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders. `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds. `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved. `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error. `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.- Returns:
- status
-
setStatus
-
recipientId
-
getRecipientId
public java.lang.String getRecipientId()The ID of the recipient- Returns:
- recipientId
-
setRecipientId
public void setRecipientId(java.lang.String recipientId) -
reference
-
getReference
public java.lang.String getReference()A reference for the payment.- Returns:
- reference
-
setReference
public void setReference(java.lang.String reference) -
adjustedReference
-
getAdjustedReference
@Nullable public java.lang.String getAdjustedReference()The value of the reference sent to the bank after adjustment to pass bank validation rules.- Returns:
- adjustedReference
-
setAdjustedReference
public void setAdjustedReference(java.lang.String adjustedReference) -
lastStatusUpdate
-
getLastStatusUpdate
public java.time.OffsetDateTime getLastStatusUpdate()The date and time of the last time the `status` was updated, in IS0 8601 format- Returns:
- lastStatusUpdate
-
setLastStatusUpdate
public void setLastStatusUpdate(java.time.OffsetDateTime lastStatusUpdate) -
schedule
-
getSchedule
Get schedule- Returns:
- schedule
-
setSchedule
-
refundDetails
-
getRefundDetails
Get refundDetails- Returns:
- refundDetails
-
setRefundDetails
-
bacs
-
getBacs
Get bacs- Returns:
- bacs
-
setBacs
-
iban
-
getIban
@Nullable public java.lang.String getIban()The International Bank Account Number (IBAN) for the sender, if specified in the `/payment_initiation/payment/create` call.- Returns:
- iban
-
setIban
public void setIban(java.lang.String iban) -
initiatedRefunds
public PaymentInitiationPayment initiatedRefunds(java.util.List<PaymentInitiationRefund> initiatedRefunds) -
addInitiatedRefundsItem
public PaymentInitiationPayment addInitiatedRefundsItem(PaymentInitiationRefund initiatedRefundsItem) -
getInitiatedRefunds
Initiated refunds associated with the payment.- Returns:
- initiatedRefunds
-
setInitiatedRefunds
-
emiAccountId
-
getEmiAccountId
@Nullable public java.lang.String getEmiAccountId()The EMI (E-Money Institution) account that this payment is associated with, if any. This EMI account is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.- Returns:
- emiAccountId
-
setEmiAccountId
public void setEmiAccountId(java.lang.String emiAccountId) -
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-