Package io.moov.sdk

Class Transfers

java.lang.Object

io.moov.sdk.Transfers

public class Transfers
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
CreateTransferRequestBuilder	create()	Move money by providing the source, destination, and amount in the request body.
CreateTransferResponse	create(java.lang.String xIdempotencyKey, java.lang.String accountID, CreateTransfer createTransfer)	Move money by providing the source, destination, and amount in the request body.
CreateTransferResponse	create(java.lang.String xIdempotencyKey, java.util.Optional<? extends TransferWaitFor> xWaitFor, java.lang.String accountID, CreateTransfer createTransfer)	Move money by providing the source, destination, and amount in the request body.
CreateCancellationRequestBuilder	createCancellation()	Initiate a cancellation for a card, ACH, or queued transfer.
CreateCancellationResponse	createCancellation(java.lang.String accountID, java.lang.String transferID)	Initiate a cancellation for a card, ACH, or queued transfer.
CreateReversalRequestBuilder	createReversal()	Reverses a card transfer by initiating a cancellation or refund depending on the transaction status.
CreateReversalResponse	createReversal(java.lang.String xIdempotencyKey, java.lang.String accountID, java.lang.String transferID)	Reverses a card transfer by initiating a cancellation or refund depending on the transaction status.
CreateReversalResponse	createReversal(java.lang.String xIdempotencyKey, java.lang.String accountID, java.lang.String transferID, java.util.Optional<? extends CreateReversal> createReversal)	Reverses a card transfer by initiating a cancellation or refund depending on the transaction status.
CreateTransferOptionsRequestBuilder	generateOptions()	Generate available payment method options for one or multiple transfer participants depending on the accountID or paymentMethodID you supply in the request body.
CreateTransferOptionsResponse	generateOptions(java.lang.String accountID, CreateTransferOptions createTransferOptions)	Generate available payment method options for one or multiple transfer participants depending on the accountID or paymentMethodID you supply in the request body.
GetTransferRequestBuilder	get()	Retrieve full transfer details for an individual transfer of a particular Moov account.
GetTransferResponse	get(java.lang.String transferID, java.lang.String accountID)	Retrieve full transfer details for an individual transfer of a particular Moov account.
GetCancellationRequestBuilder	getCancellation()	Get details of a cancellation for a transfer.
GetCancellationResponse	getCancellation(java.lang.String accountID, java.lang.String transferID, java.lang.String cancellationID)	Get details of a cancellation for a transfer.
GetRefundRequestBuilder	getRefund()	Get details of a refund for a card transfer.
GetRefundResponse	getRefund(java.lang.String transferID, java.lang.String accountID, java.lang.String refundID)	Get details of a refund for a card transfer.
InitiateRefundRequestBuilder	initiateRefund()	Initiate a refund for a card transfer.
InitiateRefundResponse	initiateRefund(InitiateRefundRequest request)	Initiate a refund for a card transfer.
ListTransfersRequestBuilder	list()	List all the transfers associated with a particular Moov account.
ListTransfersResponse	list(ListTransfersRequest request)	List all the transfers associated with a particular Moov account.
ListRefundsRequestBuilder	listRefunds()	Get a list of refunds for a card transfer.
ListRefundsResponse	listRefunds(java.lang.String accountID, java.lang.String transferID)	Get a list of refunds for a card transfer.
UpdateTransferRequestBuilder	update()	Update the metadata contained on a transfer.
UpdateTransferResponse	update(java.lang.String transferID, java.lang.String accountID, PatchTransfer patchTransfer)	Update the metadata contained on a transfer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

generateOptions

public CreateTransferOptionsRequestBuilder generateOptions()

Generate available payment method options for one or multiple transfer participants depending on the accountID or paymentMethodID you supply in the request body.

The accountID in the route should the partner's accountID.

Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Returns:

The call builder

generateOptions

public CreateTransferOptionsResponse generateOptions(java.lang.String accountID,
                                                     CreateTransferOptions createTransferOptions)
                                              throws java.lang.Exception

Generate available payment method options for one or multiple transfer participants depending on the accountID or paymentMethodID you supply in the request body.

The accountID in the route should the partner's accountID.

Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

accountID - The partner's Moov account ID.

createTransferOptions -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

create

public CreateTransferRequestBuilder create()

Move money by providing the source, destination, and amount in the request body.

Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Returns:

The call builder

create

public CreateTransferResponse create(java.lang.String xIdempotencyKey,
                                     java.lang.String accountID,
                                     CreateTransfer createTransfer)
                              throws java.lang.Exception

Move money by providing the source, destination, and amount in the request body.

Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

xIdempotencyKey - Prevents duplicate transfers from being created.

accountID - Your Moov account ID.

createTransfer -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

create

public CreateTransferResponse create(java.lang.String xIdempotencyKey,
                                     java.util.Optional<? extends TransferWaitFor> xWaitFor,
                                     java.lang.String accountID,
                                     CreateTransfer createTransfer)
                              throws java.lang.Exception

Move money by providing the source, destination, and amount in the request body.

Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

xIdempotencyKey - Prevents duplicate transfers from being created.

xWaitFor -

accountID - Your Moov account ID.

createTransfer -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListTransfersRequestBuilder list()

List all the transfers associated with a particular Moov account.

Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

When you run this request, you retrieve 200 transfers at a time. You can advance past a results set of 200 transfers by using the `skip` parameter (for example, if you set `skip`= 10, you will see a results set of 200 transfers after the first 10). If you are searching a high volume of transfers, the request will likely process very slowly. To achieve faster performance, restrict the data as much as you can by using the `StartDateTime` and `EndDateTime` parameters for a limited period of time. You can run multiple requests in smaller time window increments until you've retrieved all the transfers you need.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Returns:

The call builder

list

public ListTransfersResponse list(ListTransfersRequest request)
                           throws java.lang.Exception

List all the transfers associated with a particular Moov account.

Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

When you run this request, you retrieve 200 transfers at a time. You can advance past a results set of 200 transfers by using the `skip` parameter (for example, if you set `skip`= 10, you will see a results set of 200 transfers after the first 10). If you are searching a high volume of transfers, the request will likely process very slowly. To achieve faster performance, restrict the data as much as you can by using the `StartDateTime` and `EndDateTime` parameters for a limited period of time. You can run multiple requests in smaller time window increments until you've retrieved all the transfers you need.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetTransferRequestBuilder get()

Retrieve full transfer details for an individual transfer of a particular Moov account.

Payment rail-specific details are included in the source and destination. Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Returns:

The call builder

get

public GetTransferResponse get(java.lang.String transferID,
                               java.lang.String accountID)
                        throws java.lang.Exception

Retrieve full transfer details for an individual transfer of a particular Moov account.

Payment rail-specific details are included in the source and destination. Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Parameters:

transferID - Identifier for the transfer.

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

update

public UpdateTransferRequestBuilder update()

Update the metadata contained on a transfer.

Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Returns:

The call builder

update

public UpdateTransferResponse update(java.lang.String transferID,
                                     java.lang.String accountID,
                                     PatchTransfer patchTransfer)
                              throws java.lang.Exception

Update the metadata contained on a transfer.

Read our [transfers overview guide](https://docs.moov.io/guides/money-movement/overview/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

transferID - Identifier for the transfer.

accountID -

patchTransfer -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createCancellation

public CreateCancellationRequestBuilder createCancellation()

Initiate a cancellation for a card, ACH, or queued transfer.

To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Returns:

The call builder

createCancellation

public CreateCancellationResponse createCancellation(java.lang.String accountID,
                                                     java.lang.String transferID)
                                              throws java.lang.Exception

Initiate a cancellation for a card, ACH, or queued transfer.

To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

accountID - The partner's Moov account ID.

transferID - The transfer ID to cancel.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getCancellation

public GetCancellationRequestBuilder getCancellation()

Get details of a cancellation for a transfer.

To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Returns:

The call builder

getCancellation

public GetCancellationResponse getCancellation(java.lang.String accountID,
                                               java.lang.String transferID,
                                               java.lang.String cancellationID)
                                        throws java.lang.Exception

Get details of a cancellation for a transfer.

To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Parameters:

accountID - Moov account ID of the partner or transfer's source or destination.

transferID - Identifier for the transfer.

cancellationID - Identifier for the cancellation.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

initiateRefund

public InitiateRefundRequestBuilder initiateRefund()

Initiate a refund for a card transfer.

**Use the [Cancel or refund a card transfer](https://docs.moov.io/api/money-movement/refunds/cancel/) endpoint for more comprehensive cancel and refund options.** See the [reversals](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/) guide for more information.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Returns:

The call builder

initiateRefund

public InitiateRefundResponse initiateRefund(InitiateRefundRequest request)
                                      throws java.lang.Exception

Initiate a refund for a card transfer.

**Use the [Cancel or refund a card transfer](https://docs.moov.io/api/money-movement/refunds/cancel/) endpoint for more comprehensive cancel and refund options.** See the [reversals](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/) guide for more information.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listRefunds

public ListRefundsRequestBuilder listRefunds()

Get a list of refunds for a card transfer.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Returns:

The call builder

listRefunds

public ListRefundsResponse listRefunds(java.lang.String accountID,
                                       java.lang.String transferID)
                                throws java.lang.Exception

Get a list of refunds for a card transfer.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Parameters:

accountID -

transferID - Identifier for the transfer.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getRefund

public GetRefundRequestBuilder getRefund()

Get details of a refund for a card transfer.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Returns:

The call builder

getRefund

public GetRefundResponse getRefund(java.lang.String transferID,
                                   java.lang.String accountID,
                                   java.lang.String refundID)
                            throws java.lang.Exception

Get details of a refund for a card transfer.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Parameters:

transferID - Identifier for the transfer.

accountID -

refundID - Identifier for the refund.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createReversal

public CreateReversalRequestBuilder createReversal()

Reverses a card transfer by initiating a cancellation or refund depending on the transaction status. Read our [reversals guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/) to learn more.

To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Returns:

The call builder

createReversal

public CreateReversalResponse createReversal(java.lang.String xIdempotencyKey,
                                             java.lang.String accountID,
                                             java.lang.String transferID)
                                      throws java.lang.Exception

Reverses a card transfer by initiating a cancellation or refund depending on the transaction status. Read our [reversals guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/) to learn more.

To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

xIdempotencyKey - Prevents duplicate reversals from being created.

accountID - The Moov account ID.

transferID - The transfer ID to reverse.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createReversal

public CreateReversalResponse createReversal(java.lang.String xIdempotencyKey,
                                             java.lang.String accountID,
                                             java.lang.String transferID,
                                             java.util.Optional<? extends CreateReversal> createReversal)
                                      throws java.lang.Exception

Reverses a card transfer by initiating a cancellation or refund depending on the transaction status. Read our [reversals guide](https://docs.moov.io/guides/money-movement/accept-payments/card-acceptance/reversals/) to learn more.

To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

xIdempotencyKey - Prevents duplicate reversals from being created.

accountID - The Moov account ID.

transferID - The transfer ID to reverse.

createReversal -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails