| Package | Description |
|---|---|
| org.killbill.billing.entitlement.api | |
| org.killbill.billing.payment.api | |
| org.killbill.billing.payment.plugin.api |
| Modifier and Type | Method and Description |
|---|---|
void |
SubscriptionApi.addBlockingState(BlockingState blockingState,
org.joda.time.LocalDate effectiveDate,
Iterable<PluginProperty> properties,
CallContext context)
Add a
BlockingState
The date is interpreted by the system to be in the timezone specified at the Account |
Entitlement |
EntitlementApi.addEntitlement(UUID bundleId,
PlanPhaseSpecifier spec,
List<PlanPhasePriceOverride> overrides,
org.joda.time.LocalDate entitlementEffectiveDate,
org.joda.time.LocalDate billingEffectiveDate,
boolean isMigrated,
Iterable<PluginProperty> properties,
CallContext context)
Adds an ADD_ON entitlement to previously created entitlement.
|
Entitlement |
Entitlement.cancelEntitlementWithDate(org.joda.time.LocalDate effectiveDate,
boolean overrideBillingEffectiveDate,
Iterable<PluginProperty> properties,
CallContext context)
Cancels the
Entitlement at the specified date. |
Entitlement |
Entitlement.cancelEntitlementWithDateOverrideBillingPolicy(org.joda.time.LocalDate effectiveDate,
BillingActionPolicy billingPolicy,
Iterable<PluginProperty> properties,
CallContext context)
Cancels the
Entitlement at the specified date
After this operation, the existing object becomes stale. |
Entitlement |
Entitlement.cancelEntitlementWithPolicy(Entitlement.EntitlementActionPolicy policy,
Iterable<PluginProperty> properties,
CallContext context)
Cancel the
Entitlement with a policy. |
Entitlement |
Entitlement.cancelEntitlementWithPolicyOverrideBillingPolicy(Entitlement.EntitlementActionPolicy policy,
BillingActionPolicy billingPolicy,
Iterable<PluginProperty> properties,
CallContext context)
Cancels the
Entitlement at the specified date and overrides the default billing policy. |
Entitlement |
Entitlement.changePlan(String productName,
BillingPeriod billingPeriod,
String priceList,
List<PlanPhasePriceOverride> overrides,
Iterable<PluginProperty> properties,
CallContext context)
Change
Entitlement plan using default policy. |
Entitlement |
Entitlement.changePlanOverrideBillingPolicy(String productName,
BillingPeriod billingPeriod,
String priceList,
List<PlanPhasePriceOverride> overrides,
org.joda.time.LocalDate effectiveDate,
BillingActionPolicy billingPolicy,
Iterable<PluginProperty> properties,
CallContext context)
Change
Entitlement plan at the specified date and overrides the billing policy. |
Entitlement |
Entitlement.changePlanWithDate(String productName,
BillingPeriod billingPeriod,
String priceList,
List<PlanPhasePriceOverride> overrides,
org.joda.time.LocalDate effectiveDate,
Iterable<PluginProperty> properties,
CallContext context)
Change
Entitlement plan at the specified date. |
Entitlement |
EntitlementApi.createBaseEntitlement(UUID accountId,
PlanPhaseSpecifier spec,
String externalKey,
List<PlanPhasePriceOverride> overrides,
org.joda.time.LocalDate entitlementEffectiveDate,
org.joda.time.LocalDate billingEffectiveDate,
boolean isMigrated,
Iterable<PluginProperty> properties,
CallContext context)
Create a new entitlement for that account.
|
Entitlement |
EntitlementApi.createBaseEntitlementWithAddOns(UUID accountId,
String externalKey,
Iterable<EntitlementSpecifier> entitlementSpecifier,
org.joda.time.LocalDate entitlementEffectiveDate,
org.joda.time.LocalDate billingEffectiveDate,
boolean isMigrated,
Iterable<PluginProperty> properties,
CallContext context)
Create a new base entitlement and addOn entitlements for that account.
|
void |
EntitlementApi.pause(UUID bundleId,
org.joda.time.LocalDate effectiveDate,
Iterable<PluginProperty> properties,
CallContext context)
Will pause all entitlements associated with the base entitlement.
|
void |
EntitlementApi.resume(UUID bundleId,
org.joda.time.LocalDate effectiveDate,
Iterable<PluginProperty> properties,
CallContext context)
Will resume all entitlements associated with the base entitlement.
|
UUID |
EntitlementApi.transferEntitlements(UUID sourceAccountId,
UUID destAccountId,
String externalKey,
org.joda.time.LocalDate effectiveDate,
Iterable<PluginProperty> properties,
CallContext context)
Transfer all the
Entitlement For the source account and matching the external key to the destination account. |
UUID |
EntitlementApi.transferEntitlementsOverrideBillingPolicy(UUID sourceAccountId,
UUID destAccountId,
String externalKey,
org.joda.time.LocalDate effectiveDate,
BillingActionPolicy billingPolicy,
Iterable<PluginProperty> properties,
CallContext context)
Transfer all the
Entitlement for the source account and matching the external key to the destination account. |
void |
Entitlement.uncancelEntitlement(Iterable<PluginProperty> properties,
CallContext context)
Removes a pending future cancellation on an entitlement.
|
| Modifier and Type | Method and Description |
|---|---|
List<PluginProperty> |
PaymentMethodPlugin.getProperties() |
| Modifier and Type | Method and Description |
|---|---|
UUID |
PaymentApi.addPaymentMethod(Account account,
String paymentMethodExternalKey,
String pluginName,
boolean setDefault,
PaymentMethodPlugin paymentMethodInfo,
Iterable<PluginProperty> properties,
CallContext context) |
HostedPaymentPageFormDescriptor |
PaymentGatewayApi.buildFormDescriptor(Account account,
UUID paymentMethodId,
Iterable<PluginProperty> customFields,
Iterable<PluginProperty> properties,
CallContext context)
Build metadata for the client to create a redirect form
|
HostedPaymentPageFormDescriptor |
PaymentGatewayApi.buildFormDescriptor(Account account,
UUID paymentMethodId,
Iterable<PluginProperty> customFields,
Iterable<PluginProperty> properties,
CallContext context)
Build metadata for the client to create a redirect form
|
HostedPaymentPageFormDescriptor |
PaymentGatewayApi.buildFormDescriptorWithPaymentControl(Account account,
UUID paymentMethodId,
Iterable<PluginProperty> customFields,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Build metadata for the client to create a redirect form
|
HostedPaymentPageFormDescriptor |
PaymentGatewayApi.buildFormDescriptorWithPaymentControl(Account account,
UUID paymentMethodId,
Iterable<PluginProperty> customFields,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Build metadata for the client to create a redirect form
|
Payment |
PaymentApi.createAuthorization(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Authorize a payment.
|
Payment |
PaymentApi.createAuthorizationWithPaymentControl(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Authorize a payment and allow to go through registered routing plugins
|
Payment |
PaymentApi.createCapture(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Capture a previously authorized payment.
|
Payment |
PaymentApi.createCaptureWithPaymentControl(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Capture a previously authorized payment and allow to go through registered routing plugins
|
Payment |
PaymentApi.createCredit(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Credit a payment method.
|
Payment |
PaymentApi.createCreditWithPaymentControl(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Credit a payment method and allow to go through registered routing plugins
This is also known as payment in reverse.
|
Payment |
PaymentApi.createPurchase(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Combine an authorize and capture payment.
|
Payment |
PaymentApi.createPurchaseWithPaymentControl(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Combine an authorize and capture payment and allow to go through registered routing plugins
|
Payment |
PaymentApi.createRefund(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Refund a previously captured payment.
|
Payment |
PaymentApi.createRefundWithPaymentControl(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Refund a previously captured payment and allow to go through registered routing plugins
|
Payment |
PaymentApi.createVoid(Account account,
UUID paymentId,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Void a previously authorized payment.
|
Payment |
PaymentApi.createVoidWithPaymentControl(Account account,
UUID paymentId,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Void a previously authorized payment and allow to go through registered routing plugins
|
void |
PaymentApi.deletePaymentMethod(Account account,
UUID paymentMethodId,
boolean deleteDefaultPaymentMethodWithAutoPayOff,
Iterable<PluginProperty> properties,
CallContext context) |
void |
AdminPaymentApi.fixPaymentTransactionState(Payment payment,
PaymentTransaction paymentTransaction,
TransactionStatus transactionStatus,
String lastSuccessPaymentState,
String currentPaymentStateName,
Iterable<PluginProperty> properties,
CallContext context)
Modify the state for a given PaymentTransaction and its associated Payment.
|
List<PaymentMethod> |
PaymentApi.getAccountPaymentMethods(UUID accountId,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
List<Payment> |
PaymentApi.getAccountPayments(UUID accountId,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPayment(UUID paymentId,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPaymentByExternalKey(String paymentExternalKey,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
PaymentMethod |
PaymentApi.getPaymentMethodByExternalKey(String paymentMethodExternalKey,
boolean includedInactive,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
PaymentMethod |
PaymentApi.getPaymentMethodById(UUID paymentMethodId,
boolean includedInactive,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
Pagination<PaymentMethod> |
PaymentApi.getPaymentMethods(Long offset,
Long limit,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods across all plugins
|
Pagination<PaymentMethod> |
PaymentApi.getPaymentMethods(Long offset,
Long limit,
String pluginName,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods in a given plugin
|
Pagination<Payment> |
PaymentApi.getPayments(Long offset,
Long limit,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payments across all plugins
|
Pagination<Payment> |
PaymentApi.getPayments(Long offset,
Long limit,
String pluginName,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payments in a given plugin
|
GatewayNotification |
PaymentGatewayApi.processNotification(String notification,
String pluginName,
Iterable<PluginProperty> properties,
CallContext context)
Process a notification from the gateway
This potentially does more than just deserialize the payload.
|
GatewayNotification |
PaymentGatewayApi.processNotificationWithPaymentControl(String notification,
String pluginName,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Process a notification from the gateway
This potentially does more than just deserialize the payload.
|
List<PaymentMethod> |
PaymentApi.refreshPaymentMethods(Account account,
Iterable<PluginProperty> properties,
CallContext context)
Refresh all payment methods across all plugins
This call is not atomic.
|
List<PaymentMethod> |
PaymentApi.refreshPaymentMethods(Account account,
String pluginName,
Iterable<PluginProperty> properties,
CallContext context) |
Pagination<PaymentMethod> |
PaymentApi.searchPaymentMethods(String searchKey,
Long offset,
Long limit,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods matching the search key across all plugins
The match will be plugin specific: for instance some plugins will try to match the key
against the last 4 credit cards digits, agreement ids, etc.
|
Pagination<PaymentMethod> |
PaymentApi.searchPaymentMethods(String searchKey,
Long offset,
Long limit,
String pluginName,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods matching the search key in a given plugin
The match will be plugin specific: for instance some plugins will try to match the key
against the last 4 credit cards digits, agreement ids, etc.
|
Pagination<Payment> |
PaymentApi.searchPayments(String searchKey,
Long offset,
Long limit,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payments matching the search key across all plugins
The match will be plugin specific: for instance some plugins will try to match the key
against the transaction ids, etc.
|
Pagination<Payment> |
PaymentApi.searchPayments(String searchKey,
Long offset,
Long limit,
String pluginName,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payments matching the search key in a given plugin
The match will be plugin specific: for instance some plugins will try to match the key
against the transaction ids, etc.
|
void |
PaymentApi.setDefaultPaymentMethod(Account account,
UUID paymentMethodId,
Iterable<PluginProperty> properties,
CallContext context) |
| Modifier and Type | Method and Description |
|---|---|
List<PluginProperty> |
HostedPaymentPageFormDescriptor.getFormFields() |
List<PluginProperty> |
HostedPaymentPageFormDescriptor.getProperties() |
List<PluginProperty> |
PaymentTransactionInfoPlugin.getProperties() |
List<PluginProperty> |
GatewayNotification.getProperties() |
Copyright © 2010-2016. All Rights Reserved.