SDKMethods ({project.groupId}:gopay-java-sdk 0.10.1 API)

All Known Implementing Classes:: GoPaySDK

public interface SDKMethods<T extends AbstractSDK>

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`AbstractChargesBuilders.AbstractCreateChargeRequestBuilder`	`authorizeCharge(TransactionTokenId tokenId, BigInteger amount, String currency)`	Make a charge.
`AbstractChargesBuilders.AbstractCreateChargeRequestBuilder`	`authorizeCharge(TransactionTokenId tokenId, MoneyLike money)`	Make a charge.
`AbstractBatchCreateCharge`	`batchCreateCharge()`	Make charges by batch processing with default parameter.
`AbstractBatchCreateCharge`	`batchCreateCharge(int createMaxRetry, int statusCheckTimeout)`	Make charges by batch processing.
`ResourceMonitor<? extends Cancel>`	`cancelCompletionMonitor(StoreId storeId, ChargeId chargeId, CancelId cancelId)`	Create a `ResourceMonitor` that awaits the cancel to complete.
`AbstractChargesBuilders.AbstractCaptureAuthorizedChargeRequestBuilder`	`captureAuthorizedCharge(StoreId storeId, ChargeId chargeId, BigInteger amount, String currency)`	Capture authorized charge.
`AbstractChargesBuilders.AbstractCaptureAuthorizedChargeRequestBuilder`	`captureAuthorizedCharge(StoreId storeId, ChargeId chargeId, MoneyLike money)`	Capture authorized charge.
`ResourceMonitor<? extends Charge>`	`chargeCompletionMonitor(StoreId storeId, ChargeId chargeId)`	Create a `ResourceMonitor` that awaits the charge complete.
`AbstractExchangeRateBuilders.AbstractConvertMoneyBuilder`	`convertMoney(MoneyLike moneyToConvert, String targetCurrency)`	Obtains an estimate of an amount converted to a target currency.
`T`	`copy()`	Create a new instance of the SDK with the same credentials and settings.
`T`	`copy(AuthStrategy authStrategy)`	Create a new instance of the client with a new authentication strategy, but keeping the same SDK settings.
`T`	`copy(AbstractSDKSettings settings)`	Create a new instance of the client with new settings, but keeping the same authentication strategy.
`AbstractApplicationTokenBuilders.AbstractCreateApplicationTokenRequestBuilder`	`createAppToken(StoreId storeId)`	Deprecated.
`AbstractApplicationTokenBuilders.AbstractCreateApplicationTokenRequestBuilder`	`createAppToken(StoreId storeId, List<Domain> domains)`	Creates a new application token for the store with ID `storeId`.
`AbstractBankAccountsBuilders.AbstractCreateBankAccountRequestBuilder`	`createBankAccount(JapaneseBankAccount bankAccount)`	Register a new bank account.
`AbstractCancelsBuilders.AbstractCreateCancelRequestBuilder`	`createCancel(StoreId storeId, ChargeId chargeId)`	Create a cancel for charge `chargeId` and store `storeId`
`AbstractChargesBuilders.AbstractCreateChargeRequestBuilder`	`createCharge(TransactionTokenId tokenId, BigInteger amount, String currency)`	Make a charge.
`AbstractChargesBuilders.AbstractCreateChargeRequestBuilder`	`createCharge(TransactionTokenId tokenId, BigInteger amount, String currency, Boolean capture)`	Make a charge.
`AbstractChargesBuilders.AbstractCreateChargeRequestBuilder`	`createCharge(TransactionTokenId tokenId, MoneyLike money)`	Make a charge.
`AbstractChargesBuilders.AbstractCreateChargeRequestBuilder`	`createCharge(TransactionTokenId tokenId, MoneyLike money, Boolean capture)`	Make a charge.
`AbstractStoreBuilders.AbstractCreateCustomerIdRequestBuilder`	`createCustomerId(StoreId storeId, String customerId)`	Associate a merchant-defined customer ID with a GoPay customer ID.
`AbstractApplicationTokenBuilders.AbstractCreateMerchantApplicationJWTRequestBuilder`	`createMerchantAppJWT()`	Creates a new merchant-level Application Json Web Token
`AbstractMerchantsBuilders.AbstractCreateMerchantVerificationRequestBuilder`	`createMerchantVerification(URL homepageUrl, String companyDescription, MerchantCompanyContactInfo companyContactInfo, BusinessType businessType, String systemManagerName)`	Submits the merchant's information requesting for verification.
`AbstractRefundBuilders.AbstractCreateRefundRequestBuilder`	`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`.
`AbstractRefundBuilders.AbstractCreateRefundRequestBuilder`	`createRefund(StoreId storeId, ChargeId chargeId, MoneyLike money, RefundReason reason)`	Make a refund associated with the charge with ID `chargeId` and the store `storeId`.
`AbstractStoreBuilders.AbstractCreateStoreRequestBuilder`	`createStore(String name)`	Register a new store.
`AbstractApplicationTokenBuilders.AbstractCreateStoreApplicationJWTRequestBuilder`	`createStoreAppJWT(StoreId storeId)`	Creates a new store-level Application Json Web Token
`AbstractSubscriptionBuilders.AbstractCreateSubscriptionRequestBuilder`	`createSubscription(TransactionTokenId transactionTokenId, BigInteger amount, String amountCurrency, SubscriptionPeriod period)`	Create a new subscription.
`AbstractSubscriptionBuilders.AbstractCreateSubscriptionRequestBuilder`	`createSubscription(TransactionTokenId transactionTokenId, MoneyLike money, SubscriptionPeriod period)`	Create a new subscription
`AbstractTransactionTokensBuilders.AbstractCreateTemporaryTokenAliasRequestBuilder`	`createTokenAlias(TransactionTokenId transactionTokenId)`	Create an alias for an existing transaction token
`AbstractTransactionTokensBuilders.AbstractCreateTransactionTokenRequestBuilder`	`createTransactionToken(String email, PaymentData paymentData, TransactionTokenType type)`	Create a new transaction token.
`AbstractWebhookBuilders.AbstractCreateWebhookMerchantRequestBuilder`	`createWebhook(URL url)`	Create a new webhook.
`AbstractWebhookBuilders.AbstractCreateWebhookRequestBuilder`	`createWebhook(StoreId storeId, URL url)`	Create a new webhook associated with a store with ID `storeId`.
`AbstractApplicationTokenBuilders.AbstractDeleteMerchantApplicationJWTRequestBuilder`	`deleteAppJWT(AppJWTId appJWTId)`	Deletes a merchant-level Json Web Token
`AbstractApplicationTokenBuilders.AbstractDeleteStoreApplicationJWTRequestBuilder`	`deleteAppJWT(StoreId storeId, AppJWTId appJWTId)`	Deletes a store-level Json Web Token
`AbstractApplicationTokenBuilders.AbstractDeleteApplicationTokenRequestBuilder`	`deleteAppToken(StoreId storeId, AppTokenId appTokenId)`	Deletes the application token with ID `appTokenId` for the store with ID `storeId`.
`AbstractBankAccountsBuilders.AbstractDeleteBankAccountRequestBuilder`	`deleteBankAccount(BankAccountId bankAccountId)`	Delete the bank account with ID `bankAccountId`
`AbstractStoreBuilders.AbstractDeleteStoreRequestBuilder`	`deleteStore(StoreId storeId)`	Delete a previously register
`AbstractSubscriptionBuilders.AbstractDeleteSubscriptionRequestBuilder`	`deleteSubscription(StoreId storeId, SubscriptionId subscriptionId)`	Delete an existing subscription with ID `subscriptionId` for the store with ID `storeId`.
`AbstractTransactionTokensBuilders.AbstractDeleteTemporaryTokenAliasRequestBuilder`	`deleteTokenAlias(StoreId storeId, TemporaryTokenAliasId aliasId)`	Delete a temporary transaction token alias
`AbstractTransactionTokensBuilders.AbstractDeleteTransactionTokenRequestBuilder`	`deleteTransactionToken(StoreId storeId, TransactionTokenId tokenId)`	Delete a transaction token.
`AbstractWebhookBuilders.AbstractDeleteWebhookRequestBuilder`	`deleteWebhook(StoreId storeId, WebhookId webhookId)`	Delete the webhook with ID `webhookId`.
`AbstractWebhookBuilders.AbstractDeleteWebhookMerchantRequestBuilder`	`deleteWebhook(WebhookId webhookId)`	Delete the webhook with ID `webhookId`.
`AbstractBankAccountsBuilders.AbstractGetBankAccountRequestBuilder`	`getBankAccount(BankAccountId bankAccountId)`	Get detailed information about a bank account with ID `bankAccountId`
`AbstractCancelsBuilders.AbstractGetCancelRequestBuilder`	`getCancel(StoreId storeId, ChargeId chargeId, CancelId cancelId)`	Obtain detailed information about a cancel with ID `cancelId` associated with the charge `chargeId` and store `storeId`.
`AbstractChargesBuilders.AbstractGetChargeRequestBuilder`	`getCharge(StoreId storeId, ChargeId chargeId)`	Obtain detailed information for a charge with ID `chargeId` for the store with ID `storeId`
`AbstractStoreBuilders.AbstractGetCheckoutInfoRequestBuilder`	`getCheckoutInfo()`	Get the checkout information for the merchant.
`AbstractStoreBuilders.AbstractGetCheckoutInfoRequestBuilder`	`getCheckoutInfo(Domain origin)`	Get the checkout information for the merchant.
`AbstractAuthenticationBuilders.AbstractLoginRequestBuilder`	`getLoginToken(String email, String password)`	Obtain a new set of login credentials (login token and JWT) for a merchant account.
`AbstractAuthenticationBuilders.AbstractLoginRequestBuilder`	`getLoginToken(UserCredentials userCredentials)`	Obtain a new set of login credentials (login token and JWT) for a merchant account.
`AbstractMerchantsBuilders.AbstractGetMeRequestBuilder`	`getMe()`	Gets the merchant's information
`AbstractMerchantsBuilders.AbstractGetMerchantVerificationRequestBuilder`	`getMerchantVerification()`	Obtain the information submitted by the merchant for verification.
`AbstractBankAccountsBuilders.AbstractGetPrimaryBankAccountRequestBuilder`	`getPrimaryBankAccount()`	Obtain detailed information on the primary bank account of the merchant.
`AbstractRefundBuilders.AbstractGetRefundRequestBuilder`	`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`.
`AbstractSubscriptionBuilders.AbstractGetScheduledPaymentRequestBuilder`	`getScheduledPayment(StoreId storeId, SubscriptionId subscriptionId, ScheduledPaymentId paymentId)`	Request the detail for a scheduled payment by its ID
`AbstractStoreBuilders.AbstractGetStoreRequestBuilder`	`getStore(StoreId storeId)`	Obtained detailed information for a store with ID `storeId`.
`AbstractSubscriptionBuilders.AbstractGetSubscriptionRequestBuilder`	`getSubscription(StoreId storeId, SubscriptionId subscriptionId)`	Get detailed information about the subscription with ID `subscriptionId` for the store with ID `storeId`.
`AbstractTransactionTokensBuilders.AbstractGetTemporaryTokenAliasRequestBuilder`	`getTokenAlias(StoreId storeId, TemporaryTokenAliasId aliasId)`	Get an existing temporary transaction token alias
`AbstractTransactionTokensBuilders.AbstractGetTemporaryTokenAliasAsImageRequestBuilder`	`getTokenAliasImage(StoreId storeId, TemporaryTokenAliasId aliasId)`	Get the token alias image as binary data
`AbstractMerchantsBuilders.AbstractGetTransactionHistoryRequestBuilder`	`getTransactionHistory()`	Obtain a list of all transactions of the merchant.
`AbstractMerchantsBuilders.AbstractGetTransactionHistoryRequestBuilder`	`getTransactionHistory(StoreId storeId)`	Obtain a list of transactions of the store.
`AbstractTransactionTokensBuilders.AbstractGetTransactionTokenRequestBuilder`	`getTransactionToken(StoreId storeId, TransactionTokenId tokenId)`	Get an existing transaction token.
`AbstractTransferBuilders.AbstractGetTransferRequestBuilder`	`getTransfer(TransferId transferId)`	Get detailed information about the transfer with ID `transferId`
`AbstractWebhookBuilders.AbstractGetWebhookRequestBuilder`	`getWebhook(StoreId storeId, WebhookId webhookId)`	Obtain detailed information on a webhook with ID `webhookId` associated with the store with ID `storeId`.
`AbstractWebhookBuilders.AbstractGetWebhookMerchantRequestBuilder`	`getWebhook(WebhookId webhookId)`	Obtain detailed information on a webhook with ID `webhookId`.
`AbstractApplicationTokenBuilders.AbstractListApplicationTokenRequestBuilder`	`listAppTokens(StoreId storeId)`	List the application tokens available for the store with ID `storeId`.
`AbstractBankAccountsBuilders.AbstractListAllBankAccountsRequestBuilder`	`listBankAccounts()`	Obtain a list of the bank accounts registered by the merchant.
`AbstractCancelsBuilders.AbstractListAllCancelsRequestBuilder`	`listCancels(StoreId storeId, ChargeId chargeId)`	List all the cancels associated with a charge
`AbstractChargesBuilders.AbstractListChargesRequestBuilder`	`listCharges()`	Obtain a list of charges made by the merchant.
`AbstractChargesBuilders.AbstractListChargesRequestBuilder`	`listCharges(StoreId storeId)`	Obtain a list of charges made by the merchant.
`AbstractSubscriptionBuilders.AbstractListChargesForPaymentRequestBuilder`	`listChargesForPayment(StoreId storeId, SubscriptionId subscriptionId, ScheduledPaymentId paymentId)`	Obtain a list of the charges by the store and the subscription.
`AbstractLedgersBuilders.AbstractListLedgersRequestBuilder`	`listLedgers(TransferId transferId)`	List ledgers associated with a transfer.
`AbstractApplicationTokenBuilders.AbstractListMerchantApplicationJWTRequestBuilder`	`listMerchantAppJWT()`	Lists all merchant-level Application Json Web Tokens
`AbstractRefundBuilders.AbstractListRefundsRequestBuilder`	`listRefunds(StoreId storeId, ChargeId chargeId)`	Obtain a list of the refunds made by the merchant.
`AbstractSubscriptionBuilders.AbstractListScheduledPaymentsRequestBuilder`	`listScheduledPayments(StoreId storeId, SubscriptionId subscriptionId)`	Request a list of the payments scheduled for a subscription with ID `subscriptionId`
`AbstractApplicationTokenBuilders.AbstractListStoreApplicationJWTRequestBuilder`	`listStoreAppJWT(StoreId storeId)`	Lists all store-level Application Json Web Tokens
`AbstractStoreBuilders.AbstractListStoresRequestBuilder`	`listStores()`	Obtain a list of all the stores registered by the merchant
`AbstractSubscriptionBuilders.AbstractListSubscriptionChargesRequestBuilder`	`listSubscriptionCharges(StoreId storeId, SubscriptionId subscriptionId)`	Obtain a list of the charges by the store and the subscription.
`AbstractSubscriptionBuilders.AbstractListSubscriptionsMerchantRequestBuilder`	`listSubscriptions()`	Obtain a list of all the subscriptions.
`AbstractSubscriptionBuilders.AbstractListSubscriptionsRequestBuilder`	`listSubscriptions(StoreId storeId)`	Obtain a list of all the subscriptions.
`AbstractTransactionTokensBuilders.AbstractListTransactionTokensMerchantRequestBuilder`	`listTransactionTokens()`	List recurring transaction tokens.
`AbstractTransactionTokensBuilders.AbstractListTransactionTokensRequestBuilder`	`listTransactionTokens(StoreId storeId)`	List recurring transaction tokens.
`AbstractTransferBuilders.AbstractListTransferRequestBuilder`	`listTransfers()`	Obtain a list of transfers made to the merchant.
`AbstractWebhookBuilders.AbstractListWebhookMerchantRequestBuilder`	`listWebhooks()`	Obtain a list of the webhooks.
`AbstractWebhookBuilders.AbstractListWebhookRequestBuilder`	`listWebhooks(StoreId storeId)`	Obtain a list of the webhooks associated with a store with ID `storeId`.
`AbstractAuthenticationBuilders.AbstractLogoutRequestBuilder`	`logout()`	Invalidate the token used for authentication (login token or JWT) currently set as authentication strategy for this SDK instance.
`ResourceMonitor<? extends Refund>`	`refundCompletionMonitor(StoreId storeId, ChargeId chargeId, RefundId refundId)`	Create a `ResourceMonitor` that awaits the refund complete.
`AbstractSubscriptionBuilders.AbstractSimulateInstallmentsPlanRequestBuilder`	`simulateSubscriptionPlan(MoneyLike money, PaymentTypeName paymentType, SubscriptionPeriod period)`	Simulate the payments plan for a subscription.
`AbstractSubscriptionBuilders.AbstractSimulateInstallmentsPlanRequestBuilder`	`simulateSubscriptionPlan(StoreId storeId, MoneyLike money, PaymentTypeName paymentType, SubscriptionPeriod period)`	Simulate the payments plan for a subscription.
`ResourceMonitor<? extends FullSubscription>`	`subscriptionCompletionMonitor(StoreId storeId, SubscriptionId subscriptionId)`	Create a `ResourceMonitor` that awaits the subscription to complete.
`AbstractApplicationTokenBuilders.AbstractUpdateApplicationTokenRequestBuilder`	`updateAppToken(StoreId storeId, AppTokenId appTokenId, List<Domain> domains)`	Updates the information for the application token with ID `appTokenId` and the store with ID `storeId`.
`AbstractBankAccountsBuilders.AbstractUpdateBankAccountRequestBuilder`	`updateBankAccount(BankAccountId bankAccountId)`	Update the information associated with the bank account with ID `bankAccountId`
`AbstractCancelsBuilders.AbstractUpdateCancelRequestBuilder`	`updateCancel(StoreId storeId, ChargeId chargeId, CancelId cancelId)`	Update an existing cancel with Id `cancelId` associated with charge `chargeId` and store `storeId`
`AbstractChargesBuilders.AbstractUpdateChargeRequestBuilder`	`updateCharge(StoreId storeId, ChargeId chargeId)`	Update the settings of an existing charge with ID `chargeId` for the store with ID `storeId`.
`AbstractMerchantsBuilders.AbstractUpdateMerchantVerificationRequestBuilder`	`updateMerchantVerification()`	Update the information submitted by the merchant for verification.
`AbstractSubscriptionBuilders.AbstractUpdateScheduledPaymentRequestBuilder`	`updateScheduledPayment(StoreId storeId, SubscriptionId subscriptionId, ScheduledPaymentId paymentId)`	Update the properties of a scheduled payment such as due date and payment status
`AbstractStoreBuilders.AbstractUpdateStoreRequestBuilder`	`updateStore(StoreId storeId)`	Updates the information of a previously registered store.
`AbstractSubscriptionBuilders.AbstractUpdateSubscriptionRequestBuilder`	`updateSubscription(StoreId storeId, SubscriptionId subscriptionId)`	Update the settings of an existing subscription with ID `subscriptionId` for the store with ID `storeId`.
`AbstractTransactionTokensBuilders.AbstractUpdateTransactionTokenRequestBuilder`	`updateTransactionToken(StoreId storeId, TransactionTokenId tokenId)`	Update a recurring transaction token.
`AbstractWebhookBuilders.AbstractUpdateWebhookRequestBuilder`	`updateWebhook(StoreId storeId, WebhookId webhookId)`	Update a webhook with ID `webhookId` associated with a store with ID `storeId`.
`AbstractWebhookBuilders.AbstractUpdateWebhookMerchantRequestBuilder`	`updateWebhook(WebhookId webhookId)`	Update a webhook with ID `webhookId`.

Method Detail

copy
```
T copy(AuthStrategy authStrategy)
```
Create a new instance of the client with a new authentication strategy, but keeping the same SDK settings.

Parameters:

authStrategy -

Returns:

an instance of the SDK

copy
```
T copy(AbstractSDKSettings settings)
```
Create a new instance of the client with new settings, but keeping the same authentication strategy.

Parameters:

settings -

Returns:

an instance of the SDK

copy
```
T copy()
```
Create a new instance of the SDK with the same credentials and settings.

Returns:

an instance of the SDK

getLoginToken
```
AbstractAuthenticationBuilders.AbstractLoginRequestBuilder getLoginToken(String email,
                                                                         String password)
```
Obtain a new set of login credentials (login token and JWT) for a merchant account.

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
```
AbstractAuthenticationBuilders.AbstractLoginRequestBuilder getLoginToken(UserCredentials userCredentials)
```
Obtain a new set of login credentials (login token and JWT) for a merchant account.

Parameters:

userCredentials -

Returns:

a request builder.

See Also:

AbstractAuthenticationBuilders.AbstractLoginRequestBuilder

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

Returns:

a request builder.

See Also:

AbstractAuthenticationBuilders.AbstractLogoutRequestBuilder

listStores
```
AbstractStoreBuilders.AbstractListStoresRequestBuilder listStores()
```
Obtain a list of all the stores registered by the merchant

Returns:

a request builder that implements Paginator

See Also:

StoreBuilders.ListStoresRequestBuilder, Paginator

getStore
```
AbstractStoreBuilders.AbstractGetStoreRequestBuilder getStore(StoreId storeId)
```
Obtained detailed information for a store with ID storeId.

Parameters:

storeId - the store's ID

Returns:

a request builder

See Also:

StoreBuilders.GetStoreRequestBuilder

createStore
```
AbstractStoreBuilders.AbstractCreateStoreRequestBuilder createStore(String name)
```
Register a new store.

Parameters:

name - the new store's name

Returns:

a request builder

See Also:

StoreBuilders.CreateStoreRequestBuilder

updateStore
```
AbstractStoreBuilders.AbstractUpdateStoreRequestBuilder updateStore(StoreId storeId)
```
Updates the information of a previously registered store.

Parameters:

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

Returns:

a request builder

See Also:

StoreBuilders.UpdateStoreRequestBuilder

deleteStore
```
AbstractStoreBuilders.AbstractDeleteStoreRequestBuilder deleteStore(StoreId storeId)
```
Delete a previously register

Parameters:

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

Returns:

a request builder

getCheckoutInfo
```
AbstractStoreBuilders.AbstractGetCheckoutInfoRequestBuilder getCheckoutInfo(Domain origin)
```
Get the checkout information for the merchant.

Parameters:

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

Returns:

a request builder

getCheckoutInfo
```
AbstractStoreBuilders.AbstractGetCheckoutInfoRequestBuilder getCheckoutInfo()
```
Get the checkout information for the merchant.

Returns:

a request builder

listAppTokens
```
AbstractApplicationTokenBuilders.AbstractListApplicationTokenRequestBuilder listAppTokens(StoreId storeId)
```
List the application tokens available for the store with ID storeId.

Parameters:

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

Returns:

a request builder

deleteAppToken

AbstractApplicationTokenBuilders.AbstractDeleteApplicationTokenRequestBuilder deleteAppToken(StoreId storeId,
                                                                                             AppTokenId appTokenId)

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

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
AbstractApplicationTokenBuilders.AbstractCreateApplicationTokenRequestBuilder createAppToken(StoreId storeId)
```
Deprecated.

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

Parameters:

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

Returns:

a request builder that implements CreateApplicationTokenRequest

createAppToken

AbstractApplicationTokenBuilders.AbstractCreateApplicationTokenRequestBuilder createAppToken(StoreId storeId,
                                                                                             List<Domain> domains)

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

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

AbstractApplicationTokenBuilders.AbstractUpdateApplicationTokenRequestBuilder updateAppToken(StoreId storeId,
                                                                                             AppTokenId appTokenId,
                                                                                             List<Domain> domains)

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

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
```
AbstractApplicationTokenBuilders.AbstractCreateMerchantApplicationJWTRequestBuilder createMerchantAppJWT()
```
Creates a new merchant-level Application Json Web Token

Returns:

CreateMerchantApplicationJWTRequestBuilder

listMerchantAppJWT
```
AbstractApplicationTokenBuilders.AbstractListMerchantApplicationJWTRequestBuilder listMerchantAppJWT()
```
Lists all merchant-level Application Json Web Tokens

Returns:

ListMerchantApplicationJWTRequestBuilder

deleteAppJWT

AbstractApplicationTokenBuilders.AbstractDeleteMerchantApplicationJWTRequestBuilder deleteAppJWT(AppJWTId appJWTId)

Deletes a merchant-level Json Web Token

Parameters:: appJWTId -
Returns:: DeleteMerchantApplicationJWTRequestBuilder

createStoreAppJWT
```
AbstractApplicationTokenBuilders.AbstractCreateStoreApplicationJWTRequestBuilder createStoreAppJWT(StoreId storeId)
```
Creates a new store-level Application Json Web Token

Parameters:

storeId -

Returns:

CreateStoreApplicationJWTRequestBuilder

listStoreAppJWT
```
AbstractApplicationTokenBuilders.AbstractListStoreApplicationJWTRequestBuilder listStoreAppJWT(StoreId storeId)
```
Lists all store-level Application Json Web Tokens

Parameters:

storeId -

Returns:

ListStoreApplicationJWTRequestBuilder

deleteAppJWT

AbstractApplicationTokenBuilders.AbstractDeleteStoreApplicationJWTRequestBuilder deleteAppJWT(StoreId storeId,
                                                                                              AppJWTId appJWTId)

Deletes a store-level Json Web Token

Parameters:: storeId -; appJWTId -
Returns:: DeleteStoreApplicationJWTRequestBuilder

listTransfers
```
AbstractTransferBuilders.AbstractListTransferRequestBuilder listTransfers()
```
Obtain a list of transfers made to the merchant.

Returns:

a request builder that implements Paginator.

See Also:

AbstractTransferBuilders.AbstractListTransferRequestBuilder, Paginator

getTransfer
```
AbstractTransferBuilders.AbstractGetTransferRequestBuilder getTransfer(TransferId transferId)
```
Get detailed information about the transfer with ID transferId

Parameters:

transferId - the ID of the transfer being queried

Returns:

a request builder that implements GetTransferRequest

listCharges
```
AbstractChargesBuilders.AbstractListChargesRequestBuilder listCharges(StoreId storeId)
```
Obtain a list of charges made by the merchant.

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
```
AbstractChargesBuilders.AbstractListChargesRequestBuilder listCharges()
```
Obtain a list of charges made by the merchant.

Returns:

an instance of ListChargesRequestBuilder implementing Paginator

See Also:

Paginator

getCharge

AbstractChargesBuilders.AbstractGetChargeRequestBuilder getCharge(StoreId storeId,
                                                                  ChargeId chargeId)

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

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
```
ResourceMonitor<? extends Charge> chargeCompletionMonitor(StoreId storeId,
                                                          ChargeId chargeId)
```
Create a ResourceMonitor that awaits the charge complete. ResourceMonitor.await() will wait until the charge status is other than 'pending'.

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

AbstractChargesBuilders.AbstractCreateChargeRequestBuilder createCharge(TransactionTokenId tokenId,
                                                                        BigInteger amount,
                                                                        String currency)

Make a charge. Authorization and capture.

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

AbstractChargesBuilders.AbstractCreateChargeRequestBuilder createCharge(TransactionTokenId tokenId,
                                                                        MoneyLike money)

Make a charge. Authorization and capture.

Parameters:: tokenId -; money - the amount and currency of the charge.
Returns:

createCharge

AbstractChargesBuilders.AbstractCreateChargeRequestBuilder createCharge(TransactionTokenId tokenId,
                                                                        BigInteger amount,
                                                                        String currency,
                                                                        Boolean capture)

Make a charge. Authorization and capture.

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

AbstractChargesBuilders.AbstractCreateChargeRequestBuilder createCharge(TransactionTokenId tokenId,
                                                                        MoneyLike money,
                                                                        Boolean capture)

Make a charge. Authorization and capture.

Parameters:: tokenId -; money - the amount and currency of the charge.; capture -
Returns:

batchCreateCharge
```
AbstractBatchCreateCharge batchCreateCharge()
```
Make charges by batch processing with default parameter.

Returns:

a request builder

batchCreateCharge
```
AbstractBatchCreateCharge batchCreateCharge(int createMaxRetry,
                                            int statusCheckTimeout)
```
Make charges by batch processing.

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

AbstractChargesBuilders.AbstractCreateChargeRequestBuilder authorizeCharge(TransactionTokenId tokenId,
                                                                           BigInteger amount,
                                                                           String currency)

Make a charge. Authorization only.

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

AbstractChargesBuilders.AbstractCreateChargeRequestBuilder authorizeCharge(TransactionTokenId tokenId,
                                                                           MoneyLike money)

Make a charge. Authorization only.

Parameters:: tokenId -; money - the amount and currency of the charge.
Returns:

captureAuthorizedCharge

AbstractChargesBuilders.AbstractCaptureAuthorizedChargeRequestBuilder captureAuthorizedCharge(StoreId storeId,
                                                                                              ChargeId chargeId,
                                                                                              BigInteger amount,
                                                                                              String currency)

Capture authorized charge.

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

AbstractChargesBuilders.AbstractCaptureAuthorizedChargeRequestBuilder captureAuthorizedCharge(StoreId storeId,
                                                                                              ChargeId chargeId,
                                                                                              MoneyLike money)

Capture authorized charge.

Parameters:: storeId -; chargeId -; money - the amount and currency of the charge.
Returns:

updateCharge
```
AbstractChargesBuilders.AbstractUpdateChargeRequestBuilder updateCharge(StoreId storeId,
                                                                        ChargeId chargeId)
```
Update the settings of an existing charge with ID chargeId for the store with ID storeId.

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
```
AbstractSubscriptionBuilders.AbstractListSubscriptionsMerchantRequestBuilder listSubscriptions()
```
Obtain a list of all the subscriptions.

Returns:

a request builder that implements ListSubscriptionsRequest and Paginator

See Also:

Paginator

listSubscriptions
```
AbstractSubscriptionBuilders.AbstractListSubscriptionsRequestBuilder listSubscriptions(StoreId storeId)
```
Obtain a list of all the subscriptions.

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
```
AbstractSubscriptionBuilders.AbstractGetSubscriptionRequestBuilder getSubscription(StoreId storeId,
                                                                                   SubscriptionId subscriptionId)
```
Get detailed information about the subscription with ID subscriptionId for the store with ID storeId.

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

listScheduledPayments

AbstractSubscriptionBuilders.AbstractListScheduledPaymentsRequestBuilder listScheduledPayments(StoreId storeId,
                                                                                               SubscriptionId subscriptionId)

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

Parameters:: storeId -; subscriptionId -
Returns:: a request builder that implements ListScheduledPaymentsRequest

getScheduledPayment

AbstractSubscriptionBuilders.AbstractGetScheduledPaymentRequestBuilder getScheduledPayment(StoreId storeId,
                                                                                           SubscriptionId subscriptionId,
                                                                                           ScheduledPaymentId paymentId)

Request the detail for a scheduled payment by its ID

Parameters:: storeId -; subscriptionId -; paymentId -
Returns:: a request builder that implements GetScheduledPaymentRequest

updateScheduledPayment

AbstractSubscriptionBuilders.AbstractUpdateScheduledPaymentRequestBuilder updateScheduledPayment(StoreId storeId,
                                                                                                 SubscriptionId subscriptionId,
                                                                                                 ScheduledPaymentId paymentId)

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

Parameters:: storeId -; subscriptionId -; paymentId -
Returns:: a request builder that implements UpdateScheduledPaymentRequest

subscriptionCompletionMonitor
```
ResourceMonitor<? extends FullSubscription> subscriptionCompletionMonitor(StoreId storeId,
                                                                          SubscriptionId subscriptionId)
```
Create a ResourceMonitor that awaits the subscription to complete. ResourceMonitor.await() will wait until the subscription status is other than 'unverified'.

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

AbstractSubscriptionBuilders.AbstractCreateSubscriptionRequestBuilder createSubscription(TransactionTokenId transactionTokenId,
                                                                                         BigInteger amount,
                                                                                         String amountCurrency,
                                                                                         SubscriptionPeriod period)

Create a new subscription.

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

AbstractSubscriptionBuilders.AbstractCreateSubscriptionRequestBuilder createSubscription(TransactionTokenId transactionTokenId,
                                                                                         MoneyLike money,
                                                                                         SubscriptionPeriod period)

Create a new subscription

Parameters:: transactionTokenId -; money - the amount and currency of the subscription; period -
Returns:: a request builder

updateSubscription

AbstractSubscriptionBuilders.AbstractUpdateSubscriptionRequestBuilder updateSubscription(StoreId storeId,
                                                                                         SubscriptionId subscriptionId)

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

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

AbstractSubscriptionBuilders.AbstractListChargesForPaymentRequestBuilder listChargesForPayment(StoreId storeId,
                                                                                               SubscriptionId subscriptionId,
                                                                                               ScheduledPaymentId paymentId)

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

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

AbstractSubscriptionBuilders.AbstractListSubscriptionChargesRequestBuilder listSubscriptionCharges(StoreId storeId,
                                                                                                   SubscriptionId subscriptionId)

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

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

AbstractSubscriptionBuilders.AbstractDeleteSubscriptionRequestBuilder deleteSubscription(StoreId storeId,
                                                                                         SubscriptionId subscriptionId)

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

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

simulateSubscriptionPlan

AbstractSubscriptionBuilders.AbstractSimulateInstallmentsPlanRequestBuilder simulateSubscriptionPlan(MoneyLike money,
                                                                                                     PaymentTypeName paymentType,
                                                                                                     SubscriptionPeriod period)

Simulate the payments plan for a subscription.

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

AbstractSubscriptionBuilders.AbstractSimulateInstallmentsPlanRequestBuilder simulateSubscriptionPlan(StoreId storeId,
                                                                                                     MoneyLike money,
                                                                                                     PaymentTypeName paymentType,
                                                                                                     SubscriptionPeriod period)

Simulate the payments plan for a subscription.

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

listRefunds

AbstractRefundBuilders.AbstractListRefundsRequestBuilder listRefunds(StoreId storeId,
                                                                     ChargeId chargeId)

Obtain a list of the refunds made by the merchant.

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

AbstractRefundBuilders.AbstractGetRefundRequestBuilder 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.

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

AbstractRefundBuilders.AbstractCreateRefundRequestBuilder 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.

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

AbstractRefundBuilders.AbstractCreateRefundRequestBuilder createRefund(StoreId storeId,
                                                                       ChargeId chargeId,
                                                                       MoneyLike money,
                                                                       RefundReason reason)

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

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
```
ResourceMonitor<? extends Refund> refundCompletionMonitor(StoreId storeId,
                                                          ChargeId chargeId,
                                                          RefundId refundId)
```
Create a ResourceMonitor that awaits the refund complete. ResourceMonitor.await() will wait until the refund status is other than 'pending'.

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

AbstractCancelsBuilders.AbstractListAllCancelsRequestBuilder listCancels(StoreId storeId,
                                                                         ChargeId chargeId)

List all the cancels associated with a charge

Parameters:: storeId -; chargeId -
Returns:: a ListAllCancelsRequestBuilder

getCancel

AbstractCancelsBuilders.AbstractGetCancelRequestBuilder getCancel(StoreId storeId,
                                                                  ChargeId chargeId,
                                                                  CancelId cancelId)

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

Parameters:: storeId -; chargeId -; cancelId -
Returns:: a request builder

cancelCompletionMonitor

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

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

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

AbstractCancelsBuilders.AbstractCreateCancelRequestBuilder createCancel(StoreId storeId,
                                                                        ChargeId chargeId)

Create a cancel for charge chargeId and store storeId

Parameters:: storeId -; chargeId -
Returns:: a request builder

updateCancel

AbstractCancelsBuilders.AbstractUpdateCancelRequestBuilder updateCancel(StoreId storeId,
                                                                        ChargeId chargeId,
                                                                        CancelId cancelId)

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

Parameters:: storeId -; chargeId -; cancelId -
Returns:: a request builder

listBankAccounts
```
AbstractBankAccountsBuilders.AbstractListAllBankAccountsRequestBuilder listBankAccounts()
```
Obtain a list of the bank accounts registered by the merchant.

Returns:

a request builder that implements

getBankAccount
```
AbstractBankAccountsBuilders.AbstractGetBankAccountRequestBuilder getBankAccount(BankAccountId bankAccountId)
```
Get detailed information about a bank account with ID bankAccountId

Parameters:

bankAccountId - the ID of the bank account to be queried

Returns:

a request builder

createBankAccount
```
AbstractBankAccountsBuilders.AbstractCreateBankAccountRequestBuilder createBankAccount(JapaneseBankAccount bankAccount)
```
Register a new bank account.

Parameters:

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

Returns:

a request builder

See Also:

JapaneseBankAccount

updateBankAccount
```
AbstractBankAccountsBuilders.AbstractUpdateBankAccountRequestBuilder updateBankAccount(BankAccountId bankAccountId)
```
Update the information associated with the bank account with ID bankAccountId

Parameters:

bankAccountId - the ID of the bank account to be updated

Returns:

a request builder

deleteBankAccount
```
AbstractBankAccountsBuilders.AbstractDeleteBankAccountRequestBuilder deleteBankAccount(BankAccountId bankAccountId)
```
Delete the bank account with ID bankAccountId

Parameters:

bankAccountId - the ID of the bank account to be deleted

Returns:

a request builder

getPrimaryBankAccount
```
AbstractBankAccountsBuilders.AbstractGetPrimaryBankAccountRequestBuilder getPrimaryBankAccount()
```
Obtain detailed information on the primary bank account of the merchant.

Returns:

a request builder

getMerchantVerification
```
AbstractMerchantsBuilders.AbstractGetMerchantVerificationRequestBuilder getMerchantVerification()
```
Obtain the information submitted by the merchant for verification.

Returns:

a request builder

updateMerchantVerification
```
AbstractMerchantsBuilders.AbstractUpdateMerchantVerificationRequestBuilder updateMerchantVerification()
```
Update the information submitted by the merchant for verification.

Returns:

a request builder

createMerchantVerification

AbstractMerchantsBuilders.AbstractCreateMerchantVerificationRequestBuilder createMerchantVerification(URL homepageUrl,
                                                                                                      String companyDescription,
                                                                                                      MerchantCompanyContactInfo companyContactInfo,
                                                                                                      BusinessType businessType,
                                                                                                      String systemManagerName)

Submits the merchant's information requesting for verification.

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

AbstractMerchantsBuilders.AbstractGetMeRequestBuilder getMe()

Gets the merchant's information

Returns:: a request builder

getTransactionHistory
```
AbstractMerchantsBuilders.AbstractGetTransactionHistoryRequestBuilder getTransactionHistory(StoreId storeId)
```
Obtain a list of transactions of the store.

Parameters:

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

Returns:

a request builder that implements

getTransactionHistory
```
AbstractMerchantsBuilders.AbstractGetTransactionHistoryRequestBuilder getTransactionHistory()
```
Obtain a list of all transactions of the merchant.

Returns:

a request builder that implements

listWebhooks

AbstractWebhookBuilders.AbstractListWebhookMerchantRequestBuilder listWebhooks()

Obtain a list of the webhooks.

Returns:: a request builder

getWebhook
```
AbstractWebhookBuilders.AbstractGetWebhookMerchantRequestBuilder getWebhook(WebhookId webhookId)
```
Obtain detailed information on a webhook with ID webhookId.

Parameters:

webhookId - the ID of the webhook to be queried

Returns:

a request builder

createWebhook

AbstractWebhookBuilders.AbstractCreateWebhookMerchantRequestBuilder createWebhook(URL url)

Create a new webhook.

Parameters:: url - the webhook's URL
Returns:: a request builder

updateWebhook
```
AbstractWebhookBuilders.AbstractUpdateWebhookMerchantRequestBuilder updateWebhook(WebhookId webhookId)
```
Update a webhook with ID webhookId.

Parameters:

webhookId - the ID of the webhook that will be updated

Returns:

a request builder

deleteWebhook
```
AbstractWebhookBuilders.AbstractDeleteWebhookMerchantRequestBuilder deleteWebhook(WebhookId webhookId)
```
Delete the webhook with ID webhookId.

Parameters:

webhookId - the ID of the webhook to be deleted

Returns:

a request builder that implements Request of type Void

listWebhooks
```
AbstractWebhookBuilders.AbstractListWebhookRequestBuilder listWebhooks(StoreId storeId)
```
Obtain a list of the webhooks associated with a store with ID storeId.

Parameters:

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

Returns:

a request builder

getWebhook
```
AbstractWebhookBuilders.AbstractGetWebhookRequestBuilder getWebhook(StoreId storeId,
                                                                    WebhookId webhookId)
```
Obtain detailed information on a webhook with ID webhookId associated with the store with ID storeId.

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

AbstractWebhookBuilders.AbstractCreateWebhookRequestBuilder createWebhook(StoreId storeId,
                                                                          URL url)

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

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

AbstractWebhookBuilders.AbstractUpdateWebhookRequestBuilder updateWebhook(StoreId storeId,
                                                                          WebhookId webhookId)

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

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

AbstractWebhookBuilders.AbstractDeleteWebhookRequestBuilder deleteWebhook(StoreId storeId,
                                                                          WebhookId webhookId)

Delete the webhook with ID webhookId.

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

AbstractTransactionTokensBuilders.AbstractCreateTransactionTokenRequestBuilder createTransactionToken(String email,
                                                                                                      PaymentData paymentData,
                                                                                                      TransactionTokenType type)

Create a new transaction token.

Parameters:: email - the email address of the person making the payment; paymentData - instance of CreditCard, QRScanData, KonbiniPayment or ApplePay
Returns:: a request builder.

deleteTransactionToken

AbstractTransactionTokensBuilders.AbstractDeleteTransactionTokenRequestBuilder deleteTransactionToken(StoreId storeId,
                                                                                                      TransactionTokenId tokenId)

Delete a transaction token.

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

AbstractTransactionTokensBuilders.AbstractGetTransactionTokenRequestBuilder getTransactionToken(StoreId storeId,
                                                                                                TransactionTokenId tokenId)

Get an existing transaction token.

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

AbstractTransactionTokensBuilders.AbstractUpdateTransactionTokenRequestBuilder updateTransactionToken(StoreId storeId,
                                                                                                      TransactionTokenId tokenId)

Update a recurring transaction token.

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

AbstractTransactionTokensBuilders.AbstractListTransactionTokensRequestBuilder listTransactionTokens(StoreId storeId)

List recurring transaction tokens.

Parameters:: storeId - the ID of the store
Returns:: a request builder

listTransactionTokens

AbstractTransactionTokensBuilders.AbstractListTransactionTokensMerchantRequestBuilder listTransactionTokens()

List recurring transaction tokens.

Returns:: a request builder

createTokenAlias

AbstractTransactionTokensBuilders.AbstractCreateTemporaryTokenAliasRequestBuilder createTokenAlias(TransactionTokenId transactionTokenId)

Create an alias for an existing transaction token

Parameters:: transactionTokenId -
Returns:: a request builder

getTokenAlias

AbstractTransactionTokensBuilders.AbstractGetTemporaryTokenAliasRequestBuilder getTokenAlias(StoreId storeId,
                                                                                             TemporaryTokenAliasId aliasId)

Get an existing temporary transaction token alias

Parameters:: storeId - the ID of the store; aliasId - the ID of the temporary alias
Returns:: a request builder

getTokenAliasImage

AbstractTransactionTokensBuilders.AbstractGetTemporaryTokenAliasAsImageRequestBuilder getTokenAliasImage(StoreId storeId,
                                                                                                         TemporaryTokenAliasId aliasId)

Get the token alias image as binary data

Parameters:: storeId - the ID of the store; aliasId - the ID of the temporary alias
Returns:: a request builder

deleteTokenAlias

AbstractTransactionTokensBuilders.AbstractDeleteTemporaryTokenAliasRequestBuilder deleteTokenAlias(StoreId storeId,
                                                                                                   TemporaryTokenAliasId aliasId)

Delete a temporary transaction token alias

Parameters:: storeId - the ID of the store; aliasId - the ID of the temporary alias to be deleted
Returns:: a request builder

listLedgers
```
AbstractLedgersBuilders.AbstractListLedgersRequestBuilder listLedgers(TransferId transferId)
```
List ledgers associated with a transfer.

Parameters:

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

Returns:

a request builder

createCustomerId

AbstractStoreBuilders.AbstractCreateCustomerIdRequestBuilder createCustomerId(StoreId storeId,
                                                                              String customerId)

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

Parameters:: customerId -
Returns:: a request builder

convertMoney

AbstractExchangeRateBuilders.AbstractConvertMoneyBuilder convertMoney(MoneyLike moneyToConvert,
                                                                      String targetCurrency)

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

Parameters:: moneyToConvert -; targetCurrency -
Returns:: a request builder

Interface SDKMethods<T extends AbstractSDK>

Method Summary

Method Detail

copy

copy

copy

getLoginToken

getLoginToken

logout

listStores

getStore

createStore

updateStore

deleteStore

getCheckoutInfo

getCheckoutInfo

listAppTokens

deleteAppToken

createAppToken

createAppToken

updateAppToken

createMerchantAppJWT

listMerchantAppJWT

deleteAppJWT

createStoreAppJWT

listStoreAppJWT

deleteAppJWT

listTransfers

getTransfer

listCharges

listCharges

getCharge

chargeCompletionMonitor

createCharge

createCharge

createCharge

createCharge

batchCreateCharge

batchCreateCharge

authorizeCharge

authorizeCharge

captureAuthorizedCharge

captureAuthorizedCharge

updateCharge

listSubscriptions

listSubscriptions

getSubscription

listScheduledPayments

getScheduledPayment

updateScheduledPayment

subscriptionCompletionMonitor

createSubscription

createSubscription

updateSubscription

listChargesForPayment

listSubscriptionCharges

deleteSubscription

simulateSubscriptionPlan

simulateSubscriptionPlan

listRefunds

getRefund

createRefund

createRefund

refundCompletionMonitor

listCancels

getCancel

cancelCompletionMonitor

createCancel

updateCancel

listBankAccounts

getBankAccount

createBankAccount

updateBankAccount

deleteBankAccount

getPrimaryBankAccount

getMerchantVerification

updateMerchantVerification

createMerchantVerification

getMe

getTransactionHistory