| Package | Description |
|---|---|
| Api | |
| Invokers |
| Modifier and Type | Method and Description |
|---|---|
okhttp3.Call |
DecisionManagerApi.actionDecisionManagerCaseAsync(String id,
CaseManagementActionsRequest caseManagementActionsRequest,
ApiCallback<InlineResponse200> callback)
Take action on a DM post-transactional case (asynchronously)
Take action on a DM post-transactional case
|
okhttp3.Call |
PlansApi.activatePlanAsync(String id,
ApiCallback<ActivateDeactivatePlanResponse> callback)
Activate a Plan (asynchronously)
Activate a Plan
|
okhttp3.Call |
SubscriptionsApi.activateSubscriptionAsync(String id,
ApiCallback<ActivateSubscriptionResponse> callback)
Activate a Subscription (asynchronously)
Activate a `CANCELLED` Or `SUSPENDED` Subscription
|
okhttp3.Call |
DecisionManagerApi.addNegativeAsync(String type,
AddNegativeListRequest addNegativeListRequest,
ApiCallback<RiskV1UpdatePost201Response> callback)
List Management (asynchronously)
This call adds/deletes/converts the request information in the negative list.
|
okhttp3.Call |
ReversalApi.authReversalAsync(String id,
AuthReversalRequest authReversalRequest,
ApiCallback<PtsV2PaymentsReversalsPost201Response> callback)
Process an Authorization Reversal (asynchronously)
Include the payment ID in the POST request to reverse the payment amount.
|
okhttp3.Call |
BillingAgreementsApi.billingAgreementsDeRegistrationAsync(ModifyBillingAgreement modifyBillingAgreement,
String id,
ApiCallback<PtsV2ModifyBillingAgreementPost201Response> callback)
Modify a Billing Agreement (asynchronously)
#### Standing Instruction: Standing Instruction with or without Token.
|
okhttp3.Call |
BillingAgreementsApi.billingAgreementsIntimationAsync(IntimateBillingAgreement intimateBillingAgreement,
String id,
ApiCallback<PtsV2CreditsPost201Response1> callback)
Standing Instruction intimation (asynchronously)
Standing Instruction with or without Token.
|
okhttp3.Call |
BillingAgreementsApi.billingAgreementsRegistrationAsync(CreateBillingAgreement createBillingAgreement,
ApiCallback<PtsV2CreateBillingAgreementPost201Response> callback)
Create a Billing Agreement (asynchronously)
#### Standing Instruction: Standing Instruction with or without Token.
|
okhttp3.Call |
TaxesApi.calculateTaxAsync(TaxRequest taxRequest,
ApiCallback<VasV2PaymentsPost201Response> callback)
Calculate Taxes (asynchronously)
The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide.
|
okhttp3.Call |
SubscriptionsApi.cancelSubscriptionAsync(String id,
ApiCallback<CancelSubscriptionResponse> callback)
Cancel a Subscription (asynchronously)
Cancel a Subscription
|
okhttp3.Call |
CaptureApi.capturePaymentAsync(CapturePaymentRequest capturePaymentRequest,
String id,
ApiCallback<PtsV2PaymentsCapturesPost201Response> callback)
Capture a Payment (asynchronously)
Include the payment ID in the POST request to capture the payment amount.
|
okhttp3.Call |
PayerAuthenticationApi.checkPayerAuthEnrollmentAsync(CheckPayerAuthEnrollmentRequest checkPayerAuthEnrollmentRequest,
ApiCallback<RiskV1AuthenticationsPost201Response> callback)
Check Payer Auth Enrollment (asynchronously)
This call verifies that the card is enrolled in a card authentication program.
|
okhttp3.Call |
DecisionManagerApi.commentDecisionManagerCaseAsync(String id,
CaseManagementCommentsRequest caseManagementCommentsRequest,
ApiCallback<InlineResponse201> callback)
Add a comment to a DM post-transactional case (asynchronously)
Add a comment to a DM post-transactional case
|
okhttp3.Call |
DecisionManagerApi.createBundledDecisionManagerCaseAsync(CreateBundledDecisionManagerCaseRequest createBundledDecisionManagerCaseRequest,
ApiCallback<RiskV1DecisionsPost201Response> callback)
Create Decision Manager (asynchronously)
Decision Manager can help you automate and streamline your fraud operations.
|
okhttp3.Call |
CreditApi.createCreditAsync(CreateCreditRequest createCreditRequest,
ApiCallback<PtsV2CreditsPost201Response> callback)
Process a Credit (asynchronously)
POST to the credit resource to credit funds to a specified credit card.
|
okhttp3.Call |
InvoicesApi.createInvoiceAsync(CreateInvoiceRequest createInvoiceRequest,
ApiCallback<InvoicingV2InvoicesPost201Response> callback)
Create a New Invoice (asynchronously)
The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device.
|
okhttp3.Call |
OrdersApi.createOrderAsync(CreateOrderRequest createOrderRequest,
ApiCallback<PtsV2CreateOrderPost201Response> callback)
Create an Order (asynchronously)
A create order request enables you to send the itemized details along with the order.
|
okhttp3.Call |
PaymentsApi.createOrderRequestAsync(OrderPaymentRequest orderPaymentRequest,
String id,
ApiCallback<PtsV2PaymentsOrderPost201Response> callback)
Create a Payment Order Request (asynchronously)
Create a Payment Order Request
|
okhttp3.Call |
PaymentsApi.createPaymentAsync(CreatePaymentRequest createPaymentRequest,
ApiCallback<PtsV2PaymentsPost201Response> callback)
Process a Payment (asynchronously)
A payment authorizes the amount for the transaction.
|
okhttp3.Call |
PlansApi.createPlanAsync(CreatePlanRequest createPlanRequest,
ApiCallback<CreatePlanResponse> callback)
Create a Plan (asynchronously)
The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules.
|
okhttp3.Call |
PushFundsApi.createPushFundsTransferAsync(PushFundsRequest pushFundsRequest,
String contentType,
String xRequestid,
String vCMerchantId,
String vCPermissions,
String vCCorrelationId,
String vCOrganizationId,
ApiCallback<PushFunds201Response> callback)
Process a Push Funds Transfer (asynchronously)
Receive funds using an Original Credit Transaction (OCT).
|
okhttp3.Call |
ReportsApi.createReportAsync(CreateAdhocReportRequest createAdhocReportRequest,
String organizationId,
ApiCallback<Void> callback)
Create Adhoc Report (asynchronously)
Create a one-time report.
|
okhttp3.Call |
SearchTransactionsApi.createSearchAsync(CreateSearchRequest createSearchRequest,
ApiCallback<TssV2TransactionsPost201Response> callback)
Create a Search Request (asynchronously)
Create a search request.
|
okhttp3.Call |
PaymentsApi.createSessionRequestAsync(CreateSessionReq createSessionReq,
ApiCallback<PtsV2PaymentsPost201Response2> callback)
Create Alternative Payments Sessions Request (asynchronously)
Create Alternative Payments Sessions Request
|
okhttp3.Call |
ReportSubscriptionsApi.createStandardOrClassicSubscriptionAsync(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean,
String organizationId,
ApiCallback<Void> callback)
Create a Standard or Classic Subscription (asynchronously)
Create or update an already existing classic or standard subscription.
|
okhttp3.Call |
ReportSubscriptionsApi.createSubscriptionAsync(CreateReportSubscriptionRequest createReportSubscriptionRequest,
String organizationId,
ApiCallback<Void> callback)
Create Report Subscription for a Report Name by Organization (asynchronously)
Create a report subscription for your organization.
|
okhttp3.Call |
SubscriptionsApi.createSubscriptionAsync(CreateSubscriptionRequest createSubscriptionRequest,
ApiCallback<CreateSubscriptionResponse> callback)
Create a Subscription (asynchronously)
Create a Recurring Billing Subscription
|
okhttp3.Call |
CreateNewWebhooksApi.createWebhookSubscriptionAsync(CreateWebhookRequest createWebhookRequest,
ApiCallback<InlineResponse2014> callback)
Create a Webhook (asynchronously)
Create a new webhook subscription.
|
okhttp3.Call |
PlansApi.deactivatePlanAsync(String id,
ApiCallback<ActivateDeactivatePlanResponse> callback)
Deactivate a Plan (asynchronously)
Deactivate a Plan
|
okhttp3.Call |
CustomerApi.deleteCustomerAsync(String customerId,
String profileId,
ApiCallback<Void> callback)
Delete a Customer (asynchronously)
| | | | | --- | --- | --- | |**Customers**<br>A Customer represents your tokenized customer information.<br>You should associate the Customer Id with the customer account on your systems.<br>A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.| |**Deleting a Customer**<br>Your system can use this API to delete a complete Customer.<br>When a Customer is deleted all associated Payment Instruments & Shipping Addresses are deleted.<br>Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.<br>Note: Individual [Payment Instruments](#token-management_customer-payment-instrument_delete-a-customer-payment-instrument) or [Shipping Addresses](#token-management_customer-shipping-address_delete-a-customer-shipping-address) can be deleted via their own dedicated API resources.
|
okhttp3.Call |
CustomerPaymentInstrumentApi.deleteCustomerPaymentInstrumentAsync(String customerId,
String paymentInstrumentId,
String profileId,
ApiCallback<Void> callback)
Delete a Customer Payment Instrument (asynchronously)
| | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
|
okhttp3.Call |
CustomerShippingAddressApi.deleteCustomerShippingAddressAsync(String customerId,
String shippingAddressId,
String profileId,
ApiCallback<Void> callback)
Delete a Customer Shipping Address (asynchronously)
| | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.| |**Deleting a Customers Shipping Address**<br>Your system can use this API to delete an existing Shipping Address for a Customer.<br>If a customer has more than one Shipping Address then the default Shipping Address cannot be deleted without first selecting a [new default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body).
|
okhttp3.Call |
InstrumentIdentifierApi.deleteInstrumentIdentifierAsync(String instrumentIdentifierId,
String profileId,
ApiCallback<Void> callback)
Delete an Instrument Identifier (asynchronously)
| | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Deleting an Instrument Identifier**<br>Your system can use this API to delete an existing Instrument Identifier.<br>An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.<br>You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
|
okhttp3.Call |
PaymentInstrumentApi.deletePaymentInstrumentAsync(String paymentInstrumentId,
String profileId,
ApiCallback<Void> callback)
Delete a Payment Instrument (asynchronously)
| | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
|
okhttp3.Call |
PlansApi.deletePlanAsync(String id,
ApiCallback<DeletePlanResponse> callback)
Delete a Plan (asynchronously)
Delete a Plan is only allowed: - plan status is in `DRAFT` - plan status is in `ACTIVE`, and `INACTIVE` only allowed when no subscriptions attached to a plan in the lifetime of a plan
|
okhttp3.Call |
ReportSubscriptionsApi.deleteSubscriptionAsync(String reportName,
String organizationId,
ApiCallback<Void> callback)
Delete Subscription of a Report Name by Organization (asynchronously)
Delete a report subscription for your organization.
|
okhttp3.Call |
ManageWebhooksApi.deleteWebhookSubscriptionAsync(String webhookId,
ApiCallback<Void> callback)
Delete a Webhook Subscription (asynchronously)
Delete the webhook.
|
okhttp3.Call |
ReportDownloadsApi.downloadReportAsync(org.joda.time.LocalDate reportDate,
String reportName,
String organizationId,
ApiCallback<Void> callback)
Download a Report (asynchronously)
Download a report using the unique report name and date.
|
okhttp3.Call |
CreateNewWebhooksApi.findProductsToSubscribeAsync(String organizationId,
ApiCallback<List<InlineResponse2002>> callback)
Find Products You Can Subscribe To (asynchronously)
Retrieve a list of products and event types that your account is eligible for.
|
okhttp3.Call |
DecisionManagerApi.fraudUpdateAsync(String id,
FraudMarkingActionRequest fraudMarkingActionRequest,
ApiCallback<RiskV1UpdatePost201Response> callback)
Fraud Marking (asynchronously)
This can be used to - 1.
|
okhttp3.Call |
MicroformIntegrationApi.generateCaptureContextAsync(GenerateCaptureContextRequest generateCaptureContextRequest,
ApiCallback<String> callback)
Generate Capture Context (asynchronously)
This API is used to generate the Capture Context data structure for the Microform Integration.
|
okhttp3.Call |
FlexApiApi.generateFlexAPICaptureContextAsync(GenerateFlexAPICaptureContextRequest generateFlexAPICaptureContextRequest,
ApiCallback<String> callback)
Establish a Payment Session with a Capture Context (asynchronously)
To establish a payment session, include the API fields you plan to use in that session in the body of the request.
|
okhttp3.Call |
UnifiedCheckoutCaptureContextApi.generateUnifiedCheckoutCaptureContextAsync(GenerateUnifiedCheckoutCaptureContextRequest generateUnifiedCheckoutCaptureContextRequest,
ApiCallback<String> callback)
Generate Unified Checkout Capture Context (asynchronously)
Unified Checkout is a powerful product within the Digital Acceptance Suite.
|
okhttp3.Call |
BinLookupApi.getAccountInfoAsync(CreateBinLookupRequest createBinLookupRequest,
ApiCallback<InlineResponse2011> callback)
BIN Lookup API (asynchronously)
The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources.
|
okhttp3.Call |
InvoicesApi.getAllInvoicesAsync(Integer offset,
Integer limit,
String status,
ApiCallback<InvoicingV2InvoicesAllGet200Response> callback)
Get a List of Invoices (asynchronously)
Provides a (filtered) list of invoices that have been created in your account.
|
okhttp3.Call |
SubscriptionsApi.getAllSubscriptionsAsync(Integer offset,
Integer limit,
String code,
String status,
ApiCallback<GetAllSubscriptionsResponse> callback)
Get a List of Subscriptions (asynchronously)
Retrieve Subscriptions by Subscription Code & Subscription Status.
|
okhttp3.Call |
ReportSubscriptionsApi.getAllSubscriptionsAsync(String organizationId,
ApiCallback<ReportingV3ReportSubscriptionsGet200Response> callback)
Get All Subscriptions (asynchronously)
View a summary of all report subscriptions.
|
okhttp3.Call |
BatchesApi.getBatchesListAsync(Long offset,
Long limit,
String fromDate,
String toDate,
ApiCallback<InlineResponse2005> callback)
List Batches (asynchronously)
**List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id.
|
okhttp3.Call |
BatchesApi.getBatchReportAsync(String batchId,
ApiCallback<InlineResponse2007> callback)
Retrieve a Batch Report (asynchronously)
**Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status.
|
okhttp3.Call |
BatchesApi.getBatchStatusAsync(String batchId,
ApiCallback<InlineResponse2006> callback)
Retrieve a Batch Status (asynchronously)
**Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status.
|
okhttp3.Call |
ChargebackDetailsApi.getChargebackDetailsAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ApiCallback<ReportingV3ChargebackDetailsGet200Response> callback)
Get Chargeback Details (asynchronously)
Chargeback Detail Report Description
|
okhttp3.Call |
ChargebackSummariesApi.getChargebackSummariesAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ApiCallback<ReportingV3ChargebackSummariesGet200Response> callback)
Get Chargeback Summaries (asynchronously)
Chargeback Summary Report Description
|
okhttp3.Call |
ConversionDetailsApi.getConversionDetailAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ApiCallback<ReportingV3ConversionDetailsGet200Response> callback)
Get Conversion Detail Transactions (asynchronously)
Get conversion detail of transactions for a merchant.
|
okhttp3.Call |
CustomerApi.getCustomerAsync(String customerId,
String profileId,
ApiCallback<PostCustomerRequest> callback)
Retrieve a Customer (asynchronously)
| | | | | --- | --- | --- | |**Customers**<br>A Customer represents your tokenized customer information.<br>You should associate the Customer Id with the customer account on your systems.<br>A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.<br><br>**Retrieving a Customer**<br>When your customer signs into their account, your system can use this API to retrieve the Customers default Payment Instrument and Shipping Address.<br>**Note: the actual card data will be masked.**<br>If your customer wants to see other available Payment Instruments, your system can [retrieve all Payment Instruments](#token-management_customer-payment-instrument_list-payment-instruments-for-a-customer) associated with the Customer.<br>The same applies to [Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer).| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Customers**<br>To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).<br>To perform a payment with a particular Payment Instrument or Shipping Address <br>specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).
|
okhttp3.Call |
CustomerPaymentInstrumentApi.getCustomerPaymentInstrumentAsync(String customerId,
String paymentInstrumentId,
String profileId,
ApiCallback<PostCustomerPaymentInstrumentRequest> callback)
Retrieve a Customer Payment Instrument (asynchronously)
| | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
|
okhttp3.Call |
CustomerPaymentInstrumentApi.getCustomerPaymentInstrumentsListAsync(String customerId,
String profileId,
Long offset,
Long limit,
ApiCallback<PaymentInstrumentList> callback)
List Payment Instruments for a Customer (asynchronously)
| | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
|
okhttp3.Call |
CustomerShippingAddressApi.getCustomerShippingAddressAsync(String customerId,
String shippingAddressId,
String profileId,
ApiCallback<PostCustomerShippingAddressRequest> callback)
Retrieve a Customer Shipping Address (asynchronously)
| | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.| |**Retrieving a Customer Shipping Address**<br>Your system can use this API to retrieve an existing Shipping Address for a Customer.<br>To perform a payment with a particular Shipping Address simply specify the [Shipping Address Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).
|
okhttp3.Call |
CustomerShippingAddressApi.getCustomerShippingAddressesListAsync(String customerId,
String profileId,
Long offset,
Long limit,
ApiCallback<ShippingAddressListForCustomer> callback)
List Shipping Addresses for a Customer (asynchronously)
| | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.| |**Retrieving all Customer Shipping Addresses**<br>Your system can use this API to retrieve all existing Shipping Addresses for a Customer.
|
okhttp3.Call |
DownloadDtdApi.getDTDV2Async(String reportDefinitionNameVersion,
ApiCallback<Void> callback)
Download DTD for Report (asynchronously)
Used to download DTDs for reports on no-auth.
|
okhttp3.Call |
EmvTagDetailsApi.getEmvTagsAsync(ApiCallback<TssV2GetEmvTags200Response> callback)
Retrieve the EMV Dictionary (asynchronously)
Returns the entire EMV tag dictionary
|
okhttp3.Call |
SecureFileShareApi.getFileAsync(String fileId,
String organizationId,
ApiCallback<Void> callback)
Download a File with File Identifier (asynchronously)
Download a file for the given file identifier
|
okhttp3.Call |
SecureFileShareApi.getFileDetailAsync(org.joda.time.LocalDate startDate,
org.joda.time.LocalDate endDate,
String organizationId,
String name,
ApiCallback<V1FileDetailsGet200Response> callback)
Get List of Files (asynchronously)
Get list of files and it's information of them available inside the report directory
|
okhttp3.Call |
InstrumentIdentifierApi.getInstrumentIdentifierAsync(String instrumentIdentifierId,
String profileId,
ApiCallback<PostInstrumentIdentifierRequest> callback)
Retrieve an Instrument Identifier (asynchronously)
| | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Retrieving an Instrument Identifier**<br>Your system can use this API to retrieve an Instrument Identifier.<br>**Note: the actual card data will be masked.**<br>The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
|
okhttp3.Call |
InstrumentIdentifierApi.getInstrumentIdentifierPaymentInstrumentsListAsync(String instrumentIdentifierId,
String profileId,
Long offset,
Long limit,
ApiCallback<PaymentInstrumentList1> callback)
List Payment Instruments for an Instrument Identifier (asynchronously)
| | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Retrieving all Payment Instruments associated with an Instrument Identifier**<br>Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
|
okhttp3.Call |
InterchangeClearingLevelDetailsApi.getInterchangeClearingLevelDetailsAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ApiCallback<ReportingV3InterchangeClearingLevelDetailsGet200Response> callback)
Interchange Clearing Level data for an account or a merchant (asynchronously)
Interchange Clearing Level data for an account or a merchant
|
okhttp3.Call |
InvoicesApi.getInvoiceAsync(String id,
ApiCallback<InvoicingV2InvoicesGet200Response> callback)
Get Invoice Details (asynchronously)
You can retrieve details of a specific invoice.
|
okhttp3.Call |
InvoiceSettingsApi.getInvoiceSettingsAsync(ApiCallback<InvoicingV2InvoiceSettingsGet200Response> callback)
Get Invoice Settings (asynchronously)
Allows you to retrieve the invoice settings for the payment page.
|
okhttp3.Call |
NetFundingsApi.getNetFundingDetailsAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
String groupName,
ApiCallback<ReportingV3NetFundingsGet200Response> callback)
Get Netfunding Information for an Account or a Merchant (asynchronously)
Get Netfunding information for an account or a merchant.
|
okhttp3.Call |
NotificationOfChangesApi.getNotificationOfChangeReportAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
ApiCallback<ReportingV3NotificationofChangesGet200Response> callback)
Get Notification of Changes (asynchronously)
Download the Notification of Change report.
|
okhttp3.Call |
PaymentBatchSummariesApi.getPaymentBatchSummaryAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
String rollUp,
String breakdown,
Integer startDayOfWeek,
ApiCallback<ReportingV3PaymentBatchSummariesGet200Response> callback)
Get Payment Batch Summary Data (asynchronously)
Scope can be either account/merchant or reseller.
|
okhttp3.Call |
TransientTokenDataApi.getPaymentCredentialsForTransientTokenAsync(String paymentCredentialsReference,
ApiCallback<String> callback)
Get Payment Credentials (asynchronously)
Retrieve the Payment data captured by Unified Checkout.
|
okhttp3.Call |
PaymentInstrumentApi.getPaymentInstrumentAsync(String paymentInstrumentId,
String profileId,
ApiCallback<PostPaymentInstrumentRequest> callback)
Retrieve a Payment Instrument (asynchronously)
| | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
|
okhttp3.Call |
PlansApi.getPlanAsync(String id,
ApiCallback<GetPlanResponse> callback)
Get a Plan (asynchronously)
Retrieve a Plan details by Plan Id.
|
okhttp3.Call |
PlansApi.getPlanCodeAsync(ApiCallback<GetPlanCodeResponse> callback)
Get a Plan Code (asynchronously)
Get a Unique Plan Code
|
okhttp3.Call |
PlansApi.getPlansAsync(Integer offset,
Integer limit,
String code,
String status,
String name,
ApiCallback<GetAllPlansResponse> callback)
Get a List of Plans (asynchronously)
Retrieve Plans by Plan Code & Plan Status.
|
okhttp3.Call |
PurchaseAndRefundDetailsApi.getPurchaseAndRefundDetailsAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
String paymentSubtype,
String viewBy,
String groupName,
Integer offset,
Integer limit,
ApiCallback<ReportingV3PurchaseRefundDetailsGet200Response> callback)
Get Purchase and Refund Details (asynchronously)
Download the Purchase and Refund Details report.
|
okhttp3.Call |
MerchantBoardingApi.getRegistrationAsync(String registrationId,
ApiCallback<InlineResponse2001> callback)
Gets all the information on a boarding registration (asynchronously)
This end point will get all information of a boarding registration
|
okhttp3.Call |
ReportsApi.getReportByReportIdAsync(String reportId,
String organizationId,
ApiCallback<ReportingV3ReportsIdGet200Response> callback)
Get Report Based on Report Id (asynchronously)
Download a report using the reportId value.
|
okhttp3.Call |
ReportDefinitionsApi.getResourceInfoByReportDefinitionAsync(String reportDefinitionName,
String subscriptionType,
String reportMimeType,
String organizationId,
ApiCallback<ReportingV3ReportDefinitionsNameGet200Response> callback)
Get Report Definition (asynchronously)
View the attributes of an individual report type.
|
okhttp3.Call |
ReportDefinitionsApi.getResourceV2InfoAsync(String subscriptionType,
String organizationId,
ApiCallback<ReportingV3ReportDefinitionsGet200Response> callback)
Get Reporting Resource Information (asynchronously)
View a list of supported reports and their attributes before subscribing to them.
|
okhttp3.Call |
RetrievalDetailsApi.getRetrievalDetailsAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ApiCallback<ReportingV3RetrievalDetailsGet200Response> callback)
Get Retrieval Details (asynchronously)
Retrieval Detail Report Description
|
okhttp3.Call |
RetrievalSummariesApi.getRetrievalSummaryAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ApiCallback<ReportingV3RetrievalSummariesGet200Response> callback)
Get Retrieval Summaries (asynchronously)
Retrieval Summary Report Description
|
okhttp3.Call |
SearchTransactionsApi.getSearchAsync(String searchId,
ApiCallback<TssV2TransactionsPost201Response> callback)
Get Search Results (asynchronously)
Include the Search ID in the GET request to retrieve the search results.
|
okhttp3.Call |
SubscriptionsApi.getSubscriptionAsync(String id,
ApiCallback<GetSubscriptionResponse> callback)
Get a Subscription (asynchronously)
Get a Subscription by Subscription Id
|
okhttp3.Call |
ReportSubscriptionsApi.getSubscriptionAsync(String reportName,
String organizationId,
ApiCallback<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions> callback)
Get Subscription for Report Name (asynchronously)
View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
|
okhttp3.Call |
SubscriptionsApi.getSubscriptionCodeAsync(ApiCallback<GetSubscriptionCodeResponse> callback)
Get a Subscription Code (asynchronously)
Get a Unique Subscription Code
|
okhttp3.Call |
TransactionDetailsApi.getTransactionAsync(String id,
ApiCallback<TssV2TransactionsGet200Response> callback)
Retrieve a Transaction (asynchronously)
Include the Request ID in the GET request to retrieve the transaction details.
|
okhttp3.Call |
TransactionBatchesApi.getTransactionBatchDetailsAsync(String id,
org.joda.time.LocalDate uploadDate,
String status,
ApiCallback<Void> callback)
Get Transaction Details for a given Batch Id (asynchronously)
Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.
|
okhttp3.Call |
TransactionBatchesApi.getTransactionBatchesAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
ApiCallback<PtsV1TransactionBatchesGet200Response> callback)
Get a List of Batch Files (asynchronously)
Provide the date and time search range to get a list of Batch Files ready for settlement
|
okhttp3.Call |
TransactionBatchesApi.getTransactionBatchIdAsync(String id,
ApiCallback<PtsV1TransactionBatchesIdGet200Response> callback)
Get Individual Batch File (asynchronously)
This API provides details like upload date, completion date, transaction count and accepted and rejected transaction count of the individual batch file using the batch id
|
okhttp3.Call |
TransientTokenDataApi.getTransactionForTransientTokenAsync(String transientToken,
ApiCallback<Void> callback)
Get Transient Token Data (asynchronously)
Retrieve the data captured by Unified Checkout.
|
okhttp3.Call |
UserManagementApi.getUsersAsync(String organizationId,
String userName,
String permissionId,
String roleId,
ApiCallback<UmsV1UsersGet200Response> callback)
Get User Information - Deprecated (asynchronously)
This endpoint is deprecated.
|
okhttp3.Call |
ManageWebhooksApi.getWebhookSubscriptionByIdAsync(String webhookId,
ApiCallback<InlineResponse2004> callback)
Get Details On a Single Webhook (asynchronously)
Retrieve the details of a specific webhook by supplying the webhook ID in the path.
|
okhttp3.Call |
ManageWebhooksApi.getWebhookSubscriptionsByOrgAsync(String organizationId,
String productId,
String eventType,
ApiCallback<List<InlineResponse2003>> callback)
Get Details On All Created Webhooks (asynchronously)
Retrieve a list of all previously created webhooks.
|
okhttp3.Call |
DownloadXsdApi.getXSDV2Async(String reportDefinitionNameVersion,
ApiCallback<Void> callback)
Download XSD for Report (asynchronously)
Used to download XSDs for reports on no-auth.
|
okhttp3.Call |
PaymentsApi.incrementAuthAsync(String id,
IncrementAuthRequest incrementAuthRequest,
ApiCallback<PtsV2IncrementalAuthorizationPatch201Response> callback)
Increment an Authorization (asynchronously)
Use this service to authorize additional charges in a lodging or autorental transaction.
|
okhttp3.Call |
ReversalApi.mitReversalAsync(MitReversalRequest mitReversalRequest,
ApiCallback<PtsV2PaymentsReversalsPost201Response> callback)
Timeout Reversal (asynchronously)
This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout).
|
okhttp3.Call |
VoidApi.mitVoidAsync(MitVoidRequest mitVoidRequest,
ApiCallback<PtsV2PaymentsVoidsPost201Response> callback)
Timeout Void (asynchronously)
This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout).
|
okhttp3.Call |
PayoutsApi.octCreatePaymentAsync(OctCreatePaymentRequest octCreatePaymentRequest,
ApiCallback<PtsV2PayoutsPost201Response> callback)
Process a Payout (asynchronously)
Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT).
|
okhttp3.Call |
EmvTagDetailsApi.parseEmvTagsAsync(Body body,
ApiCallback<TssV2PostEmvTags200Response> callback)
Parse an EMV String (asynchronously)
Pass an EMV Tag-Length-Value (TLV) string for parsing.
|
okhttp3.Call |
CustomerApi.patchCustomerAsync(String customerId,
PatchCustomerRequest patchCustomerRequest,
String profileId,
String ifMatch,
ApiCallback<PatchCustomerRequest> callback)
Update a Customer (asynchronously)
| | | | | --- | --- | --- | |**Customers**<br>A Customer represents your tokenized customer information.<br>You should associate the Customer Id with the customer account on your systems.<br>A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.| |**Updating a Customer**<br>Your system can use this API to update a Customers details including selecting a [default Payment Instrument](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-payment-instrument_liveconsole-tab-request-body) or [default Shipping Address](#token-management_customer_update-a-customer_samplerequests-dropdown_update-customers-default-shipping-address_liveconsole-tab-request-body) for use in payments.<br>Note: Updating a Customers [Payment Instrument](#token-management_customer-payment-instrument_update-a-customer-payment-instrument) or [Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address) details is performed using their own dedicated API resources.
|
okhttp3.Call |
CustomerPaymentInstrumentApi.patchCustomersPaymentInstrumentAsync(String customerId,
String paymentInstrumentId,
PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
String profileId,
String ifMatch,
ApiCallback<PatchCustomerPaymentInstrumentRequest> callback)
Update a Customer Payment Instrument (asynchronously)
| | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
|
okhttp3.Call |
CustomerShippingAddressApi.patchCustomersShippingAddressAsync(String customerId,
String shippingAddressId,
PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
String profileId,
String ifMatch,
ApiCallback<PatchCustomerShippingAddressRequest> callback)
Update a Customer Shipping Address (asynchronously)
| | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.| |**Updating a Customers Shipping Address**<br>Your system can use this API to update an existing Shipping Addresses for a Customer, including selecting a [default Shipping Address](#token-management_customer-shipping-address_update-a-customer-shipping-address_samplerequests-dropdown_make-customer-shipping-address-the-default_liveconsole-tab-request-body) for use in payments.
|
okhttp3.Call |
InstrumentIdentifierApi.patchInstrumentIdentifierAsync(String instrumentIdentifierId,
PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
String profileId,
String ifMatch,
ApiCallback<PatchInstrumentIdentifierRequest> callback)
Update an Instrument Identifier (asynchronously)
| | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Updating an Instrument Identifier**<br>When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.<br>Your system can use this API to update these values.
|
okhttp3.Call |
PaymentInstrumentApi.patchPaymentInstrumentAsync(String paymentInstrumentId,
PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
String profileId,
String ifMatch,
ApiCallback<PatchPaymentInstrumentRequest> callback)
Update a Payment Instrument (asynchronously)
| | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
|
okhttp3.Call |
PayerAuthenticationApi.payerAuthSetupAsync(PayerAuthSetupRequest payerAuthSetupRequest,
ApiCallback<RiskV1AuthenticationSetupsPost201Response> callback)
Setup Payer Auth (asynchronously)
A new service for Merchants to get reference_id for Digital Wallets to use in place of BIN number in Cardinal.
|
okhttp3.Call |
InvoicesApi.performCancelActionAsync(String id,
ApiCallback<InvoicingV2InvoicesPost201Response> callback)
Cancel an Invoice (asynchronously)
You can cancel an invoice if no payment is made to it.
|
okhttp3.Call |
InvoicesApi.performSendActionAsync(String id,
ApiCallback<InvoicingV2InvoicesPost201Response> callback)
Send an Invoice (asynchronously)
You can send an invoice in draft or created state or resend a sent or partially paid invoice.
|
okhttp3.Call |
OAuthApi.postAccessTokenFromAuthCodeAsync(CreateAccessTokenRequest createAccessTokenRequest,
ApiCallback<AccessTokenResponse> callback)
Post Access Token from Auth Code (asynchronously)
|
okhttp3.Call |
OAuthApi.postAccessTokenFromRefreshTokenAsync(CreateAccessTokenRequest createAccessTokenRequest,
ApiCallback<AccessTokenResponse> callback)
Post Access Token from Refresh Token (asynchronously)
|
okhttp3.Call |
BatchesApi.postBatchAsync(Body body,
ApiCallback<InlineResponse202> callback)
Create a Batch (asynchronously)
**Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier.
|
okhttp3.Call |
CustomerApi.postCustomerAsync(PostCustomerRequest postCustomerRequest,
String profileId,
ApiCallback<PostCustomerRequest> callback)
Create a Customer (asynchronously)
| | | | | --- | --- | --- | |**Customers**<br>A Customer represents your tokenized customer information.<br>You should associate the Customer Id with the customer account on your systems.<br>A Customer can have one or more [Payment Instruments](#token-management_customer-payment-instrument_create-a-customer-payment-instrumentl) or [Shipping Addresses](#token-management_customer-shipping-address_create-a-customer-shipping-address) with one allocated as the Customers default.<br><br>**Creating a Customer**<br>It is recommended you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>The Customer will be created with a Payment Instrument and Shipping Address.<br>You can also [add additional Payment Instruments to a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).<br>In Europe: You should perform Payer Authentication alongside the Authorization.| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Customers**<br>To perform a payment with the Customers default details specify the [Customer Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-token-id_liveconsole-tab-request-body).<br>To perform a payment with a particular Payment Instrument or Shipping Address <br>specify the [Payment Instrument or Shipping Address Ids in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).
|
okhttp3.Call |
CustomerPaymentInstrumentApi.postCustomerPaymentInstrumentAsync(String customerId,
PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
String profileId,
ApiCallback<PostCustomerPaymentInstrumentRequest> callback)
Create a Customer Payment Instrument (asynchronously)
| | | | | --- | --- | --- | |**Customer Payment Instrument**<br>A Customer Payment Instrument represents tokenized customer payment information such as expiration date, billing address & card type.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Payment Instruments](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument), with one allocated as the Customers default for use in payments.<br>A Payment Instrument token does not store the card number.
|
okhttp3.Call |
CustomerShippingAddressApi.postCustomerShippingAddressAsync(String customerId,
PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
String profileId,
ApiCallback<PostCustomerShippingAddressRequest> callback)
Create a Customer Shipping Address (asynchronously)
| | | | | --- | --- | --- | |**Customer Shipping Address**<br>A Customer Shipping Address represents tokenized customer shipping information.<br>A [Customer](#token-management_customer_create-a-customer) can have [one or more Shipping Addresses](#token-management_customer-shipping-address_list-shipping-addresses-for-a-customer), with one allocated as the Customers default for use in payments.| |**Creating a Customer Shipping Address**<br>Your system can use this API to create an existing Customers default or non default Shipping Address.<br>You can also create additional Customer Shipping Addresses via the [Payments API](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body).
|
okhttp3.Call |
InstrumentIdentifierApi.postInstrumentIdentifierAsync(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
String profileId,
ApiCallback<PostInstrumentIdentifierRequest> callback)
Create an Instrument Identifier (asynchronously)
| | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Creating an Instrument Identifier**<br>It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)<br>In Europe: You should perform Payer Authentication alongside the Authorization.| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
|
okhttp3.Call |
InstrumentIdentifierApi.postInstrumentIdentifierEnrollmentAsync(String instrumentIdentifierId,
PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest,
String profileId,
ApiCallback<Void> callback)
Enroll an Instrument Identifier for Payment Network Token (asynchronously)
| | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Enroll an Instrument Identifier for a Payment Network Token**<br>Your system can use this API to provision a Network token for an existing Instrument Identifier.<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.<br>For more information about Payment Network Tokens see the Developer Guide.
|
okhttp3.Call |
PaymentInstrumentApi.postPaymentInstrumentAsync(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
String profileId,
ApiCallback<PostPaymentInstrumentRequest> callback)
Create a Payment Instrument (asynchronously)
| | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
|
okhttp3.Call |
MerchantBoardingApi.postRegistrationAsync(PostRegistrationBody postRegistrationBody,
String vCIdempotencyId,
ApiCallback<InlineResponse2012> callback)
Create a boarding registration (asynchronously)
Create a registration to board merchant If you have Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request.
|
okhttp3.Call |
TokenApi.postTokenPaymentCredentialsAsync(String tokenId,
PostPaymentCredentialsRequest postPaymentCredentialsRequest,
String profileId,
ApiCallback<String> callback)
Generate Payment Credentials for a TMS Token (asynchronously)
| | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.| |**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier.
|
okhttp3.Call |
PaymentsApi.refreshPaymentStatusAsync(String id,
RefreshPaymentStatusRequest refreshPaymentStatusRequest,
ApiCallback<PtsV2PaymentsPost201Response1> callback)
Check a Payment Status (asynchronously)
Checks and updates the payment status
|
okhttp3.Call |
RefundApi.refundCaptureAsync(RefundCaptureRequest refundCaptureRequest,
String id,
ApiCallback<PtsV2PaymentsRefundPost201Response> callback)
Refund a Capture (asynchronously)
Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call.
|
okhttp3.Call |
RefundApi.refundPaymentAsync(RefundPaymentRequest refundPaymentRequest,
String id,
ApiCallback<PtsV2PaymentsRefundPost201Response> callback)
Refund a Payment (asynchronously)
Refund a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call.
|
okhttp3.Call |
ReplayWebhooksApi.replayPreviousWebhooksAsync(String webhookId,
ReplayWebhooksRequest replayWebhooksRequest,
ApiCallback<Void> callback)
Replay Previous Webhooks (asynchronously)
Initiate a webhook replay request to replay transactions that happened in the past.
|
okhttp3.Call |
ManageWebhooksApi.saveAsymEgressKeyAsync(String vCSenderOrganizationId,
String vCPermissions,
SaveAsymEgressKey saveAsymEgressKey,
String vCCorrelationId,
ApiCallback<InlineResponse2015> callback)
Message Level Encryption (asynchronously)
Store and manage certificates that will be used to preform Message Level Encryption (MLE).
|
okhttp3.Call |
CreateNewWebhooksApi.saveSymEgressKeyAsync(String vCSenderOrganizationId,
String vCPermissions,
String vCCorrelationId,
SaveSymEgressKey saveSymEgressKey,
ApiCallback<InlineResponse2013> callback)
Create Webhook Security Keys (asynchronously)
Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature.
|
okhttp3.Call |
ReportsApi.searchReportsAsync(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String timeQueryType,
String organizationId,
String reportMimeType,
String reportFrequency,
String reportName,
Integer reportDefinitionId,
String reportStatus,
ApiCallback<ReportingV3ReportsGet200Response> callback)
Retrieve Available Reports (asynchronously)
Retrieve a list of the available reports to which you are subscribed.
|
okhttp3.Call |
UserManagementSearchApi.searchUsersAsync(SearchRequest searchRequest,
ApiCallback<UmsV1UsersGet200Response> callback)
Search User Information (asynchronously)
This endpoint is to get all the user information depending on the filter criteria passed in request body.
|
okhttp3.Call |
SubscriptionsApi.suspendSubscriptionAsync(String id,
ApiCallback<SuspendSubscriptionResponse> callback)
Suspend a Subscription (asynchronously)
Suspend a Subscription
|
okhttp3.Call |
InvoicesApi.updateInvoiceAsync(String id,
UpdateInvoiceRequest updateInvoiceRequest,
ApiCallback<InvoicingV2InvoicesPost201Response> callback)
Update an Invoice (asynchronously)
You can update all information except the invoice number till any payment is received for an invoice.
|
okhttp3.Call |
InvoiceSettingsApi.updateInvoiceSettingsAsync(InvoiceSettingsRequest invoiceSettingsRequest,
ApiCallback<InvoicingV2InvoiceSettingsGet200Response> callback)
Update Invoice Settings (asynchronously)
Allows you to customize the payment page, the checkout experience, email communication and payer authentication.
|
okhttp3.Call |
OrdersApi.updateOrderAsync(String id,
UpdateOrderRequest updateOrderRequest,
ApiCallback<PtsV2UpdateOrderPatch201Response> callback)
Update an Order (asynchronously)
This API can be used in two flavours - for updating the order as well as saving the order.
|
okhttp3.Call |
PlansApi.updatePlanAsync(String id,
UpdatePlanRequest updatePlanRequest,
ApiCallback<UpdatePlanResponse> callback)
Update a Plan (asynchronously)
Update a Plan Plan in `DRAFT` status - All updates are allowed on Plan with `DRAFT` status Plan in `ACTIVE` status [Following fields are **Not Updatable**] - `planInformation.billingPeriod` - `planInformation.billingCycles` [Update is only allowed to **increase** billingCycles] - `orderInformation.amountDetails.currency`
|
okhttp3.Call |
PaymentsApi.updateSessionReqAsync(CreateSessionRequest createSessionRequest,
String id,
ApiCallback<PtsV2PaymentsPost201Response2> callback)
Update Alternative Payments Sessions Request (asynchronously)
Update Alternative Payments Sessions Request
|
okhttp3.Call |
SubscriptionsApi.updateSubscriptionAsync(String id,
UpdateSubscription updateSubscription,
ApiCallback<UpdateSubscriptionResponse> callback)
Update a Subscription (asynchronously)
Update a Subscription by Subscription Id
|
okhttp3.Call |
ManageWebhooksApi.updateWebhookSubscriptionAsync(String webhookId,
UpdateWebhookRequest updateWebhookRequest,
ApiCallback<Void> callback)
Update a Webhook Subscription (asynchronously)
Update the webhook subscription using PATCH.
|
okhttp3.Call |
PayerAuthenticationApi.validateAuthenticationResultsAsync(ValidateRequest validateRequest,
ApiCallback<RiskV1AuthenticationResultsPost201Response> callback)
Validate Authentication Results (asynchronously)
This call retrieves and validates the authentication results from issuer and allows the merchant to proceed with processing the payment.
|
okhttp3.Call |
VerificationApi.validateExportComplianceAsync(ValidateExportComplianceRequest validateExportComplianceRequest,
ApiCallback<RiskV1ExportComplianceInquiriesPost201Response> callback)
Validate export compliance (asynchronously)
This call checks customer data against specified watch lists to ensure export compliance.
|
okhttp3.Call |
VerificationApi.verifyCustomerAddressAsync(VerifyCustomerAddressRequest verifyCustomerAddressRequest,
ApiCallback<RiskV1AddressVerificationsPost201Response> callback)
Verify customer address (asynchronously)
This call verifies that the customer address submitted is valid.
|
okhttp3.Call |
VoidApi.voidCaptureAsync(VoidCaptureRequest voidCaptureRequest,
String id,
ApiCallback<PtsV2PaymentsVoidsPost201Response> callback)
Void a Capture (asynchronously)
Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/{id}/captures](https://developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call.
|
okhttp3.Call |
VoidApi.voidCreditAsync(VoidCreditRequest voidCreditRequest,
String id,
ApiCallback<PtsV2PaymentsVoidsPost201Response> callback)
Void a Credit (asynchronously)
Include the credit ID in the POST request to cancel the credit.
|
okhttp3.Call |
VoidApi.voidPaymentAsync(VoidPaymentRequest voidPaymentRequest,
String id,
ApiCallback<PtsV2PaymentsVoidsPost201Response> callback)
Void a Payment (asynchronously)
Void a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](https://developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call.
|
okhttp3.Call |
VoidApi.voidRefundAsync(VoidRefundRequest voidRefundRequest,
String id,
ApiCallback<PtsV2PaymentsVoidsPost201Response> callback)
Void a Refund (asynchronously)
Include the refund ID in the POST request to cancel the refund.
|
okhttp3.Call |
TaxesApi.voidTaxAsync(VoidTaxRequest voidTaxRequest,
String id,
ApiCallback<VasV2TaxVoid200Response> callback)
Void Taxes (asynchronously)
Pass the Tax Request ID in the PATCH request to void the committed tax calculation.
|
| Modifier and Type | Method and Description |
|---|---|
<T> void |
ApiClient.executeAsync(okhttp3.Call call,
ApiCallback<T> callback)
|
<T> void |
ApiClient.executeAsync(okhttp3.Call call,
Type returnType,
ApiCallback<T> callback)
Execute HTTP call asynchronously.
|
Copyright © 2024. All rights reserved.