README.md

Receipts

(receipts())

Overview

Available Operations

• create - Create receipts for transfers and scheduled transfers.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.write scope.

• list - List receipts by transferID, scheduleID, or occurrenceID.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.read scope.

create

Create receipts for transfers and scheduled transfers.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.write scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.*;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.CreateReceiptsResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws GenericError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        CreateReceiptsResponse res = sdk.receipts().create()
                .requestBody(List.of(
                    ReceiptRequest.builder()
                        .kind(ReceiptKind.SALE_CUSTOMER_V1)
                        .email("jordan.lee@classbooker.dev")
                        .build()))
                .call();

        if (res.receiptResponses().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
xMoovVersion	Optional<String>	➖	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	List<ReceiptRequest>	✔️	N/A

Response

CreateReceiptsResponse

Errors

Error Type	Status Code	Content Type
models/errors/GenericError	400, 409	application/json
models/errors/APIException	4XX, 5XX	*/*

list

List receipts by transferID, scheduleID, or occurrenceID.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListReceiptsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListReceiptsResponse res = sdk.receipts().list()
                .id("c8a232aa-0b11-4b8a-b005-71e9e705d0e6")
                .call();

        if (res.receiptResponses().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
xMoovVersion	Optional<String>	➖	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	String	✔️	The transfer, schedule, or transfer occurrence ID to filter receipts by.

Response

ListReceiptsResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*