Package jp.gopay.sdk

Class GoPaySDK

java.lang.Object

jp.gopay.sdk.AbstractSDK

jp.gopay.sdk.GoPaySDK

All Implemented Interfaces:

Closeable, AutoCloseable, SDKMethods<GoPaySDK>

public class GoPaySDK
extends AbstractSDK
implements SDKMethods<GoPaySDK>, Closeable

Main class of the GoPay SDK. Provides methods for setting up credentials and communicating with the API.

Field Summary

Fields inherited from class jp.gopay.sdk.AbstractSDK

authStrategy, retrofit, settings

Method Summary

Modifier and Type	Method	Description
ChargesBuilders.CreateChargeRequestBuilder	authorizeCharge(TransactionTokenId tokenId, BigInteger amount, String currency)	Make a charge.
ChargesBuilders.CreateChargeRequestBuilder	authorizeCharge(TransactionTokenId tokenId, MoneyLike money)	Make a charge.
BatchCreateCharge	batchCreateCharge()	Make charges by batch processing with default parameter.
BatchCreateCharge	batchCreateCharge(int createMaxRetry, int statusCheckTimeout)	Make charges by batch processing.
ResourceMonitor<Cancel>	cancelCompletionMonitor(StoreId storeId, ChargeId chargeId, CancelId cancelId)	Create a ResourceMonitor that awaits the cancel to complete.
ChargesBuilders.CaptureAuthorizedChargeRequestBuilder	captureAuthorizedCharge(StoreId storeId, ChargeId chargeId, BigInteger amount, String currency)	Capture authorized charge.
ChargesBuilders.CaptureAuthorizedChargeRequestBuilder	captureAuthorizedCharge(StoreId storeId, ChargeId chargeId, MoneyLike money)	Capture authorized charge.
ResourceMonitor<Charge>	chargeCompletionMonitor(StoreId storeId, ChargeId chargeId)	Create a ResourceMonitor that awaits the charge complete.
void	close()
ExchangeRateBuilders.ConvertMoneyBuilder	convertMoney(MoneyLike moneyToConvert, String targetCurrency)	Obtains an estimate of an amount converted to a target currency.
GoPaySDK	copy()	Create a new instance of the SDK with the same credentials and settings.
GoPaySDK	copy(AuthStrategy authStrategy)	Create a new instance of the client with a new authentication strategy, but keeping the same SDK settings.
GoPaySDK	copy(AbstractSDKSettings settings)	Create a new instance of the client with new settings, but keeping the same authentication strategy.
static GoPaySDK	create()	Create an unauthenticated GoPaySDK instance with default production settings.
static GoPaySDK	create(AuthStrategy authStrategy)	Create a GoPaySDK instance with default settings using an authentication strategy.
static GoPaySDK	create(AuthStrategy authStrategy, AbstractSDKSettings settings)	Create a GoPaySDK instance using an authentication strategy.
static GoPaySDK	create(UserCredentials userCredentials, AbstractSDKSettings settings)	Asynchronously creates a GoPaySDK instance requesting a JWT for authentication.
static GoPaySDK	create(AbstractSDKSettings settings)	Create an unauthenticated GoPaySDK instance.
ApplicationTokenBuilders.CreateApplicationTokenRequestBuilder	createAppToken(StoreId storeId)	Deprecated.
ApplicationTokenBuilders.CreateApplicationTokenRequestBuilder	createAppToken(StoreId storeId, List<Domain> domains)	Creates a new application token for the store with ID storeId.
BankAccountsBuilders.CreateBankAccountRequestBuilder	createBankAccount(JapaneseBankAccount bankAccount)	Register a new bank account.
CancelsBuilders.CreateCancelRequestBuilder	createCancel(StoreId storeId, ChargeId chargeId)	Create a cancel for charge chargeId and store storeId
ChargesBuilders.CreateChargeRequestBuilder	createCharge(TransactionTokenId tokenId, BigInteger amount, String currency)	Make a charge.
ChargesBuilders.CreateChargeRequestBuilder	createCharge(TransactionTokenId tokenId, BigInteger amount, String currency, Boolean capture)	Make a charge.
ChargesBuilders.CreateChargeRequestBuilder	createCharge(TransactionTokenId tokenId, MoneyLike money)	Make a charge.
ChargesBuilders.CreateChargeRequestBuilder	createCharge(TransactionTokenId tokenId, MoneyLike money, Boolean capture)	Make a charge.
StoreBuilders.CreateCustomerIdRequestBuilder	createCustomerId(StoreId storeId, String customerId)	Associate a merchant-defined customer ID with a GoPay customer ID.
ApplicationTokenBuilders.CreateMerchantApplicationJWTRequestBuilder	createMerchantAppJWT()	Creates a new merchant-level Application Json Web Token
MerchantsBuilders.CreateMerchantVerificationRequestBuilder	createMerchantVerification(URL homepageUrl, String companyDescription, MerchantCompanyContactInfo companyContactInfo, BusinessType businessType, String systemManagerName)	Submits the merchant's information requesting for verification.
RefundBuilders.CreateRefundRequestBuilder	createRefund(StoreId storeId, ChargeId chargeId, BigInteger amount, String currency, RefundReason reason)	Make a refund associated with the charge with ID chargeId and the store storeId.
RefundBuilders.CreateRefundRequestBuilder	createRefund(StoreId storeId, ChargeId chargeId, MoneyLike money, RefundReason reason)	Make a refund associated with the charge with ID chargeId and the store storeId.
StoreBuilders.CreateStoreRequestBuilder	createStore(String name)	Register a new store.
ApplicationTokenBuilders.CreateStoreApplicationJWTRequestBuilder	createStoreAppJWT(StoreId storeId)	Creates a new store-level Application Json Web Token
SubscriptionBuilders.CreateSubscriptionRequestBuilder	createSubscription(TransactionTokenId transactionTokenId, BigInteger amount, String amountCurrency, SubscriptionPeriod period)	Create a new subscription.
SubscriptionBuilders.CreateSubscriptionRequestBuilder	createSubscription(TransactionTokenId transactionTokenId, MoneyLike money, SubscriptionPeriod period)	Create a new subscription
TransactionTokensBuilders.CreateTemporaryTokenAliasRequestBuilder	createTokenAlias(TransactionTokenId transactionTokenId)	Create an alias for an existing transaction token
TransactionTokensBuilders.CreateTransactionTokenRequestBuilder	createTransactionToken(String email, PaymentData paymentData, TransactionTokenType type)	Create a new transaction token.
WebhookBuilders.CreateWebhookMerchantRequestBuilder	createWebhook(URL url)	Create a new webhook.
WebhookBuilders.CreateWebhookRequestBuilder	createWebhook(StoreId storeId, URL url)	Create a new webhook associated with a store with ID storeId.
ApplicationTokenBuilders.DeleteMerchantApplicationJWTRequestBuilder	deleteAppJWT(AppJWTId appJWTId)	Deletes a merchant-level Json Web Token
ApplicationTokenBuilders.DeleteStoreApplicationJWTRequestBuilder	deleteAppJWT(StoreId storeId, AppJWTId appJWTId)	Deletes a store-level Json Web Token
ApplicationTokenBuilders.DeleteApplicationTokenRequestBuilder	deleteAppToken(StoreId storeId, AppTokenId appTokenId)	Deletes the application token with ID appTokenId for the store with ID storeId.
BankAccountsBuilders.DeleteBankAccountRequestBuilder	deleteBankAccount(BankAccountId bankAccountId)	Delete the bank account with ID bankAccountId
AuthenticationBuilders.LogoutRequestBuilder	deleteLoginToken()	Deprecated.
StoreBuilders.DeleteStoreRequestBuilder	deleteStore(StoreId storeId)	Delete a previously register
SubscriptionBuilders.DeleteSubscriptionRequestBuilder	deleteSubscription(StoreId storeId, SubscriptionId subscriptionId)	Delete an existing subscription with ID subscriptionId for the store with ID storeId.
TransactionTokensBuilders.DeleteTemporaryTokenAliasRequestBuilder	deleteTokenAlias(StoreId storeId, TemporaryTokenAliasId aliasId)	Delete a temporary transaction token alias
TransactionTokensBuilders.DeleteTransactionTokenRequestBuilder	deleteTransactionToken(StoreId storeId, TransactionTokenId tokenId)	Delete a transaction token.
WebhookBuilders.DeleteWebhookRequestBuilder	deleteWebhook(StoreId storeId, WebhookId webhookId)	Delete the webhook with ID webhookId.
WebhookBuilders.DeleteWebhookMerchantRequestBuilder	deleteWebhook(WebhookId webhookId)	Delete the webhook with ID webhookId.
BankAccountsBuilders.GetBankAccountRequestBuilder	getBankAccount(BankAccountId bankAccountId)	Get detailed information about a bank account with ID bankAccountId
CancelsBuilders.GetCancelRequestBuilder	getCancel(StoreId storeId, ChargeId chargeId, CancelId cancelId)	Obtain detailed information about a cancel with ID cancelId associated with the charge chargeId and store storeId.
ChargesBuilders.GetChargeRequestBuilder	getCharge(StoreId storeId, ChargeId chargeId)	Obtain detailed information for a charge with ID chargeId for the store with ID storeId
StoreBuilders.GetCheckoutInfoRequestBuilder	getCheckoutInfo()	Get the checkout information for the merchant.
StoreBuilders.GetCheckoutInfoRequestBuilder	getCheckoutInfo(Domain origin)	Get the checkout information for the merchant.
AuthenticationBuilders.LoginRequestBuilder	getLoginToken(String email, String password)	Obtain a new set of login credentials (login token and JWT) for a merchant account.
AuthenticationBuilders.LoginRequestBuilder	getLoginToken(UserCredentials userCredentials)	Obtain a new set of login credentials (login token and JWT) for a merchant account.
MerchantsBuilders.GetMeRequestBuilder	getMe()	Gets the merchant's information
MerchantsBuilders.GetMerchantVerificationRequestBuilder	getMerchantVerification()	Obtain the information submitted by the merchant for verification.
BankAccountsBuilders.GetPrimaryBankAccountRequestBuilder	getPrimaryBankAccount()	Obtain detailed information on the primary bank account of the merchant.
RefundBuilders.GetRefundRequestBuilder	getRefund(StoreId storeId, ChargeId chargeId, RefundId refundId)	Obtain detailed information about a refund with ID refundID associated with the charge with ID chargeID and the store with ID storeId.
SubscriptionBuilders.GetScheduledPaymentRequestBuilder	getScheduledPayment(StoreId storeId, SubscriptionId subscriptionId, ScheduledPaymentId paymentId)	Request the detail for a scheduled payment by its ID
StoreBuilders.GetStoreRequestBuilder	getStore(StoreId storeId)	Obtained detailed information for a store with ID storeId.
SubscriptionBuilders.GetSubscriptionRequestBuilder	getSubscription(StoreId storeId, SubscriptionId subscriptionId)	Get detailed information about the subscription with ID subscriptionId for the store with ID storeId.
TransactionTokensBuilders.GetTemporaryTokenAliasRequestBuilder	getTokenAlias(StoreId storeId, TemporaryTokenAliasId aliasId)	Get an existing temporary transaction token alias
TransactionTokensBuilders.GetTemporaryTokenAliasAsImageRequestBuilder	getTokenAliasImage(StoreId storeId, TemporaryTokenAliasId aliasId)	Get the token alias image as binary data
MerchantsBuilders.GetTransactionHistoryRequestBuilder	getTransactionHistory()	Obtain a list of all transactions of the merchant.
MerchantsBuilders.GetTransactionHistoryRequestBuilder	getTransactionHistory(StoreId storeId)	Obtain a list of transactions of the store.
TransactionTokensBuilders.GetTransactionTokenRequestBuilder	getTransactionToken(StoreId storeId, TransactionTokenId tokenId)	Get an existing transaction token.
TransferBuilders.GetTransferRequestBuilder	getTransfer(TransferId transferId)	Get detailed information about the transfer with ID transferId
WebhookBuilders.GetWebhookRequestBuilder	getWebhook(StoreId storeId, WebhookId webhookId)	Obtain detailed information on a webhook with ID webhookId associated with the store with ID storeId.
WebhookBuilders.GetWebhookMerchantRequestBuilder	getWebhook(WebhookId webhookId)	Obtain detailed information on a webhook with ID webhookId.
ApplicationTokenBuilders.ListApplicationTokenRequestBuilder	listAppTokens(StoreId storeId)	List the application tokens available for the store with ID storeId.
BankAccountsBuilders.ListAllBankAccountsRequestBuilder	listBankAccounts()	Obtain a list of the bank accounts registered by the merchant.
CancelsBuilders.ListAllCancelsRequestBuilder	listCancels(StoreId storeId, ChargeId chargeId)	List all the cancels associated with a charge
ChargesBuilders.ListChargesRequestBuilder	listCharges()	Obtain a list of charges made by the merchant.
ChargesBuilders.ListChargesRequestBuilder	listCharges(StoreId storeId)	Obtain a list of charges made by the merchant.
SubscriptionBuilders.ListChargesForPaymentRequestBuilder	listChargesForPayment(StoreId storeId, SubscriptionId subscriptionId, ScheduledPaymentId paymentId)	Obtain a list of the charges by the store and the subscription.
LedgersBuilders.ListLedgersRequestBuilder	listLedgers(TransferId transferId)	List ledgers associated with a transfer.
ApplicationTokenBuilders.ListMerchantApplicationJWTRequestBuilder	listMerchantAppJWT()	Lists all merchant-level Application Json Web Tokens
RefundBuilders.ListRefundsRequestBuilder	listRefunds(StoreId storeId, ChargeId chargeId)	Obtain a list of the refunds made by the merchant.
SubscriptionBuilders.ListScheduledPaymentsRequestBuilder	listScheduledPayments(StoreId storeId, SubscriptionId subscriptionId)	Request a list of the payments scheduled for a subscription with ID subscriptionId
ApplicationTokenBuilders.ListStoreApplicationJWTRequestBuilder	listStoreAppJWT(StoreId storeId)	Lists all store-level Application Json Web Tokens
StoreBuilders.ListStoresRequestBuilder	listStores()	Obtain a list of all the stores registered by the merchant
SubscriptionBuilders.ListSubscriptionChargesRequestBuilder	listSubscriptionCharges(StoreId storeId, SubscriptionId subscriptionId)	Obtain a list of the charges by the store and the subscription.
SubscriptionBuilders.ListSubscriptionsMerchantRequestBuilder	listSubscriptions()	Obtain a list of all the subscriptions.
SubscriptionBuilders.ListSubscriptionsRequestBuilder	listSubscriptions(StoreId storeId)	Obtain a list of all the subscriptions.
TransactionTokensBuilders.ListTransactionTokensMerchantRequestBuilder	listTransactionTokens()	List recurring transaction tokens.
TransactionTokensBuilders.ListTransactionTokensRequestBuilder	listTransactionTokens(StoreId storeId)	List recurring transaction tokens.
TransferBuilders.ListTransferRequestBuilder	listTransfers()	Obtain a list of transfers made to the merchant.
WebhookBuilders.ListWebhookMerchantRequestBuilder	listWebhooks()	Obtain a list of the webhooks.
WebhookBuilders.ListWebhookRequestBuilder	listWebhooks(StoreId storeId)	Obtain a list of the webhooks associated with a store with ID storeId.
AuthenticationBuilders.LogoutRequestBuilder	logout()	Invalidate the token used for authentication (login token or JWT) currently set as authentication strategy for this SDK instance.
ResourceMonitor<Refund>	refundCompletionMonitor(StoreId storeId, ChargeId chargeId, RefundId refundId)	Create a ResourceMonitor that awaits the refund complete.
SubscriptionBuilders.SimulateInstallmentsPlanRequestBuilder	simulateSubscriptionPlan(MoneyLike money, PaymentTypeName paymentType, SubscriptionPeriod period)	Simulate the payments plan for a subscription.
SubscriptionBuilders.SimulateInstallmentsPlanRequestBuilder	simulateSubscriptionPlan(StoreId storeId, MoneyLike money, PaymentTypeName paymentType, SubscriptionPeriod period)	Simulate the payments plan for a subscription.
ResourceMonitor<FullSubscription>	subscriptionCompletionMonitor(StoreId storeId, SubscriptionId subscriptionId)	Create a ResourceMonitor that awaits the subscription to complete.
ApplicationTokenBuilders.UpdateApplicationTokenRequestBuilder	updateAppToken(StoreId storeId, AppTokenId appTokenId, List<Domain> domains)	Updates the information for the application token with ID appTokenId and the store with ID storeId.
BankAccountsBuilders.UpdateBankAccountRequestBuilder	updateBankAccount(BankAccountId bankAccountId)	Update the information associated with the bank account with ID bankAccountId
CancelsBuilders.UpdateCancelRequestBuilder	updateCancel(StoreId storeId, ChargeId chargeId, CancelId cancelId)	Update an existing cancel with Id cancelId associated with charge chargeId and store storeId
ChargesBuilders.UpdateChargeRequestBuilder	updateCharge(StoreId storeId, ChargeId chargeId)	Update the settings of an existing charge with ID chargeId for the store with ID storeId.
MerchantsBuilders.UpdateMerchantVerificationRequestBuilder	updateMerchantVerification()	Update the information submitted by the merchant for verification.
SubscriptionBuilders.UpdateScheduledPaymentRequestBuilder	updateScheduledPayment(StoreId storeId, SubscriptionId subscriptionId, ScheduledPaymentId paymentId)	Update the properties of a scheduled payment such as due date and payment status
StoreBuilders.UpdateStoreRequestBuilder	updateStore(StoreId storeId)	Updates the information of a previously registered store.
SubscriptionBuilders.UpdateSubscriptionRequestBuilder	updateSubscription(StoreId storeId, SubscriptionId subscriptionId)	Update the settings of an existing subscription with ID subscriptionId for the store with ID storeId.
TransactionTokensBuilders.UpdateTransactionTokenRequestBuilder	updateTransactionToken(StoreId storeId, TransactionTokenId tokenId)	Update a recurring transaction token.
WebhookBuilders.UpdateWebhookRequestBuilder	updateWebhook(StoreId storeId, WebhookId webhookId)	Update a webhook with ID webhookId associated with a store with ID storeId.
WebhookBuilders.UpdateWebhookMerchantRequestBuilder	updateWebhook(WebhookId webhookId)	Update a webhook with ID webhookId.

Methods inherited from class java.lang.Object

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

Method Detail

copy

public GoPaySDK copy(AuthStrategy authStrategy)

Description copied from interface: SDKMethods

Create a new instance of the client with a new authentication strategy, but keeping the same SDK settings.

Specified by:

copy in interface SDKMethods<GoPaySDK>

Returns:

an instance of the SDK

copy

public GoPaySDK copy(AbstractSDKSettings settings)

Description copied from interface: SDKMethods

Create a new instance of the client with new settings, but keeping the same authentication strategy.

Specified by:

copy in interface SDKMethods<GoPaySDK>

Returns:

an instance of the SDK

copy

public GoPaySDK copy()

Description copied from interface: SDKMethods

Create a new instance of the SDK with the same credentials and settings.

Specified by:

copy in interface SDKMethods<GoPaySDK>

Returns:

an instance of the SDK

create

public static GoPaySDK create(AuthStrategy authStrategy,
                              AbstractSDKSettings settings)

Create a GoPaySDK instance using an authentication strategy.

Parameters:

authStrategy - The merchant's credentials.

settings - The SDK settings.

See Also:

AbstractSDKSettings, AuthStrategy, LoginTokenStrategy, AppTokenStrategy, LoginJWTStrategy, AppJWTStrategy, UnauthenticatedStrategy

create

public static GoPaySDK create(AbstractSDKSettings settings)

Create an unauthenticated GoPaySDK instance.

Parameters:

settings - The SDK settings.

See Also:

AbstractSDKSettings

create

public static GoPaySDK create()

Create an unauthenticated GoPaySDK instance with default production settings.

See Also:

AbstractSDKSettings

create

public static GoPaySDK create(AuthStrategy authStrategy)

Create a GoPaySDK instance with default settings using an authentication strategy.

Parameters:

authStrategy - The merchant's credentials.

See Also:

AbstractSDKSettings, AuthStrategy, LoginTokenStrategy, AppTokenStrategy, LoginJWTStrategy, AppJWTStrategy, UnauthenticatedStrategy, AbstractSDKSettings

create

public static GoPaySDK create(UserCredentials userCredentials,
                              AbstractSDKSettings settings)
                       throws IOException,
                              GoPayException

Asynchronously creates a GoPaySDK instance requesting a JWT for authentication.

Parameters:

userCredentials - The merchant's email and password

Throws:

TooManyRequestsException

IOException

GoPayException

See Also:

UserCredentials

getLoginToken

public AuthenticationBuilders.LoginRequestBuilder getLoginToken(String email,
                                                                String password)

Description copied from interface: SDKMethods

Obtain a new set of login credentials (login token and JWT) for a merchant account.

Specified by:

getLoginToken in interface SDKMethods<GoPaySDK>

Parameters:

email - the merchant's email that is associated with the GoPay account

password - the merchant's password

Returns:

a request builder.

See Also:

AbstractAuthenticationBuilders.AbstractLoginRequestBuilder

getLoginToken

public AuthenticationBuilders.LoginRequestBuilder getLoginToken(UserCredentials userCredentials)

Description copied from interface: SDKMethods

Obtain a new set of login credentials (login token and JWT) for a merchant account.

Specified by:

getLoginToken in interface SDKMethods<GoPaySDK>

Returns:

a request builder.

See Also:

AbstractAuthenticationBuilders.AbstractLoginRequestBuilder

deleteLoginToken

@Deprecated
public AuthenticationBuilders.LogoutRequestBuilder deleteLoginToken()

Deprecated.

logout

public AuthenticationBuilders.LogoutRequestBuilder logout()

Description copied from interface: SDKMethods

Invalidate the token used for authentication (login token or JWT) currently set as authentication strategy for this SDK instance.

Specified by:

logout in interface SDKMethods<GoPaySDK>

Returns:

a request builder.

See Also:

AbstractAuthenticationBuilders.AbstractLogoutRequestBuilder

listStores

public StoreBuilders.ListStoresRequestBuilder listStores()

Description copied from interface: SDKMethods

Obtain a list of all the stores registered by the merchant

Specified by:

listStores in interface SDKMethods<GoPaySDK>

Returns:

a request builder that implements Paginator

See Also:

StoreBuilders.ListStoresRequestBuilder, Paginator

getStore

public StoreBuilders.GetStoreRequestBuilder getStore(StoreId storeId)

Description copied from interface: SDKMethods

Obtained detailed information for a store with ID storeId.

Specified by:

getStore in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the store's ID

Returns:

a request builder

See Also:

StoreBuilders.GetStoreRequestBuilder

createStore

public StoreBuilders.CreateStoreRequestBuilder createStore(String name)

Description copied from interface: SDKMethods

Register a new store.

Specified by:

createStore in interface SDKMethods<GoPaySDK>

Parameters:

name - the new store's name

Returns:

a request builder

See Also:

StoreBuilders.CreateStoreRequestBuilder

updateStore

public StoreBuilders.UpdateStoreRequestBuilder updateStore(StoreId storeId)

Description copied from interface: SDKMethods

Updates the information of a previously registered store.

Specified by:

updateStore in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store that is going to be updated

Returns:

a request builder

See Also:

StoreBuilders.UpdateStoreRequestBuilder

deleteStore

public StoreBuilders.DeleteStoreRequestBuilder deleteStore(StoreId storeId)

Description copied from interface: SDKMethods

Delete a previously register

Specified by:

deleteStore in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store that is going to be deleted

Returns:

a request builder

getCheckoutInfo

public StoreBuilders.GetCheckoutInfoRequestBuilder getCheckoutInfo(Domain origin)

Description copied from interface: SDKMethods

Get the checkout information for the merchant.

Specified by:

getCheckoutInfo in interface SDKMethods<GoPaySDK>

Parameters:

origin - a domain included in the list of domains associated with the application token

Returns:

a request builder

getCheckoutInfo

public StoreBuilders.GetCheckoutInfoRequestBuilder getCheckoutInfo()

Description copied from interface: SDKMethods

Get the checkout information for the merchant.

Specified by:

getCheckoutInfo in interface SDKMethods<GoPaySDK>

Returns:

a request builder

createCustomerId

public StoreBuilders.CreateCustomerIdRequestBuilder createCustomerId(StoreId storeId,
                                                                     String customerId)

Description copied from interface: SDKMethods

Associate a merchant-defined customer ID with a GoPay customer ID.

Specified by:

createCustomerId in interface SDKMethods<GoPaySDK>

Returns:

a request builder

listAppTokens

public ApplicationTokenBuilders.ListApplicationTokenRequestBuilder listAppTokens(StoreId storeId)

Description copied from interface: SDKMethods

List the application tokens available for the store with ID storeId.

Specified by:

listAppTokens in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store for which an application token is being requested

Returns:

a request builder

deleteAppToken

public ApplicationTokenBuilders.DeleteApplicationTokenRequestBuilder deleteAppToken(StoreId storeId,
                                                                                    AppTokenId appTokenId)

Description copied from interface: SDKMethods

Deletes the application token with ID appTokenId for the store with ID storeId.

Specified by:

deleteAppToken in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the application token to be deleted

appTokenId - the ID of the application token to be deleted

Returns:

a request builder

createAppToken

@Deprecated
public ApplicationTokenBuilders.CreateApplicationTokenRequestBuilder createAppToken(StoreId storeId)

Deprecated.

Description copied from interface: SDKMethods

Creates a new application token for the store with ID storeId.

Specified by:

createAppToken in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store for which a new application token will be created

Returns:

a request builder that implements CreateApplicationTokenRequest

createAppToken

public ApplicationTokenBuilders.CreateApplicationTokenRequestBuilder createAppToken(StoreId storeId,
                                                                                    List<Domain> domains)

Description copied from interface: SDKMethods

Creates a new application token for the store with ID storeId.

Specified by:

createAppToken in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store for which a new application token will be created

domains - a list of domains from where requests can be made with an application token

Returns:

a request builder that implements CreateApplicationTokenRequest

updateAppToken

public ApplicationTokenBuilders.UpdateApplicationTokenRequestBuilder updateAppToken(StoreId storeId,
                                                                                    AppTokenId appTokenId,
                                                                                    List<Domain> domains)

Description copied from interface: SDKMethods

Updates the information for the application token with ID appTokenId and the store with ID storeId.

Specified by:

updateAppToken in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the application token that will be updated

appTokenId - the ID of the application token that will be updated

domains - a list of domains from where requests can be made with an application token

Returns:

a request builder

createMerchantAppJWT

public ApplicationTokenBuilders.CreateMerchantApplicationJWTRequestBuilder createMerchantAppJWT()

Description copied from interface: SDKMethods

Creates a new merchant-level Application Json Web Token

Specified by:

createMerchantAppJWT in interface SDKMethods<GoPaySDK>

Returns:

CreateMerchantApplicationJWTRequestBuilder

listMerchantAppJWT

public ApplicationTokenBuilders.ListMerchantApplicationJWTRequestBuilder listMerchantAppJWT()

Description copied from interface: SDKMethods

Lists all merchant-level Application Json Web Tokens

Specified by:

listMerchantAppJWT in interface SDKMethods<GoPaySDK>

Returns:

ListMerchantApplicationJWTRequestBuilder

deleteAppJWT

public ApplicationTokenBuilders.DeleteMerchantApplicationJWTRequestBuilder deleteAppJWT(AppJWTId appJWTId)

Description copied from interface: SDKMethods

Deletes a merchant-level Json Web Token

Specified by:

deleteAppJWT in interface SDKMethods<GoPaySDK>

Returns:

DeleteMerchantApplicationJWTRequestBuilder

createStoreAppJWT

public ApplicationTokenBuilders.CreateStoreApplicationJWTRequestBuilder createStoreAppJWT(StoreId storeId)

Description copied from interface: SDKMethods

Creates a new store-level Application Json Web Token

Specified by:

createStoreAppJWT in interface SDKMethods<GoPaySDK>

Returns:

CreateStoreApplicationJWTRequestBuilder

listStoreAppJWT

public ApplicationTokenBuilders.ListStoreApplicationJWTRequestBuilder listStoreAppJWT(StoreId storeId)

Description copied from interface: SDKMethods

Lists all store-level Application Json Web Tokens

Specified by:

listStoreAppJWT in interface SDKMethods<GoPaySDK>

Returns:

ListStoreApplicationJWTRequestBuilder

deleteAppJWT

public ApplicationTokenBuilders.DeleteStoreApplicationJWTRequestBuilder deleteAppJWT(StoreId storeId,
                                                                                     AppJWTId appJWTId)

Description copied from interface: SDKMethods

Deletes a store-level Json Web Token

Specified by:

deleteAppJWT in interface SDKMethods<GoPaySDK>

Returns:

DeleteStoreApplicationJWTRequestBuilder

listTransfers

public TransferBuilders.ListTransferRequestBuilder listTransfers()

Description copied from interface: SDKMethods

Obtain a list of transfers made to the merchant.

Specified by:

listTransfers in interface SDKMethods<GoPaySDK>

Returns:

a request builder that implements Paginator.

See Also:

AbstractTransferBuilders.AbstractListTransferRequestBuilder, Paginator

getTransfer

public TransferBuilders.GetTransferRequestBuilder getTransfer(TransferId transferId)

Description copied from interface: SDKMethods

Get detailed information about the transfer with ID transferId

Specified by:

getTransfer in interface SDKMethods<GoPaySDK>

Parameters:

transferId - the ID of the transfer being queried

Returns:

a request builder that implements GetTransferRequest

listCharges

public ChargesBuilders.ListChargesRequestBuilder listCharges(StoreId storeId)

Description copied from interface: SDKMethods

Obtain a list of charges made by the merchant.

Specified by:

listCharges in interface SDKMethods<GoPaySDK>

Parameters:

storeId - (optional) the ID of the store for which charges are being requested

Returns:

an instance of ListChargesRequestBuilder implementing Paginator

See Also:

Paginator

listCharges

public ChargesBuilders.ListChargesRequestBuilder listCharges()

Description copied from interface: SDKMethods

Obtain a list of charges made by the merchant.

Specified by:

listCharges in interface SDKMethods<GoPaySDK>

Returns:

an instance of ListChargesRequestBuilder implementing Paginator

See Also:

Paginator

getCharge

public ChargesBuilders.GetChargeRequestBuilder getCharge(StoreId storeId,
                                                         ChargeId chargeId)

Description copied from interface: SDKMethods

Obtain detailed information for a charge with ID chargeId for the store with ID storeId

Specified by:

getCharge in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the charge to be queried

chargeId - the ID of the charge to be queried

Returns:

a request builder

chargeCompletionMonitor

public ResourceMonitor<Charge> chargeCompletionMonitor(StoreId storeId,
                                                       ChargeId chargeId)

Description copied from interface: SDKMethods

Create a ResourceMonitor that awaits the charge complete. ResourceMonitor.await() will wait until the charge status is other than 'pending'.

Specified by:

chargeCompletionMonitor in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the charge to be queried

chargeId - the ID of the charge to be queried

Returns:

a ResourceMonitor

createCharge

public ChargesBuilders.CreateChargeRequestBuilder createCharge(TransactionTokenId tokenId,
                                                               BigInteger amount,
                                                               String currency)

Description copied from interface: SDKMethods

Make a charge. Authorization and capture.

Specified by:

createCharge in interface SDKMethods<GoPaySDK>

Parameters:

tokenId - the ID of the transaction token to be used for the charge

amount - the amount of the charge

currency - the currency

Returns:

a request builder.

createCharge

public ChargesBuilders.CreateChargeRequestBuilder createCharge(TransactionTokenId tokenId,
                                                               BigInteger amount,
                                                               String currency,
                                                               Boolean capture)

Description copied from interface: SDKMethods

Make a charge. Authorization and capture.

Specified by:

createCharge in interface SDKMethods<GoPaySDK>

Parameters:

tokenId - the ID of the transaction token to be used for the charge

amount - the amount of the charge

currency - the currency

capture - if false, authorization only

Returns:

a request builder.

createCharge

public ChargesBuilders.CreateChargeRequestBuilder createCharge(TransactionTokenId tokenId,
                                                               MoneyLike money)

Description copied from interface: SDKMethods

Make a charge. Authorization and capture.

Specified by:

createCharge in interface SDKMethods<GoPaySDK>

money - the amount and currency of the charge.

Returns:

createCharge

public ChargesBuilders.CreateChargeRequestBuilder createCharge(TransactionTokenId tokenId,
                                                               MoneyLike money,
                                                               Boolean capture)

Description copied from interface: SDKMethods

Make a charge. Authorization and capture.

Specified by:

createCharge in interface SDKMethods<GoPaySDK>

money - the amount and currency of the charge.

Returns:

batchCreateCharge

public BatchCreateCharge batchCreateCharge()

Description copied from interface: SDKMethods

Make charges by batch processing with default parameter.

Specified by:

batchCreateCharge in interface SDKMethods<GoPaySDK>

Returns:

a request builder

batchCreateCharge

public BatchCreateCharge batchCreateCharge(int createMaxRetry,
                                           int statusCheckTimeout)

Description copied from interface: SDKMethods

Make charges by batch processing.

Specified by:

batchCreateCharge in interface SDKMethods<GoPaySDK>

Parameters:

createMaxRetry - Max retry number if creating a charge failed by temporary error.

statusCheckTimeout - Timeout to wait until charge is processed.

Returns:

a request builder

authorizeCharge

public ChargesBuilders.CreateChargeRequestBuilder authorizeCharge(TransactionTokenId tokenId,
                                                                  BigInteger amount,
                                                                  String currency)

Description copied from interface: SDKMethods

Make a charge. Authorization only.

Specified by:

authorizeCharge in interface SDKMethods<GoPaySDK>

Parameters:

tokenId - the ID of the transaction token to be used for the charge

amount - the amount of the charge

currency - the currency

Returns:

a request builder.

authorizeCharge

public ChargesBuilders.CreateChargeRequestBuilder authorizeCharge(TransactionTokenId tokenId,
                                                                  MoneyLike money)

Description copied from interface: SDKMethods

Make a charge. Authorization only.

Specified by:

authorizeCharge in interface SDKMethods<GoPaySDK>

money - the amount and currency of the charge.

Returns:

captureAuthorizedCharge

public ChargesBuilders.CaptureAuthorizedChargeRequestBuilder captureAuthorizedCharge(StoreId storeId,
                                                                                     ChargeId chargeId,
                                                                                     BigInteger amount,
                                                                                     String currency)

Description copied from interface: SDKMethods

Capture authorized charge.

Specified by:

captureAuthorizedCharge in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the charge to be queried

chargeId - the ID of the charge to be queried

amount - the amount of the charge

currency - the currency

Returns:

a request builder.

captureAuthorizedCharge

public ChargesBuilders.CaptureAuthorizedChargeRequestBuilder captureAuthorizedCharge(StoreId storeId,
                                                                                     ChargeId chargeId,
                                                                                     MoneyLike money)

Description copied from interface: SDKMethods

Capture authorized charge.

Specified by:

captureAuthorizedCharge in interface SDKMethods<GoPaySDK>

money - the amount and currency of the charge.

Returns:

updateCharge

public ChargesBuilders.UpdateChargeRequestBuilder updateCharge(StoreId storeId,
                                                               ChargeId chargeId)

Description copied from interface: SDKMethods

Update the settings of an existing charge with ID chargeId for the store with ID storeId.

Specified by:

updateCharge in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the charge to be queried

chargeId - the ID of the charge to be queried

Returns:

a request builder that implements Paginator

listSubscriptions

public SubscriptionBuilders.ListSubscriptionsMerchantRequestBuilder listSubscriptions()

Description copied from interface: SDKMethods

Obtain a list of all the subscriptions.

Specified by:

listSubscriptions in interface SDKMethods<GoPaySDK>

Returns:

a request builder that implements ListSubscriptionsRequest and Paginator

See Also:

Paginator

listSubscriptions

public SubscriptionBuilders.ListSubscriptionsRequestBuilder listSubscriptions(StoreId storeId)

Description copied from interface: SDKMethods

Obtain a list of all the subscriptions.

Specified by:

listSubscriptions in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store for which subscriptions will be listed

Returns:

a request builder that implements ListSubscriptionsRequest and Paginator

See Also:

Paginator

getSubscription

public SubscriptionBuilders.GetSubscriptionRequestBuilder getSubscription(StoreId storeId,
                                                                          SubscriptionId subscriptionId)

Description copied from interface: SDKMethods

Get detailed information about the subscription with ID subscriptionId for the store with ID storeId.

Specified by:

getSubscription in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the subscription to be queried

subscriptionId - the ID of the subscription to be queried

Returns:

a request builder that implements GetSubscriptionRequest

subscriptionCompletionMonitor

public ResourceMonitor<FullSubscription> subscriptionCompletionMonitor(StoreId storeId,
                                                                       SubscriptionId subscriptionId)

Description copied from interface: SDKMethods

Create a ResourceMonitor that awaits the subscription to complete. ResourceMonitor.await() will wait until the subscription status is other than 'unverified'.

Specified by:

subscriptionCompletionMonitor in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the subscription to be queried

subscriptionId - the ID of the subscription to be queried

Returns:

a ResourceMonitor

createSubscription

public SubscriptionBuilders.CreateSubscriptionRequestBuilder createSubscription(TransactionTokenId transactionTokenId,
                                                                                BigInteger amount,
                                                                                String amountCurrency,
                                                                                SubscriptionPeriod period)

Description copied from interface: SDKMethods

Create a new subscription.

Specified by:

createSubscription in interface SDKMethods<GoPaySDK>

Parameters:

transactionTokenId - the ID of the transaction token to be used to create the subscription

amount - the amount of the subscription

amountCurrency - the currency in which the subscription's charges will be made

period - the periodicity of the subscription

Returns:

a request builder

createSubscription

public SubscriptionBuilders.CreateSubscriptionRequestBuilder createSubscription(TransactionTokenId transactionTokenId,
                                                                                MoneyLike money,
                                                                                SubscriptionPeriod period)

Description copied from interface: SDKMethods

Create a new subscription

Specified by:

createSubscription in interface SDKMethods<GoPaySDK>

money - the amount and currency of the subscription

Returns:

a request builder

updateSubscription

public SubscriptionBuilders.UpdateSubscriptionRequestBuilder updateSubscription(StoreId storeId,
                                                                                SubscriptionId subscriptionId)

Description copied from interface: SDKMethods

Update the settings of an existing subscription with ID subscriptionId for the store with ID storeId.

Specified by:

updateSubscription in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store for which subscription charges will be listed

subscriptionId - the ID of the subscription for which charges will be listed

Returns:

a request builder that implements Paginator

listChargesForPayment

public SubscriptionBuilders.ListChargesForPaymentRequestBuilder listChargesForPayment(StoreId storeId,
                                                                                      SubscriptionId subscriptionId,
                                                                                      ScheduledPaymentId paymentId)

Description copied from interface: SDKMethods

Obtain a list of the charges by the store and the subscription.

Specified by:

listChargesForPayment in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store in which subscription is.

subscriptionId - the ID of the subscription for which charges will be listed

Returns:

a request builder that implements Paginator

listSubscriptionCharges

public SubscriptionBuilders.ListSubscriptionChargesRequestBuilder listSubscriptionCharges(StoreId storeId,
                                                                                          SubscriptionId subscriptionId)

Description copied from interface: SDKMethods

Obtain a list of the charges by the store and the subscription.

Specified by:

listSubscriptionCharges in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store in which subscription is.

subscriptionId - the ID of the subscription for which charges will be listed

Returns:

a request builder that implements Paginator

deleteSubscription

public SubscriptionBuilders.DeleteSubscriptionRequestBuilder deleteSubscription(StoreId storeId,
                                                                                SubscriptionId subscriptionId)

Description copied from interface: SDKMethods

Delete an existing subscription with ID subscriptionId for the store with ID storeId.

Specified by:

deleteSubscription in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the subscription that will be deleted

subscriptionId - the ID of the subscription to be deleted

Returns:

a request builder

listScheduledPayments

public SubscriptionBuilders.ListScheduledPaymentsRequestBuilder listScheduledPayments(StoreId storeId,
                                                                                      SubscriptionId subscriptionId)

Description copied from interface: SDKMethods

Request a list of the payments scheduled for a subscription with ID subscriptionId

Specified by:

listScheduledPayments in interface SDKMethods<GoPaySDK>

Returns:

a request builder that implements ListScheduledPaymentsRequest

getScheduledPayment

public SubscriptionBuilders.GetScheduledPaymentRequestBuilder getScheduledPayment(StoreId storeId,
                                                                                  SubscriptionId subscriptionId,
                                                                                  ScheduledPaymentId paymentId)

Description copied from interface: SDKMethods

Request the detail for a scheduled payment by its ID

Specified by:

getScheduledPayment in interface SDKMethods<GoPaySDK>

Returns:

a request builder that implements GetScheduledPaymentRequest

updateScheduledPayment

public SubscriptionBuilders.UpdateScheduledPaymentRequestBuilder updateScheduledPayment(StoreId storeId,
                                                                                        SubscriptionId subscriptionId,
                                                                                        ScheduledPaymentId paymentId)

Description copied from interface: SDKMethods

Update the properties of a scheduled payment such as due date and payment status

Specified by:

updateScheduledPayment in interface SDKMethods<GoPaySDK>

Returns:

a request builder that implements UpdateScheduledPaymentRequest

simulateSubscriptionPlan

public SubscriptionBuilders.SimulateInstallmentsPlanRequestBuilder simulateSubscriptionPlan(MoneyLike money,
                                                                                            PaymentTypeName paymentType,
                                                                                            SubscriptionPeriod period)

Description copied from interface: SDKMethods

Simulate the payments plan for a subscription.

Specified by:

simulateSubscriptionPlan in interface SDKMethods<GoPaySDK>

Parameters:

money - amount and currency of the subscription

paymentType - the type of the payment (credit card, QR Scan, etc.)

period - the Subscription period

Returns:

a request builder

simulateSubscriptionPlan

public SubscriptionBuilders.SimulateInstallmentsPlanRequestBuilder simulateSubscriptionPlan(StoreId storeId,
                                                                                            MoneyLike money,
                                                                                            PaymentTypeName paymentType,
                                                                                            SubscriptionPeriod period)

Description copied from interface: SDKMethods

Simulate the payments plan for a subscription.

Specified by:

simulateSubscriptionPlan in interface SDKMethods<GoPaySDK>

money - amount and currency of the subscription

paymentType - the type of the payment (credit card, QR Scan, etc.)

period - the Subscription period

Returns:

a request builder

listRefunds

public RefundBuilders.ListRefundsRequestBuilder listRefunds(StoreId storeId,
                                                            ChargeId chargeId)

Description copied from interface: SDKMethods

Obtain a list of the refunds made by the merchant.

Specified by:

listRefunds in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store for which refunds will be listed

chargeId - the ID of the charge for wich refunds will be listed

Returns:

a request builder that implements

getRefund

public RefundBuilders.GetRefundRequestBuilder getRefund(StoreId storeId,
                                                        ChargeId chargeId,
                                                        RefundId refundId)

Description copied from interface: SDKMethods

Obtain detailed information about a refund with ID refundID associated with the charge with ID chargeID and the store with ID storeId.

Specified by:

getRefund in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the refund to be queried

chargeId - the ID of the charge associated with the refund to be queried

refundId - the ID of the refund to be queried

Returns:

a request builder

createRefund

public RefundBuilders.CreateRefundRequestBuilder createRefund(StoreId storeId,
                                                              ChargeId chargeId,
                                                              BigInteger amount,
                                                              String currency,
                                                              RefundReason reason)

Description copied from interface: SDKMethods

Make a refund associated with the charge with ID chargeId and the store storeId.

Specified by:

createRefund in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the charge that will be refunded

chargeId - the ID of the charge to be refunded

amount - the amount to be refunded

currency - the currency in which the refund will be made

reason - the reason why the refund will be made

Returns:

a request builder that implements CreateRefundRequest

createRefund

public RefundBuilders.CreateRefundRequestBuilder createRefund(StoreId storeId,
                                                              ChargeId chargeId,
                                                              MoneyLike money,
                                                              RefundReason reason)

Description copied from interface: SDKMethods

Make a refund associated with the charge with ID chargeId and the store storeId.

Specified by:

createRefund in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the charge that will be refunded

chargeId - the ID of the charge to be refunded

money - the amount and currency of the refund

reason - the reason why the refund will be made

Returns:

a request builder that implements CreateRefundRequest

refundCompletionMonitor

public ResourceMonitor<Refund> refundCompletionMonitor(StoreId storeId,
                                                       ChargeId chargeId,
                                                       RefundId refundId)

Description copied from interface: SDKMethods

Create a ResourceMonitor that awaits the refund complete. ResourceMonitor.await() will wait until the refund status is other than 'pending'.

Specified by:

refundCompletionMonitor in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the refund to be queried

chargeId - the ID of the charge associated with the refund to be queried

refundId - the ID of the refund to be queried

Returns:

a ResourceMonitor

listCancels

public CancelsBuilders.ListAllCancelsRequestBuilder listCancels(StoreId storeId,
                                                                ChargeId chargeId)

Description copied from interface: SDKMethods

List all the cancels associated with a charge

Specified by:

listCancels in interface SDKMethods<GoPaySDK>

Returns:

a ListAllCancelsRequestBuilder

getCancel

public CancelsBuilders.GetCancelRequestBuilder getCancel(StoreId storeId,
                                                         ChargeId chargeId,
                                                         CancelId cancelId)

Description copied from interface: SDKMethods

Obtain detailed information about a cancel with ID cancelId associated with the charge chargeId and store storeId.

Specified by:

getCancel in interface SDKMethods<GoPaySDK>

Returns:

a request builder

cancelCompletionMonitor

public ResourceMonitor<Cancel> cancelCompletionMonitor(StoreId storeId,
                                                       ChargeId chargeId,
                                                       CancelId cancelId)

Description copied from interface: SDKMethods

Create a ResourceMonitor that awaits the cancel to complete. ResourceMonitor.await() will wait until the cancel status is other than 'pending'.

Specified by:

cancelCompletionMonitor in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the cancel to be queried

chargeId - the ID of the charge

cancelId - the ID of the cancel to be queried

Returns:

a ResourceMonitor

createCancel

public CancelsBuilders.CreateCancelRequestBuilder createCancel(StoreId storeId,
                                                               ChargeId chargeId)

Description copied from interface: SDKMethods

Create a cancel for charge chargeId and store storeId

Specified by:

createCancel in interface SDKMethods<GoPaySDK>

Returns:

a request builder

updateCancel

public CancelsBuilders.UpdateCancelRequestBuilder updateCancel(StoreId storeId,
                                                               ChargeId chargeId,
                                                               CancelId cancelId)

Description copied from interface: SDKMethods

Update an existing cancel with Id cancelId associated with charge chargeId and store storeId

Specified by:

updateCancel in interface SDKMethods<GoPaySDK>

Returns:

a request builder

listBankAccounts

public BankAccountsBuilders.ListAllBankAccountsRequestBuilder listBankAccounts()

Description copied from interface: SDKMethods

Obtain a list of the bank accounts registered by the merchant.

Specified by:

listBankAccounts in interface SDKMethods<GoPaySDK>

Returns:

a request builder that implements

getBankAccount

public BankAccountsBuilders.GetBankAccountRequestBuilder getBankAccount(BankAccountId bankAccountId)

Description copied from interface: SDKMethods

Get detailed information about a bank account with ID bankAccountId

Specified by:

getBankAccount in interface SDKMethods<GoPaySDK>

Parameters:

bankAccountId - the ID of the bank account to be queried

Returns:

a request builder

createBankAccount

public BankAccountsBuilders.CreateBankAccountRequestBuilder createBankAccount(JapaneseBankAccount bankAccount)

Description copied from interface: SDKMethods

Register a new bank account.

Specified by:

createBankAccount in interface SDKMethods<GoPaySDK>

Parameters:

bankAccount - a bank account object. Currently only Japanese Bank Accounts are supported.

Returns:

a request builder

See Also:

JapaneseBankAccount

updateBankAccount

public BankAccountsBuilders.UpdateBankAccountRequestBuilder updateBankAccount(BankAccountId bankAccountId)

Description copied from interface: SDKMethods

Update the information associated with the bank account with ID bankAccountId

Specified by:

updateBankAccount in interface SDKMethods<GoPaySDK>

Parameters:

bankAccountId - the ID of the bank account to be updated

Returns:

a request builder

deleteBankAccount

public BankAccountsBuilders.DeleteBankAccountRequestBuilder deleteBankAccount(BankAccountId bankAccountId)

Description copied from interface: SDKMethods

Delete the bank account with ID bankAccountId

Specified by:

deleteBankAccount in interface SDKMethods<GoPaySDK>

Parameters:

bankAccountId - the ID of the bank account to be deleted

Returns:

a request builder

getPrimaryBankAccount

public BankAccountsBuilders.GetPrimaryBankAccountRequestBuilder getPrimaryBankAccount()

Description copied from interface: SDKMethods

Obtain detailed information on the primary bank account of the merchant.

Specified by:

getPrimaryBankAccount in interface SDKMethods<GoPaySDK>

Returns:

a request builder

getMerchantVerification

public MerchantsBuilders.GetMerchantVerificationRequestBuilder getMerchantVerification()

Description copied from interface: SDKMethods

Obtain the information submitted by the merchant for verification.

Specified by:

getMerchantVerification in interface SDKMethods<GoPaySDK>

Returns:

a request builder

updateMerchantVerification

public MerchantsBuilders.UpdateMerchantVerificationRequestBuilder updateMerchantVerification()

Description copied from interface: SDKMethods

Update the information submitted by the merchant for verification.

Specified by:

updateMerchantVerification in interface SDKMethods<GoPaySDK>

Returns:

a request builder

createMerchantVerification

public MerchantsBuilders.CreateMerchantVerificationRequestBuilder createMerchantVerification(URL homepageUrl,
                                                                                             String companyDescription,
                                                                                             MerchantCompanyContactInfo companyContactInfo,
                                                                                             BusinessType businessType,
                                                                                             String systemManagerName)

Description copied from interface: SDKMethods

Submits the merchant's information requesting for verification.

Specified by:

createMerchantVerification in interface SDKMethods<GoPaySDK>

Parameters:

homepageUrl - the url of the merchant's homepage

companyDescription - a description of the merchant's company

companyContactInfo - an instance of MerchantCompanyContactInfo

businessType - the business type of the merchant's company

systemManagerName - the system manager's name

Returns:

a request builder

getMe

public MerchantsBuilders.GetMeRequestBuilder getMe()

Description copied from interface: SDKMethods

Gets the merchant's information

Specified by:

getMe in interface SDKMethods<GoPaySDK>

Returns:

a request builder

getTransactionHistory

public MerchantsBuilders.GetTransactionHistoryRequestBuilder getTransactionHistory(StoreId storeId)

Description copied from interface: SDKMethods

Obtain a list of transactions of the store.

Specified by:

getTransactionHistory in interface SDKMethods<GoPaySDK>

Parameters:

storeId - (optional) the ID of the store for which transactions will be listed

Returns:

a request builder that implements

getTransactionHistory

public MerchantsBuilders.GetTransactionHistoryRequestBuilder getTransactionHistory()

Description copied from interface: SDKMethods

Obtain a list of all transactions of the merchant.

Specified by:

getTransactionHistory in interface SDKMethods<GoPaySDK>

Returns:

a request builder that implements

listWebhooks

public WebhookBuilders.ListWebhookMerchantRequestBuilder listWebhooks()

Description copied from interface: SDKMethods

Obtain a list of the webhooks.

Specified by:

listWebhooks in interface SDKMethods<GoPaySDK>

Returns:

a request builder

getWebhook

public WebhookBuilders.GetWebhookMerchantRequestBuilder getWebhook(WebhookId webhookId)

Description copied from interface: SDKMethods

Obtain detailed information on a webhook with ID webhookId.

Specified by:

getWebhook in interface SDKMethods<GoPaySDK>

Parameters:

webhookId - the ID of the webhook to be queried

Returns:

a request builder

createWebhook

public WebhookBuilders.CreateWebhookMerchantRequestBuilder createWebhook(URL url)

Description copied from interface: SDKMethods

Create a new webhook.

Specified by:

createWebhook in interface SDKMethods<GoPaySDK>

Parameters:

url - the webhook's URL

Returns:

a request builder

updateWebhook

public WebhookBuilders.UpdateWebhookMerchantRequestBuilder updateWebhook(WebhookId webhookId)

Description copied from interface: SDKMethods

Update a webhook with ID webhookId.

Specified by:

updateWebhook in interface SDKMethods<GoPaySDK>

Parameters:

webhookId - the ID of the webhook that will be updated

Returns:

a request builder

deleteWebhook

public WebhookBuilders.DeleteWebhookMerchantRequestBuilder deleteWebhook(WebhookId webhookId)

Description copied from interface: SDKMethods

Delete the webhook with ID webhookId.

Specified by:

deleteWebhook in interface SDKMethods<GoPaySDK>

Parameters:

webhookId - the ID of the webhook to be deleted

Returns:

a request builder that implements Request of type Void

listWebhooks

public WebhookBuilders.ListWebhookRequestBuilder listWebhooks(StoreId storeId)

Description copied from interface: SDKMethods

Obtain a list of the webhooks associated with a store with ID storeId.

Specified by:

listWebhooks in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store for which webhooks will be listed

Returns:

a request builder

getWebhook

public WebhookBuilders.GetWebhookRequestBuilder getWebhook(StoreId storeId,
                                                           WebhookId webhookId)

Description copied from interface: SDKMethods

Obtain detailed information on a webhook with ID webhookId associated with the store with ID storeId.

Specified by:

getWebhook in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the webhook that will be queried

webhookId - the ID of the webhook to be queried

Returns:

a request builder

createWebhook

public WebhookBuilders.CreateWebhookRequestBuilder createWebhook(StoreId storeId,
                                                                 URL url)

Description copied from interface: SDKMethods

Create a new webhook associated with a store with ID storeId.

Specified by:

createWebhook in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store for which a new webhook will be created

url - the webhook's URL

Returns:

a request builder

updateWebhook

public WebhookBuilders.UpdateWebhookRequestBuilder updateWebhook(StoreId storeId,
                                                                 WebhookId webhookId)

Description copied from interface: SDKMethods

Update a webhook with ID webhookId associated with a store with ID storeId.

Specified by:

updateWebhook in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the webhook that will be updated

webhookId - the ID of the webhook that will be updated

Returns:

a request builder

deleteWebhook

public WebhookBuilders.DeleteWebhookRequestBuilder deleteWebhook(StoreId storeId,
                                                                 WebhookId webhookId)

Description copied from interface: SDKMethods

Delete the webhook with ID webhookId.

Specified by:

deleteWebhook in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the webhook to be deleted

webhookId - the ID of the webhook to be deleted

Returns:

a request builder that implements Request of type Void

createTransactionToken

public TransactionTokensBuilders.CreateTransactionTokenRequestBuilder createTransactionToken(String email,
                                                                                             PaymentData paymentData,
                                                                                             TransactionTokenType type)

Description copied from interface: SDKMethods

Create a new transaction token.

Specified by:

createTransactionToken in interface SDKMethods<GoPaySDK>

Parameters:

email - the email address of the person making the payment

paymentData - instance of CreditCard, QRScanData, KonbiniPayment or ApplePay

Returns:

a request builder.

deleteTransactionToken

public TransactionTokensBuilders.DeleteTransactionTokenRequestBuilder deleteTransactionToken(StoreId storeId,
                                                                                             TransactionTokenId tokenId)

Description copied from interface: SDKMethods

Delete a transaction token.

Specified by:

deleteTransactionToken in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the transaction token to be deleted

tokenId - the ID of the transaction token to be deleted

Returns:

a request builder

getTransactionToken

public TransactionTokensBuilders.GetTransactionTokenRequestBuilder getTransactionToken(StoreId storeId,
                                                                                       TransactionTokenId tokenId)

Description copied from interface: SDKMethods

Get an existing transaction token.

Specified by:

getTransactionToken in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the transaction token being queried

tokenId - the ID of the transaction token to be queried

Returns:

a request builder

updateTransactionToken

public TransactionTokensBuilders.UpdateTransactionTokenRequestBuilder updateTransactionToken(StoreId storeId,
                                                                                             TransactionTokenId tokenId)

Description copied from interface: SDKMethods

Update a recurring transaction token.

Specified by:

updateTransactionToken in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store associated with the transaction token to be updated

tokenId - the ID of the transaction token to be updated

Returns:

a request builder

listTransactionTokens

public TransactionTokensBuilders.ListTransactionTokensRequestBuilder listTransactionTokens(StoreId storeId)

Description copied from interface: SDKMethods

List recurring transaction tokens.

Specified by:

listTransactionTokens in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store

Returns:

a request builder

listTransactionTokens

public TransactionTokensBuilders.ListTransactionTokensMerchantRequestBuilder listTransactionTokens()

Description copied from interface: SDKMethods

List recurring transaction tokens.

Specified by:

listTransactionTokens in interface SDKMethods<GoPaySDK>

Returns:

a request builder

createTokenAlias

public TransactionTokensBuilders.CreateTemporaryTokenAliasRequestBuilder createTokenAlias(TransactionTokenId transactionTokenId)

Description copied from interface: SDKMethods

Create an alias for an existing transaction token

Specified by:

createTokenAlias in interface SDKMethods<GoPaySDK>

Returns:

a request builder

getTokenAlias

public TransactionTokensBuilders.GetTemporaryTokenAliasRequestBuilder getTokenAlias(StoreId storeId,
                                                                                    TemporaryTokenAliasId aliasId)

Description copied from interface: SDKMethods

Get an existing temporary transaction token alias

Specified by:

getTokenAlias in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store

aliasId - the ID of the temporary alias

Returns:

a request builder

getTokenAliasImage

public TransactionTokensBuilders.GetTemporaryTokenAliasAsImageRequestBuilder getTokenAliasImage(StoreId storeId,
                                                                                                TemporaryTokenAliasId aliasId)

Description copied from interface: SDKMethods

Get the token alias image as binary data

Specified by:

getTokenAliasImage in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store

aliasId - the ID of the temporary alias

Returns:

a request builder

deleteTokenAlias

public TransactionTokensBuilders.DeleteTemporaryTokenAliasRequestBuilder deleteTokenAlias(StoreId storeId,
                                                                                          TemporaryTokenAliasId aliasId)

Description copied from interface: SDKMethods

Delete a temporary transaction token alias

Specified by:

deleteTokenAlias in interface SDKMethods<GoPaySDK>

Parameters:

storeId - the ID of the store

aliasId - the ID of the temporary alias to be deleted

Returns:

a request builder

listLedgers

public LedgersBuilders.ListLedgersRequestBuilder listLedgers(TransferId transferId)

Description copied from interface: SDKMethods

List ledgers associated with a transfer.

Specified by:

listLedgers in interface SDKMethods<GoPaySDK>

Parameters:

transferId - the ID of the transfer for which ledgers will be listed

Returns:

a request builder

convertMoney

public ExchangeRateBuilders.ConvertMoneyBuilder convertMoney(MoneyLike moneyToConvert,
                                                             String targetCurrency)

Description copied from interface: SDKMethods

Obtains an estimate of an amount converted to a target currency.

Specified by:

convertMoney in interface SDKMethods<GoPaySDK>

Returns:

a request builder

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException