Class BookTransferResponse
-
- All Implemented Interfaces:
public final class BookTransferResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBookTransferResponse.BuilderA builder for BookTransferResponse.
public final classBookTransferResponse.BookTransferCategoryCategory of the book transfer
public final classBookTransferResponse.BookTransferEventBook transfer Event
public final classBookTransferResponse.TransactionResultpublic final classBookTransferResponse.StatusStatus types:
DECLINED- The transfer was declined.REVERSED- The transfer was reversedSETTLED- The transfer is completed.
public final classBookTransferResponse.TransactionSeriesA series of transactions that are grouped together.
-
Method Summary
Modifier and Type Method Description final Stringtoken()Customer-provided token that will serve as an idempotency token. final BookTransferResponse.BookTransferCategorycategory()Category of the book transfer final OffsetDateTimecreated()Date and time when the transfer occurred. final Stringcurrency()3-character alphabetic ISO 4217 code for the settling currency of the transaction. final List<BookTransferResponse.BookTransferEvent>events()A list of all financial events that have modified this transfer. final Optional<String>externalId()External ID defined by the customer final Optional<ExternalResource>externalResource()External resource associated with the management operation final StringfromFinancialAccountToken()Globally unique identifier for the financial account or card that will send the funds. final LongpendingAmount()Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees. final BookTransferResponse.TransactionResultresult()final LongsettledAmount()Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents). final BookTransferResponse.Statusstatus()Status types: DECLINED- The transfer was declined.REVERSED- The transfer was reversedSETTLED- The transfer is completed.
final StringtoFinancialAccountToken()Globally unique identifier for the financial account or card that will receive the funds. final Optional<BookTransferResponse.TransactionSeries>transactionSeries()A series of transactions that are grouped together. final OffsetDateTimeupdated()Date and time when the financial transaction was last updated. final JsonField<String>_token()Returns the raw JSON value of token. final JsonField<BookTransferResponse.BookTransferCategory>_category()Returns the raw JSON value of category. final JsonField<OffsetDateTime>_created()Returns the raw JSON value of created. final JsonField<String>_currency()Returns the raw JSON value of currency. final JsonField<List<BookTransferResponse.BookTransferEvent>>_events()Returns the raw JSON value of events. final JsonField<String>_externalId()Returns the raw JSON value of externalId. final JsonField<ExternalResource>_externalResource()Returns the raw JSON value of externalResource. final JsonField<String>_fromFinancialAccountToken()Returns the raw JSON value of fromFinancialAccountToken. final JsonField<Long>_pendingAmount()Returns the raw JSON value of pendingAmount. final JsonField<BookTransferResponse.TransactionResult>_result()Returns the raw JSON value of result. final JsonField<Long>_settledAmount()Returns the raw JSON value of settledAmount. final JsonField<BookTransferResponse.Status>_status()Returns the raw JSON value of status. final JsonField<String>_toFinancialAccountToken()Returns the raw JSON value of toFinancialAccountToken. final JsonField<BookTransferResponse.TransactionSeries>_transactionSeries()Returns the raw JSON value of transactionSeries. final JsonField<OffsetDateTime>_updated()Returns the raw JSON value of updated. final Map<String, JsonValue>_additionalProperties()final BookTransferResponse.BuildertoBuilder()final BookTransferResponsevalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BookTransferResponse.Builderbuilder()Returns a mutable builder for constructing an instance of BookTransferResponse. -
-
Method Detail
-
token
final String token()
Customer-provided token that will serve as an idempotency token. This token will become the transaction token.
-
category
final BookTransferResponse.BookTransferCategory category()
Category of the book transfer
-
created
final OffsetDateTime created()
Date and time when the transfer occurred. UTC time zone.
-
currency
final String currency()
3-character alphabetic ISO 4217 code for the settling currency of the transaction.
-
events
final List<BookTransferResponse.BookTransferEvent> events()
A list of all financial events that have modified this transfer.
-
externalId
final Optional<String> externalId()
External ID defined by the customer
-
externalResource
final Optional<ExternalResource> externalResource()
External resource associated with the management operation
-
fromFinancialAccountToken
final String fromFinancialAccountToken()
Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case.
-
pendingAmount
final Long pendingAmount()
Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees.
The value of this field will go to zero over time once the financial transaction is settled.
-
result
final BookTransferResponse.TransactionResult result()
-
settledAmount
final Long settledAmount()
Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents).
-
status
final BookTransferResponse.Status status()
Status types:
DECLINED- The transfer was declined.REVERSED- The transfer was reversedSETTLED- The transfer is completed.
-
toFinancialAccountToken
final String toFinancialAccountToken()
Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program's use case.
-
transactionSeries
final Optional<BookTransferResponse.TransactionSeries> transactionSeries()
A series of transactions that are grouped together.
-
updated
final OffsetDateTime updated()
Date and time when the financial transaction was last updated. UTC time zone.
-
_token
final JsonField<String> _token()
Returns the raw JSON value of token.
Unlike token, this method doesn't throw if the JSON field has an unexpected type.
-
_category
final JsonField<BookTransferResponse.BookTransferCategory> _category()
Returns the raw JSON value of category.
Unlike category, this method doesn't throw if the JSON field has an unexpected type.
-
_created
final JsonField<OffsetDateTime> _created()
Returns the raw JSON value of created.
Unlike created, this method doesn't throw if the JSON field has an unexpected type.
-
_currency
final JsonField<String> _currency()
Returns the raw JSON value of currency.
Unlike currency, this method doesn't throw if the JSON field has an unexpected type.
-
_events
final JsonField<List<BookTransferResponse.BookTransferEvent>> _events()
Returns the raw JSON value of events.
Unlike events, this method doesn't throw if the JSON field has an unexpected type.
-
_externalId
final JsonField<String> _externalId()
Returns the raw JSON value of externalId.
Unlike externalId, this method doesn't throw if the JSON field has an unexpected type.
-
_externalResource
final JsonField<ExternalResource> _externalResource()
Returns the raw JSON value of externalResource.
Unlike externalResource, this method doesn't throw if the JSON field has an unexpected type.
-
_fromFinancialAccountToken
final JsonField<String> _fromFinancialAccountToken()
Returns the raw JSON value of fromFinancialAccountToken.
Unlike fromFinancialAccountToken, this method doesn't throw if the JSON field has an unexpected type.
-
_pendingAmount
final JsonField<Long> _pendingAmount()
Returns the raw JSON value of pendingAmount.
Unlike pendingAmount, this method doesn't throw if the JSON field has an unexpected type.
-
_result
final JsonField<BookTransferResponse.TransactionResult> _result()
Returns the raw JSON value of result.
Unlike result, this method doesn't throw if the JSON field has an unexpected type.
-
_settledAmount
final JsonField<Long> _settledAmount()
Returns the raw JSON value of settledAmount.
Unlike settledAmount, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<BookTransferResponse.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_toFinancialAccountToken
final JsonField<String> _toFinancialAccountToken()
Returns the raw JSON value of toFinancialAccountToken.
Unlike toFinancialAccountToken, this method doesn't throw if the JSON field has an unexpected type.
-
_transactionSeries
final JsonField<BookTransferResponse.TransactionSeries> _transactionSeries()
Returns the raw JSON value of transactionSeries.
Unlike transactionSeries, this method doesn't throw if the JSON field has an unexpected type.
-
_updated
final JsonField<OffsetDateTime> _updated()
Returns the raw JSON value of updated.
Unlike updated, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BookTransferResponse.Builder toBuilder()
-
validate
final BookTransferResponse validate()
-
builder
final static BookTransferResponse.Builder builder()
Returns a mutable builder for constructing an instance of BookTransferResponse.
The following fields are required:
.token() .category() .created() .currency() .events() .externalId() .externalResource() .fromFinancialAccountToken() .pendingAmount() .result() .settledAmount() .status() .toFinancialAccountToken() .transactionSeries() .updated()
-
-
-