| Package | Description |
|---|---|
| org.killbill.billing.payment.api |
| 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
|
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.createChargeback(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
CallContext context)
Record a chargeback
|
Payment |
PaymentApi.createChargebackWithPaymentControl(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
PaymentOptions paymentOptions,
CallContext context)
Record a chargeback
|
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.
|
void |
PaymentApi.deletePaymentMethod(Account account,
UUID paymentMethodId,
boolean deleteDefaultPaymentMethodWithAutoPayOff,
Iterable<PluginProperty> properties,
CallContext context) |
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,
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,
String pluginName,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payments in a given plugin
|
Payment |
PaymentApi.notifyPendingTransactionOfStateChanged(Account account,
UUID paymentTransactionId,
boolean isSuccess,
CallContext context)
Transition a currently PENDING transaction into either a SUCCESS or a FAILURE
|
Payment |
PaymentApi.notifyPendingTransactionOfStateChangedWithPaymentControl(Account account,
UUID paymentTransactionId,
boolean isSuccess,
PaymentOptions paymentOptions,
CallContext context)
Transition a currently PENDING transaction into either a SUCCESS or a FAILURE
|
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.
|
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,
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,
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) |
Copyright © 2010-2015. All Rights Reserved.