Class OutboundPayment
java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.moneymanagement.OutboundPayment
- All Implemented Interfaces:
HasId
,StripeObjectInterface
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
For more details about DeliveryOptions, please refer to the API Reference.static class
For more details about From, please refer to the API Reference.static class
For more details about RecipientNotification, please refer to the API Reference.static class
For more details about StatusDetails, please refer to the API Reference.static class
For more details about StatusTransitions, please refer to the API Reference.static class
For more details about To, please refer to the API Reference.static class
For more details about TraceId, please refer to the API Reference. -
Field Summary
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
The "presentment amount" for the OutboundPayment.Returns true if the OutboundPayment can be canceled, and false otherwise.Time at which the OutboundPayment was created.Delivery options to be used to send the OutboundPayment.An arbitrary string attached to the OutboundPayment.The date when funds are expected to arrive in the payout method.getFrom()
The FinancialAccount that funds were pulled from.getId()
Unique identifier for the OutboundPayment.Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.Set of key-value pairs that you can attach to an object.String representing the object's type.The quote for this OutboundPayment.A link to the Stripe-hosted receipt for this OutboundPayment.Details about the OutboundPayment notification settings for recipient.The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).Closed Enum.Status details for an OutboundPayment in afailed
orreturned
state.Hash containing timestamps of when the object transitioned to a particular status.getTo()
To which payout method the OutboundPayment was sent.A unique identifier that can be used to track this OutboundPayment with recipient bank.int
hashCode()
void
The "presentment amount" for the OutboundPayment.void
setCancelable
(Boolean cancelable) Returns true if the OutboundPayment can be canceled, and false otherwise.void
setCreated
(Instant created) Time at which the OutboundPayment was created.void
setDeliveryOptions
(OutboundPayment.DeliveryOptions deliveryOptions) Delivery options to be used to send the OutboundPayment.void
setDescription
(String description) An arbitrary string attached to the OutboundPayment.void
setExpectedArrivalDate
(Instant expectedArrivalDate) The date when funds are expected to arrive in the payout method.void
setFrom
(OutboundPayment.From from) The FinancialAccount that funds were pulled from.void
Unique identifier for the OutboundPayment.void
setLivemode
(Boolean livemode) Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMetadata
(Map<String, String> metadata) Set of key-value pairs that you can attach to an object.void
String representing the object's type.void
setOutboundPaymentQuote
(String outboundPaymentQuote) The quote for this OutboundPayment.void
setReceiptUrl
(String receiptUrl) A link to the Stripe-hosted receipt for this OutboundPayment.void
setRecipientNotification
(OutboundPayment.RecipientNotification recipientNotification) Details about the OutboundPayment notification settings for recipient.void
setStatementDescriptor
(String statementDescriptor) The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).void
Closed Enum.void
setStatusDetails
(OutboundPayment.StatusDetails statusDetails) Status details for an OutboundPayment in afailed
orreturned
state.void
setStatusTransitions
(OutboundPayment.StatusTransitions statusTransitions) Hash containing timestamps of when the object transitioned to a particular status.void
To which payout method the OutboundPayment was sent.void
setTraceId
(OutboundPayment.TraceId traceId) A unique identifier that can be used to track this OutboundPayment with recipient bank.Methods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
Constructor Details
-
OutboundPayment
public OutboundPayment()
-
-
Method Details
-
getAmount
The "presentment amount" for the OutboundPayment. -
getCancelable
Returns true if the OutboundPayment can be canceled, and false otherwise. -
getCreated
Time at which the OutboundPayment was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. -
getDeliveryOptions
Delivery options to be used to send the OutboundPayment. -
getDescription
An arbitrary string attached to the OutboundPayment. Often useful for displaying to users. -
getExpectedArrivalDate
The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in afailed
,canceled
, orreturned
state. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. -
getFrom
The FinancialAccount that funds were pulled from. -
getLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
getMetadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. -
getObject
String representing the object's type. Objects of the same type share the same value of the object field.Equal to
v2.money_management.outbound_payment
. -
getOutboundPaymentQuote
The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation. -
getReceiptUrl
A link to the Stripe-hosted receipt for this OutboundPayment. The receipt link remains active for 60 days from the OutboundPayment creation date. After this period, the link will expire and the receipt url value will be null. -
getRecipientNotification
Details about the OutboundPayment notification settings for recipient. -
getStatementDescriptor
The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). It will default toSTRIPE
if not set on the account settings. -
getStatus
Closed Enum. Current status of the OutboundPayment:processing
,failed
,posted
,returned
,canceled
. An OutboundPayment isprocessing
if it has been created and is processing. The status changes toposted
once the OutboundPayment has been "confirmed" and funds have left the account, or tofailed
orcanceled
. If an OutboundPayment fails to arrive at its payout method, its status will change toreturned
.One of
canceled
,failed
,posted
,processing
, orreturned
. -
getStatusDetails
Status details for an OutboundPayment in afailed
orreturned
state. -
getStatusTransitions
Hash containing timestamps of when the object transitioned to a particular status. -
getTo
To which payout method the OutboundPayment was sent. -
getTraceId
A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a “reference number” or something similar. -
setAmount
The "presentment amount" for the OutboundPayment. -
setCancelable
Returns true if the OutboundPayment can be canceled, and false otherwise. -
setCreated
Time at which the OutboundPayment was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. -
setDeliveryOptions
Delivery options to be used to send the OutboundPayment. -
setDescription
An arbitrary string attached to the OutboundPayment. Often useful for displaying to users. -
setExpectedArrivalDate
The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in afailed
,canceled
, orreturned
state. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. -
setFrom
The FinancialAccount that funds were pulled from. -
setId
Unique identifier for the OutboundPayment. -
setLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
setMetadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. -
setObject
String representing the object's type. Objects of the same type share the same value of the object field.Equal to
v2.money_management.outbound_payment
. -
setOutboundPaymentQuote
The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation. -
setReceiptUrl
A link to the Stripe-hosted receipt for this OutboundPayment. The receipt link remains active for 60 days from the OutboundPayment creation date. After this period, the link will expire and the receipt url value will be null. -
setRecipientNotification
Details about the OutboundPayment notification settings for recipient. -
setStatementDescriptor
The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). It will default toSTRIPE
if not set on the account settings. -
setStatus
Closed Enum. Current status of the OutboundPayment:processing
,failed
,posted
,returned
,canceled
. An OutboundPayment isprocessing
if it has been created and is processing. The status changes toposted
once the OutboundPayment has been "confirmed" and funds have left the account, or tofailed
orcanceled
. If an OutboundPayment fails to arrive at its payout method, its status will change toreturned
.One of
canceled
,failed
,posted
,processing
, orreturned
. -
setStatusDetails
Status details for an OutboundPayment in afailed
orreturned
state. -
setStatusTransitions
Hash containing timestamps of when the object transitioned to a particular status. -
setTo
To which payout method the OutboundPayment was sent. -
setTraceId
A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a “reference number” or something similar. -
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the OutboundPayment.
-