Package io.moov.sdk.models.operations

Class InitiateRefundRequest

java.lang.Object

io.moov.sdk.models.operations.InitiateRefundRequest

public class InitiateRefundRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InitiateRefundRequest.Builder

Constructor Summary

Constructors

Constructor	Description
InitiateRefundRequest(java.lang.String xIdempotencyKey, java.lang.String accountID, java.lang.String transferID)
InitiateRefundRequest(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String xIdempotencyKey, java.util.Optional<? extends TransferWaitFor> xWaitFor, java.lang.String accountID, java.lang.String transferID, java.util.Optional<? extends CreateRefund> createRefund)

Method Summary

Modifier and Type	Method	Description
java.lang.String	accountID()	The merchant's Moov account ID.
static InitiateRefundRequest.Builder	builder()
java.util.Optional<CreateRefund>	createRefund()
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString()
java.lang.String	transferID()	Identifier for the transfer.
InitiateRefundRequest	withAccountID(java.lang.String accountID)	The merchant's Moov account ID.
InitiateRefundRequest	withCreateRefund(CreateRefund createRefund)
InitiateRefundRequest	withCreateRefund(java.util.Optional<? extends CreateRefund> createRefund)
InitiateRefundRequest	withTransferID(java.lang.String transferID)	Identifier for the transfer.
InitiateRefundRequest	withXIdempotencyKey(java.lang.String xIdempotencyKey)	Prevents duplicate refunds from being created.
InitiateRefundRequest	withXMoovVersion(java.lang.String xMoovVersion)	Specify an API version.
InitiateRefundRequest	withXMoovVersion(java.util.Optional<java.lang.String> xMoovVersion)	Specify an API version.
InitiateRefundRequest	withXWaitFor(TransferWaitFor xWaitFor)	Optional header that indicates whether to return a synchronous response that includes full transfer and rail-specific details or an asynchronous response indicating the transfer was created (this is the default response if the header is omitted).
InitiateRefundRequest	withXWaitFor(java.util.Optional<? extends TransferWaitFor> xWaitFor)	Optional header that indicates whether to return a synchronous response that includes full transfer and rail-specific details or an asynchronous response indicating the transfer was created (this is the default response if the header is omitted).
java.lang.String	xIdempotencyKey()	Prevents duplicate refunds from being created.
java.util.Optional<java.lang.String>	xMoovVersion()	Specify an API version.
java.util.Optional<TransferWaitFor>	xWaitFor()	Optional header that indicates whether to return a synchronous response that includes full transfer and rail-specific details or an asynchronous response indicating the transfer was created (this is the default response if the header is omitted).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InitiateRefundRequest

public InitiateRefundRequest(java.util.Optional<java.lang.String> xMoovVersion,
                             java.lang.String xIdempotencyKey,
                             java.util.Optional<? extends TransferWaitFor> xWaitFor,
                             java.lang.String accountID,
                             java.lang.String transferID,
                             java.util.Optional<? extends CreateRefund> createRefund)

InitiateRefundRequest

public InitiateRefundRequest(java.lang.String xIdempotencyKey,
                             java.lang.String accountID,
                             java.lang.String transferID)

Method Detail

xMoovVersion

public java.util.Optional<java.lang.String> xMoovVersion()

Specify an API version.

API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024.

The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

xIdempotencyKey

public java.lang.String xIdempotencyKey()

Prevents duplicate refunds from being created.

xWaitFor

public java.util.Optional<TransferWaitFor> xWaitFor()

Optional header that indicates whether to return a synchronous response that includes full transfer and rail-specific details or an asynchronous response indicating the transfer was created (this is the default response if the header is omitted). A timeout will occur after 15 seconds.

accountID

public java.lang.String accountID()

The merchant's Moov account ID.

transferID

public java.lang.String transferID()

Identifier for the transfer.

createRefund

public java.util.Optional<CreateRefund> createRefund()

builder

public static final InitiateRefundRequest.Builder builder()

withXMoovVersion

public InitiateRefundRequest withXMoovVersion(java.lang.String xMoovVersion)

Specify an API version.

API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024.

The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

withXMoovVersion

public InitiateRefundRequest withXMoovVersion(java.util.Optional<java.lang.String> xMoovVersion)

Specify an API version.

API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024.

The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

withXIdempotencyKey

public InitiateRefundRequest withXIdempotencyKey(java.lang.String xIdempotencyKey)

Prevents duplicate refunds from being created.

withXWaitFor

public InitiateRefundRequest withXWaitFor(TransferWaitFor xWaitFor)

Optional header that indicates whether to return a synchronous response that includes full transfer and rail-specific details or an asynchronous response indicating the transfer was created (this is the default response if the header is omitted). A timeout will occur after 15 seconds.

withXWaitFor

public InitiateRefundRequest withXWaitFor(java.util.Optional<? extends TransferWaitFor> xWaitFor)

Optional header that indicates whether to return a synchronous response that includes full transfer and rail-specific details or an asynchronous response indicating the transfer was created (this is the default response if the header is omitted). A timeout will occur after 15 seconds.

withAccountID

public InitiateRefundRequest withAccountID(java.lang.String accountID)

The merchant's Moov account ID.

withTransferID

public InitiateRefundRequest withTransferID(java.lang.String transferID)

Identifier for the transfer.

withCreateRefund

public InitiateRefundRequest withCreateRefund(CreateRefund createRefund)

withCreateRefund

public InitiateRefundRequest withCreateRefund(java.util.Optional<? extends CreateRefund> createRefund)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object