| Package | Description |
|---|---|
| org.killbill.billing.payment.api |
| Modifier and Type | Method and Description |
|---|---|
java.util.UUID |
PaymentApi.addPaymentMethod(Account account,
java.lang.String paymentMethodExternalKey,
java.lang.String pluginName,
boolean setDefault,
PaymentMethodPlugin paymentMethodInfo,
java.lang.Iterable<PluginProperty> properties,
CallContext context) |
java.util.UUID |
PaymentApi.addPaymentMethodWithPaymentControl(Account account,
java.lang.String paymentMethodExternalKey,
java.lang.String pluginName,
boolean setDefault,
PaymentMethodPlugin paymentMethodInfo,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context) |
HostedPaymentPageFormDescriptor |
PaymentGatewayApi.buildFormDescriptor(Account account,
java.util.UUID paymentMethodId,
java.lang.Iterable<PluginProperty> customFields,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Build metadata for the client to create a redirect form
|
HostedPaymentPageFormDescriptor |
PaymentGatewayApi.buildFormDescriptorWithPaymentControl(Account account,
java.util.UUID paymentMethodId,
java.lang.Iterable<PluginProperty> customFields,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Build metadata for the client to create a redirect form
|
void |
PaymentApi.cancelScheduledPaymentTransaction(java.lang.String paymentTransactionExternalKey,
CallContext context)
Cancel scheduled future payment retry
|
void |
PaymentApi.cancelScheduledPaymentTransaction(java.util.UUID paymentTransactionId,
CallContext context)
Cancel scheduled future payment retry
|
Payment |
PaymentApi.createAuthorization(Account account,
java.util.UUID paymentMethodId,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentExternalKey,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Authorize a payment.
|
Payment |
PaymentApi.createAuthorizationWithPaymentControl(Account account,
java.util.UUID paymentMethodId,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentExternalKey,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Authorize a payment and allow to go through registered routing plugins
|
Payment |
PaymentApi.createCapture(Account account,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Capture a previously authorized payment.
|
Payment |
PaymentApi.createCaptureWithPaymentControl(Account account,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Capture a previously authorized payment and allow to go through registered routing plugins
|
Payment |
PaymentApi.createChargeback(Account account,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
CallContext context)
Record a chargeback
|
InvoicePayment |
InvoicePaymentApi.createChargebackForInvoicePayment(Account account,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Record a chargeback and allow to go through registered routing plugins
|
Payment |
PaymentApi.createChargebackReversal(Account account,
java.util.UUID paymentId,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
CallContext context)
Reverse a chargeback
|
InvoicePayment |
InvoicePaymentApi.createChargebackReversalForInvoicePayment(Account account,
java.util.UUID paymentId,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Reverse a chargeback and allow to go through registered routing plugins
|
Payment |
PaymentApi.createChargebackReversalWithPaymentControl(Account account,
java.util.UUID paymentId,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
PaymentOptions paymentOptions,
CallContext context)
Reverse a chargeback
|
Payment |
PaymentApi.createChargebackWithPaymentControl(Account account,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
PaymentOptions paymentOptions,
CallContext context)
Record a chargeback
|
Payment |
PaymentApi.createCredit(Account account,
java.util.UUID paymentMethodId,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentExternalKey,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Credit a payment method.
|
InvoicePayment |
InvoicePaymentApi.createCreditForInvoicePayment(boolean isAdjusted,
java.util.Map<java.util.UUID,java.math.BigDecimal> adjustments,
Account account,
java.util.UUID originalPaymentId,
java.util.UUID paymentMethodId,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentExternalKey,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Credit a payment method for a given invoice and allow to go through registered routing plugins
This is also known as payment in reverse.
|
Payment |
PaymentApi.createCreditWithPaymentControl(Account account,
java.util.UUID paymentMethodId,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentExternalKey,
java.lang.String paymentTransactionExternalKey,
java.lang.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,
java.util.UUID paymentMethodId,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentExternalKey,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Combine an authorize and capture payment.
|
InvoicePayment |
InvoicePaymentApi.createPurchaseForInvoicePayment(Account account,
java.util.UUID invoiceId,
java.util.UUID paymentMethodId,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentExternalKey,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Combine an authorize and capture payment for a given invoice and allow to go through registered routing plugins
|
Payment |
PaymentApi.createPurchaseWithPaymentControl(Account account,
java.util.UUID paymentMethodId,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentExternalKey,
java.lang.String paymentTransactionExternalKey,
java.lang.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,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Refund a previously captured payment.
|
InvoicePayment |
InvoicePaymentApi.createRefundForInvoicePayment(boolean isAdjusted,
java.util.Map<java.util.UUID,java.math.BigDecimal> adjustments,
Account account,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Refund a previously captured payment and allow to go through registered routing plugins
|
Payment |
PaymentApi.createRefundWithPaymentControl(Account account,
java.util.UUID paymentId,
java.math.BigDecimal amount,
Currency currency,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
java.lang.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,
java.util.UUID paymentId,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Void a previously authorized payment.
|
Payment |
PaymentApi.createVoidWithPaymentControl(Account account,
java.util.UUID paymentId,
org.joda.time.DateTime effectiveDate,
java.lang.String paymentTransactionExternalKey,
java.lang.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,
java.util.UUID paymentMethodId,
boolean deleteDefaultPaymentMethodWithAutoPayOff,
boolean forceDefaultPaymentMethodDeletion,
java.lang.Iterable<PluginProperty> properties,
CallContext context) |
void |
AdminPaymentApi.fixPaymentTransactionState(Payment payment,
PaymentTransaction paymentTransaction,
TransactionStatus transactionStatus,
java.lang.String lastSuccessPaymentState,
java.lang.String currentPaymentStateName,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Modify the state for a given PaymentTransaction and its associated Payment.
|
java.util.List<PaymentMethod> |
PaymentApi.getAccountPaymentMethods(java.util.UUID accountId,
boolean includedInactive,
boolean withPluginInfo,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
java.util.List<Payment> |
PaymentApi.getAccountPayments(java.util.UUID accountId,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPayment(java.util.UUID paymentId,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPaymentByExternalKey(java.lang.String paymentExternalKey,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPaymentByTransactionExternalKey(java.lang.String transactionExternalKey,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPaymentByTransactionId(java.util.UUID transactionId,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
PaymentMethod |
PaymentApi.getPaymentMethodByExternalKey(java.lang.String paymentMethodExternalKey,
boolean includedInactive,
boolean withPluginInfo,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
PaymentMethod |
PaymentApi.getPaymentMethodById(java.util.UUID paymentMethodId,
boolean includedInactive,
boolean withPluginInfo,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
Pagination<PaymentMethod> |
PaymentApi.getPaymentMethods(java.lang.Long offset,
java.lang.Long limit,
java.lang.String pluginName,
boolean withPluginInfo,
java.lang.Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods in a given plugin
|
Pagination<Payment> |
PaymentApi.getPayments(java.lang.Long offset,
java.lang.Long limit,
java.lang.String pluginName,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context)
Find all payments in a given plugin
|
Payment |
PaymentApi.notifyPendingTransactionOfStateChanged(Account account,
java.util.UUID paymentTransactionId,
boolean isSuccess,
CallContext context)
Transition a currently PENDING transaction into either a SUCCESS or a FAILURE
|
Payment |
PaymentApi.notifyPendingTransactionOfStateChangedWithPaymentControl(Account account,
java.util.UUID paymentTransactionId,
boolean isSuccess,
PaymentOptions paymentOptions,
CallContext context)
Transition a currently PENDING transaction into either a SUCCESS or a FAILURE
|
GatewayNotification |
PaymentGatewayApi.processNotification(java.lang.String notification,
java.lang.String pluginName,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Process a notification from the gateway
This potentially does more than just deserialize the payload.
|
GatewayNotification |
PaymentGatewayApi.processNotificationWithPaymentControl(java.lang.String notification,
java.lang.String pluginName,
java.lang.Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Process a notification from the gateway
This potentially does more than just deserialize the payload.
|
java.util.List<PaymentMethod> |
PaymentApi.refreshPaymentMethods(Account account,
java.lang.Iterable<PluginProperty> properties,
CallContext context)
Refresh all payment methods across all plugins
This call is not atomic.
|
java.util.List<PaymentMethod> |
PaymentApi.refreshPaymentMethods(Account account,
java.lang.String pluginName,
java.lang.Iterable<PluginProperty> properties,
CallContext context) |
Pagination<PaymentMethod> |
PaymentApi.searchPaymentMethods(java.lang.String searchKey,
java.lang.Long offset,
java.lang.Long limit,
java.lang.String pluginName,
boolean withPluginInfo,
java.lang.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(java.lang.String searchKey,
java.lang.Long offset,
java.lang.Long limit,
java.lang.String pluginName,
boolean withPluginInfo,
boolean withAttempts,
java.lang.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,
java.util.UUID paymentMethodId,
java.lang.Iterable<PluginProperty> properties,
CallContext context) |
Copyright © 2010-2018. All Rights Reserved.