Package io.moov.sdk

Class Receipts

java.lang.Object

io.moov.sdk.Receipts

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallCreateReceipts, SDKMethodInterfaces.MethodCallListReceipts

public class Receipts
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallCreateReceipts, SDKMethodInterfaces.MethodCallListReceipts

Method Summary

Modifier and Type	Method	Description
CreateReceiptsRequestBuilder	create()	Create receipts for transfers and scheduled transfers.
CreateReceiptsResponse	create(java.util.List<ReceiptRequest> requestBody)	Create receipts for transfers and scheduled transfers.
CreateReceiptsResponse	create(java.util.Optional<java.lang.String> xMoovVersion, java.util.List<ReceiptRequest> requestBody)	Create receipts for transfers and scheduled transfers.
ListReceiptsRequestBuilder	list()	List receipts by transferID, scheduleID, or occurrenceID.
ListReceiptsResponse	list(java.lang.String id)	List receipts by transferID, scheduleID, or occurrenceID.
ListReceiptsResponse	list(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String id)	List receipts by transferID, scheduleID, or occurrenceID.

Methods inherited from class java.lang.Object

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

Method Detail

create

public CreateReceiptsRequestBuilder create()

Create receipts for transfers and scheduled transfers.

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 CreateReceiptsResponse create(java.util.List<ReceiptRequest> requestBody)
                              throws java.lang.Exception

Create receipts for transfers and scheduled transfers.

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:

requestBody -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

create

public CreateReceiptsResponse create(java.util.Optional<java.lang.String> xMoovVersion,
                                     java.util.List<ReceiptRequest> requestBody)
                              throws java.lang.Exception

Create receipts for transfers and scheduled transfers.

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.

Specified by:

create in interface SDKMethodInterfaces.MethodCallCreateReceipts

Parameters:

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.

requestBody -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListReceiptsRequestBuilder list()

List receipts by transferID, scheduleID, or occurrenceID.

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 ListReceiptsResponse list(java.lang.String id)
                          throws java.lang.Exception

List receipts by transferID, scheduleID, or occurrenceID.

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:

id - The transfer, schedule, or transfer occurrence ID to filter receipts by.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListReceiptsResponse list(java.util.Optional<java.lang.String> xMoovVersion,
                                 java.lang.String id)
                          throws java.lang.Exception

List receipts by transferID, scheduleID, or occurrenceID.

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.

Specified by:

list in interface SDKMethodInterfaces.MethodCallListReceipts

Parameters:

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.

id - The transfer, schedule, or transfer occurrence ID to filter receipts by.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails