Package io.moov.sdk

Class EndToEndEncryption

java.lang.Object

io.moov.sdk.EndToEndEncryption

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallGenerateEndToEndKey, SDKMethodInterfaces.MethodCallTestEndToEndToken

public class EndToEndEncryption
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallTestEndToEndToken, SDKMethodInterfaces.MethodCallGenerateEndToEndKey

Method Summary

Modifier and Type	Method	Description
GenerateEndToEndKeyRequestBuilder	generateKey()	Generates a public key used to create a JWE token for passing secure authentication data through non-PCI compliant intermediaries.
GenerateEndToEndKeyResponse	generateKey(java.util.Optional<java.lang.String> xMoovVersion)	Generates a public key used to create a JWE token for passing secure authentication data through non-PCI compliant intermediaries.
GenerateEndToEndKeyResponse	generateKeyDirect()	Generates a public key used to create a JWE token for passing secure authentication data through non-PCI compliant intermediaries.
TestEndToEndTokenRequestBuilder	testEncryptedToken()	Allows for testing a JWE token to ensure it's acceptable by Moov.
TestEndToEndTokenResponse	testEncryptedToken(E2EEToken e2EEToken)	Allows for testing a JWE token to ensure it's acceptable by Moov.
TestEndToEndTokenResponse	testEncryptedToken(java.util.Optional<java.lang.String> xMoovVersion, E2EEToken e2EEToken)	Allows for testing a JWE token to ensure it's acceptable by Moov.

Methods inherited from class java.lang.Object

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

Method Detail

testEncryptedToken

public TestEndToEndTokenRequestBuilder testEncryptedToken()

Allows for testing a JWE token to ensure it's acceptable by Moov.

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

Returns:

The call builder

testEncryptedToken

public TestEndToEndTokenResponse testEncryptedToken(E2EEToken e2EEToken)
                                             throws java.lang.Exception

Allows for testing a JWE token to ensure it's acceptable by Moov.

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

Parameters:

e2EEToken - Wraps a compact-serialized JSON Web Encryption (JWE) token used for secure transmission of sensitive data (e.g., PCI information) through intermediaries. This token is encrypted using the public key from /end-to-end-keys and wraps an AES key. For details and examples, refer to our [GitHub repository](https://github.com/moovfinancial/moov-go/blob/main/examples/e2ee/e2ee_test.go).

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

testEncryptedToken

public TestEndToEndTokenResponse testEncryptedToken(java.util.Optional<java.lang.String> xMoovVersion,
                                                    E2EEToken e2EEToken)
                                             throws java.lang.Exception

Allows for testing a JWE token to ensure it's acceptable by Moov.

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

Specified by:

testEncryptedToken in interface SDKMethodInterfaces.MethodCallTestEndToEndToken

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.

e2EEToken - Wraps a compact-serialized JSON Web Encryption (JWE) token used for secure transmission of sensitive data (e.g., PCI information) through intermediaries. This token is encrypted using the public key from /end-to-end-keys and wraps an AES key. For details and examples, refer to our [GitHub repository](https://github.com/moovfinancial/moov-go/blob/main/examples/e2ee/e2ee_test.go).

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

generateKey

public GenerateEndToEndKeyRequestBuilder generateKey()

Generates a public key used to create a JWE token for passing secure authentication data through non-PCI compliant intermediaries.

Returns:

The call builder

generateKeyDirect

public GenerateEndToEndKeyResponse generateKeyDirect()
                                              throws java.lang.Exception

Generates a public key used to create a JWE token for passing secure authentication data through non-PCI compliant intermediaries.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

generateKey

public GenerateEndToEndKeyResponse generateKey(java.util.Optional<java.lang.String> xMoovVersion)
                                        throws java.lang.Exception

Generates a public key used to create a JWE token for passing secure authentication data through non-PCI compliant intermediaries.

Specified by:

generateKey in interface SDKMethodInterfaces.MethodCallGenerateEndToEndKey

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.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails