| Package | Description |
|---|---|
| Api | |
| Invokers |
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<InlineResponse2001> |
DecisionManagerApi.actionDecisionManagerCaseWithHttpInfo(String id,
CaseManagementActionsRequest caseManagementActionsRequest)
Take action on a DM post-transactional case
Take action on a DM post-transactional case
|
ApiResponse<ActivateDeactivatePlanResponse> |
PlansApi.activatePlanWithHttpInfo(String id)
Activate a Plan
Activate a Plan
|
ApiResponse<ActivateSubscriptionResponse> |
SubscriptionsApi.activateSubscriptionWithHttpInfo(String id)
Activate a Subscription
Activate a `CANCELLED` Or `SUSPENDED` Subscription
|
ApiResponse<RiskV1UpdatePost201Response> |
DecisionManagerApi.addNegativeWithHttpInfo(String type,
AddNegativeListRequest addNegativeListRequest)
List Management
This call adds/deletes/converts the request information in the negative list.
|
ApiResponse<PtsV2PaymentsReversalsPost201Response> |
ReversalApi.authReversalWithHttpInfo(String id,
AuthReversalRequest authReversalRequest)
Process an Authorization Reversal
Include the payment ID in the POST request to reverse the payment amount.
|
ApiResponse<PtsV2ModifyBillingAgreementPost201Response> |
BillingAgreementsApi.billingAgreementsDeRegistrationWithHttpInfo(ModifyBillingAgreement modifyBillingAgreement,
String id)
Modify a Billing Agreement
#### Standing Instruction: Standing Instruction with or without Token.
|
ApiResponse<PtsV2CreditsPost201Response1> |
BillingAgreementsApi.billingAgreementsIntimationWithHttpInfo(IntimateBillingAgreement intimateBillingAgreement,
String id)
Standing Instruction intimation
Standing Instruction with or without Token.
|
ApiResponse<PtsV2CreateBillingAgreementPost201Response> |
BillingAgreementsApi.billingAgreementsRegistrationWithHttpInfo(CreateBillingAgreement createBillingAgreement)
Create a Billing Agreement
#### Standing Instruction: Standing Instruction with or without Token.
|
ApiResponse<VasV2PaymentsPost201Response> |
TaxesApi.calculateTaxWithHttpInfo(TaxRequest taxRequest)
Calculate Taxes
The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide.
|
ApiResponse<CancelSubscriptionResponse> |
SubscriptionsApi.cancelSubscriptionWithHttpInfo(String id)
Cancel a Subscription
Cancel a Subscription
|
ApiResponse<PtsV2PaymentsCapturesPost201Response> |
CaptureApi.capturePaymentWithHttpInfo(CapturePaymentRequest capturePaymentRequest,
String id)
Capture a Payment
Include the payment ID in the POST request to capture the payment amount.
|
ApiResponse<RiskV1AuthenticationsPost201Response> |
PayerAuthenticationApi.checkPayerAuthEnrollmentWithHttpInfo(CheckPayerAuthEnrollmentRequest checkPayerAuthEnrollmentRequest)
Check Payer Auth Enrollment
This call verifies that the card is enrolled in a card authentication program.
|
ApiResponse<InlineResponse201> |
DecisionManagerApi.commentDecisionManagerCaseWithHttpInfo(String id,
CaseManagementCommentsRequest caseManagementCommentsRequest)
Add a comment to a DM post-transactional case
Add a comment to a DM post-transactional case
|
ApiResponse<RiskV1DecisionsPost201Response> |
DecisionManagerApi.createBundledDecisionManagerCaseWithHttpInfo(CreateBundledDecisionManagerCaseRequest createBundledDecisionManagerCaseRequest)
Create Decision Manager
Decision Manager can help you automate and streamline your fraud operations.
|
ApiResponse<PtsV2CreditsPost201Response> |
CreditApi.createCreditWithHttpInfo(CreateCreditRequest createCreditRequest)
Process a Credit
POST to the credit resource to credit funds to a specified credit card.
|
ApiResponse<CreateSubscriptionResponse> |
SubscriptionsFollowOnsApi.createFollowOnSubscriptionWithHttpInfo(String requestId,
CreateSubscriptionRequest1 createSubscriptionRequest)
Create a Follow-On Subscription
Create a new Subscription based on the Request Id of an existing successful Transaction.
|
ApiResponse<InvoicingV2InvoicesPost201Response> |
InvoicesApi.createInvoiceWithHttpInfo(CreateInvoiceRequest createInvoiceRequest)
Create a New Invoice
The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device.
|
ApiResponse<PtsV2PaymentsOrderPost201Response> |
PaymentsApi.createOrderRequestWithHttpInfo(OrderPaymentRequest orderPaymentRequest,
String id)
Create a Payment Order Request
Create a Payment Order Request
|
ApiResponse<PtsV2CreateOrderPost201Response> |
OrdersApi.createOrderWithHttpInfo(CreateOrderRequest createOrderRequest)
Create an Order
A create order request enables you to send the itemized details along with the order.
|
ApiResponse<PblPaymentLinksPost201Response> |
PaymentLinksApi.createPaymentLinkWithHttpInfo(CreatePaymentLinkRequest createPaymentLinkRequest)
Create a Payment Link
Create a new payment link.
|
ApiResponse<PtsV2PaymentsPost201Response> |
PaymentsApi.createPaymentWithHttpInfo(CreatePaymentRequest createPaymentRequest)
Process a Payment
A payment authorizes the amount for the transaction.
|
ApiResponse<CreatePlanResponse> |
PlansApi.createPlanWithHttpInfo(CreatePlanRequest createPlanRequest)
Create a Plan
The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules.
|
ApiResponse<PushFunds201Response> |
PushFundsApi.createPushFundsTransferWithHttpInfo(PushFundsRequest pushFundsRequest,
String contentType,
String xRequestid,
String vCMerchantId,
String vCPermissions,
String vCCorrelationId,
String vCOrganizationId)
Process a Push Funds Transfer
Receive funds using an Original Credit Transaction (OCT).
|
ApiResponse<Void> |
ReportsApi.createReportWithHttpInfo(CreateAdhocReportRequest createAdhocReportRequest,
String organizationId)
Create Adhoc Report
Create a one-time report.
|
ApiResponse<TssV2TransactionsPost201Response> |
SearchTransactionsApi.createSearchWithHttpInfo(CreateSearchRequest createSearchRequest)
Create a Search Request
Create a search request.
|
ApiResponse<PtsV2PaymentsPost201Response2> |
PaymentsApi.createSessionRequestWithHttpInfo(CreateSessionReq createSessionReq)
Create Alternative Payments Sessions Request
Create Alternative Payments Sessions Request
|
ApiResponse<Void> |
ReportSubscriptionsApi.createStandardOrClassicSubscriptionWithHttpInfo(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean,
String organizationId)
Create a Standard or Classic Subscription
Create or update an already existing classic or standard subscription.
|
ApiResponse<Void> |
ReportSubscriptionsApi.createSubscriptionWithHttpInfo(CreateReportSubscriptionRequest createReportSubscriptionRequest,
String organizationId)
Create Report Subscription for a Report Name by Organization
Create a report subscription for your organization.
|
ApiResponse<CreateSubscriptionResponse> |
SubscriptionsApi.createSubscriptionWithHttpInfo(CreateSubscriptionRequest createSubscriptionRequest)
Create a Subscription
Create a Recurring Billing Subscription
|
ApiResponse<ActivateDeactivatePlanResponse> |
PlansApi.deactivatePlanWithHttpInfo(String id)
Deactivate a Plan
Deactivate a Plan
|
ApiResponse<Void> |
CustomerPaymentInstrumentApi.deleteCustomerPaymentInstrumentWithHttpInfo(String customerId,
String paymentInstrumentId,
String profileId)
Delete a Customer Payment Instrument
| | | | | --- | --- | --- | |**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.
|
ApiResponse<Void> |
CustomerShippingAddressApi.deleteCustomerShippingAddressWithHttpInfo(String customerId,
String shippingAddressId,
String profileId)
Delete a Customer Shipping Address
| | | | | --- | --- | --- | |**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).
|
ApiResponse<Void> |
CustomerApi.deleteCustomerWithHttpInfo(String customerId,
String profileId)
Delete a Customer
| | | | | --- | --- | --- | |**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.
|
ApiResponse<Void> |
InstrumentIdentifierApi.deleteInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId,
String profileId)
Delete an Instrument Identifier
| | | | | --- | --- | --- | |**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).
|
ApiResponse<Void> |
PaymentInstrumentApi.deletePaymentInstrumentWithHttpInfo(String paymentInstrumentId,
String profileId)
Delete a Payment Instrument
| | | | | --- | --- | --- | |**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.
|
ApiResponse<DeletePlanResponse> |
PlansApi.deletePlanWithHttpInfo(String id)
Delete a Plan
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
|
ApiResponse<Void> |
ReportSubscriptionsApi.deleteSubscriptionWithHttpInfo(String reportName,
String organizationId)
Delete Subscription of a Report Name by Organization
Delete a report subscription for your organization.
|
ApiResponse<Void> |
TokenizedCardApi.deleteTokenizedCardWithHttpInfo(String tokenizedCardId,
String profileId)
Delete a Tokenized Card
| | | | | --- | --- | --- | | The Network Token will attempt to be deleted from the card association and if successful the corresponding TMS Network Token will be deleted.
|
ApiResponse<Void> |
ManageWebhooksApi.deleteWebhookSubscriptionWithHttpInfo(String webhookId)
Delete a Webhook Subscription
Delete the webhook.
|
ApiResponse<InputStream> |
ReportDownloadsApi.downloadReportWithHttpInfo(org.joda.time.LocalDate reportDate,
String reportName,
String organizationId)
Download a Report
Download a report using the unique report name and date.
|
ApiResponse<List<InlineResponse2003>> |
CreateNewWebhooksApi.findProductsToSubscribeWithHttpInfo(String organizationId)
Find Products You Can Subscribe To
Retrieve a list of products and event types that your account is eligible for.
|
ApiResponse<RiskV1UpdatePost201Response> |
DecisionManagerApi.fraudUpdateWithHttpInfo(String id,
FraudMarkingActionRequest fraudMarkingActionRequest)
Fraud Marking
This can be used to - 1.
|
ApiResponse<String> |
MicroformIntegrationApi.generateCaptureContextWithHttpInfo(GenerateCaptureContextRequest generateCaptureContextRequest)
Generate Capture Context
This API is used to generate the Capture Context data structure for the Microform Integration.
|
ApiResponse<String> |
FlexApiApi.generateFlexAPICaptureContextWithHttpInfo(GenerateFlexAPICaptureContextRequest generateFlexAPICaptureContextRequest)
Establish a Payment Session with a Capture Context
To establish a payment session, include the API fields you plan to use in that session in the body of the request.
|
ApiResponse<String> |
UnifiedCheckoutCaptureContextApi.generateUnifiedCheckoutCaptureContextWithHttpInfo(GenerateUnifiedCheckoutCaptureContextRequest generateUnifiedCheckoutCaptureContextRequest)
Generate Unified Checkout Capture Context
Unified Checkout is a powerful product within the Digital Acceptance Suite.
|
ApiResponse<InlineResponse2011> |
BinLookupApi.getAccountInfoWithHttpInfo(CreateBinLookupRequest createBinLookupRequest)
BIN Lookup API
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.
|
ApiResponse<InvoicingV2InvoicesAllGet200Response> |
InvoicesApi.getAllInvoicesWithHttpInfo(Integer offset,
Integer limit,
String status)
Get a List of Invoices
Provides a (filtered) list of invoices that have been created in your account.
|
ApiResponse<PblPaymentLinksAllGet200Response> |
PaymentLinksApi.getAllPaymentLinksWithHttpInfo(Integer offset,
Integer limit,
String status)
Get a List of Payment Links
Provides a (filtered) list of payment links that have been created in your account.
|
ApiResponse<GetAllSubscriptionsResponse> |
SubscriptionsApi.getAllSubscriptionsWithHttpInfo(Integer offset,
Integer limit,
String code,
String status)
Get a List of Subscriptions
Retrieve Subscriptions by Subscription Code & Subscription Status.
|
ApiResponse<ReportingV3ReportSubscriptionsGet200Response> |
ReportSubscriptionsApi.getAllSubscriptionsWithHttpInfo(String organizationId)
Get All Subscriptions
View a summary of all report subscriptions.
|
ApiResponse<InlineResponse2005> |
BatchesApi.getBatchesListWithHttpInfo(Long offset,
Long limit,
String fromDate,
String toDate)
List Batches
**List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id.
|
ApiResponse<InlineResponse2007> |
BatchesApi.getBatchReportWithHttpInfo(String batchId)
Retrieve a Batch Report
**Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status.
|
ApiResponse<InlineResponse2006> |
BatchesApi.getBatchStatusWithHttpInfo(String batchId)
Retrieve a Batch Status
**Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status.
|
ApiResponse<InlineResponse200> |
TokenApi.getCardArtAssetWithHttpInfo(String instrumentIdentifierId,
String tokenProvider,
String assetType)
Retrieve Card Art
Retrieves Card Art for a specific Instrument Identifier.
|
ApiResponse<ReportingV3ChargebackDetailsGet200Response> |
ChargebackDetailsApi.getChargebackDetailsWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Chargeback Details
Chargeback Detail Report Description
|
ApiResponse<ReportingV3ChargebackSummariesGet200Response> |
ChargebackSummariesApi.getChargebackSummariesWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Chargeback Summaries
Chargeback Summary Report Description
|
ApiResponse<ReportingV3ConversionDetailsGet200Response> |
ConversionDetailsApi.getConversionDetailWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Conversion Detail Transactions
Get conversion detail of transactions for a merchant.
|
ApiResponse<PaymentInstrumentList> |
CustomerPaymentInstrumentApi.getCustomerPaymentInstrumentsListWithHttpInfo(String customerId,
String profileId,
Long offset,
Long limit)
List Payment Instruments for a Customer
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PostCustomerPaymentInstrumentRequest> |
CustomerPaymentInstrumentApi.getCustomerPaymentInstrumentWithHttpInfo(String customerId,
String paymentInstrumentId,
String profileId)
Retrieve a Customer Payment Instrument
| | | | | --- | --- | --- | |**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.
|
ApiResponse<ShippingAddressListForCustomer> |
CustomerShippingAddressApi.getCustomerShippingAddressesListWithHttpInfo(String customerId,
String profileId,
Long offset,
Long limit)
List Shipping Addresses for a Customer
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PostCustomerShippingAddressRequest> |
CustomerShippingAddressApi.getCustomerShippingAddressWithHttpInfo(String customerId,
String shippingAddressId,
String profileId)
Retrieve a Customer Shipping Address
| | | | | --- | --- | --- | |**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).
|
ApiResponse<PostCustomerRequest> |
CustomerApi.getCustomerWithHttpInfo(String customerId,
String profileId)
Retrieve a Customer
| | | | | --- | --- | --- | |**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).
|
ApiResponse<Void> |
DownloadDtdApi.getDTDV2WithHttpInfo(String reportDefinitionNameVersion)
Download DTD for Report
Used to download DTDs for reports on no-auth.
|
ApiResponse<TssV2GetEmvTags200Response> |
EmvTagDetailsApi.getEmvTagsWithHttpInfo()
Retrieve the EMV Dictionary
Returns the entire EMV tag dictionary
|
ApiResponse<V1FileDetailsGet200Response> |
SecureFileShareApi.getFileDetailWithHttpInfo(org.joda.time.LocalDate startDate,
org.joda.time.LocalDate endDate,
String organizationId,
String name)
Get List of Files
Get list of files and it's information of them available inside the report directory
|
ApiResponse<InputStream> |
SecureFileShareApi.getFileWithHttpInfo(String fileId,
String organizationId)
Download a File with File Identifier
Download a file for the given file identifier
|
ApiResponse<GetSubscriptionResponse1> |
SubscriptionsFollowOnsApi.getFollowOnSubscriptionWithHttpInfo(String requestId)
Get a Follow-On Subscription
Get details of the Subscription being created based on the Request Id of an existing successful Transaction.
|
ApiResponse<PaymentInstrumentList1> |
InstrumentIdentifierApi.getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(String instrumentIdentifierId,
String profileId,
Boolean retrieveBinDetails,
Long offset,
Long limit)
List Payment Instruments for an Instrument Identifier
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PostInstrumentIdentifierRequest> |
InstrumentIdentifierApi.getInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId,
String profileId,
Boolean retrieveBinDetails)
Retrieve an Instrument Identifier
| | | | | --- | --- | --- | |**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.
|
ApiResponse<ReportingV3InterchangeClearingLevelDetailsGet200Response> |
InterchangeClearingLevelDetailsApi.getInterchangeClearingLevelDetailsWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Interchange Clearing Level data for an account or a merchant
Interchange Clearing Level data for an account or a merchant
|
ApiResponse<InvoicingV2InvoiceSettingsGet200Response> |
InvoiceSettingsApi.getInvoiceSettingsWithHttpInfo()
Get Invoice Settings
Allows you to retrieve the invoice settings for the payment page.
|
ApiResponse<InvoicingV2InvoicesGet200Response> |
InvoicesApi.getInvoiceWithHttpInfo(String id)
Get Invoice Details
You can retrieve details of a specific invoice.
|
ApiResponse<ReportingV3NetFundingsGet200Response> |
NetFundingsApi.getNetFundingDetailsWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
String groupName)
Get Netfunding Information for an Account or a Merchant
Get Netfunding information for an account or a merchant.
|
ApiResponse<ReportingV3NotificationofChangesGet200Response> |
NotificationOfChangesApi.getNotificationOfChangeReportWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime)
Get Notification of Changes
Download the Notification of Change report.
|
ApiResponse<ReportingV3PaymentBatchSummariesGet200Response> |
PaymentBatchSummariesApi.getPaymentBatchSummaryWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
String rollUp,
String breakdown,
Integer startDayOfWeek)
Get Payment Batch Summary Data
Scope can be either account/merchant or reseller.
|
ApiResponse<String> |
TransientTokenDataApi.getPaymentCredentialsForTransientTokenWithHttpInfo(String paymentCredentialsReference)
Get Payment Credentials
Retrieve the Payment data captured by Unified Checkout.
|
ApiResponse<PostPaymentInstrumentRequest> |
PaymentInstrumentApi.getPaymentInstrumentWithHttpInfo(String paymentInstrumentId,
String profileId,
Boolean retrieveBinDetails)
Retrieve a Payment Instrument
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PblPaymentLinksGet200Response> |
PaymentLinksApi.getPaymentLinkWithHttpInfo(String id)
Get Payment Link Details
You can retrieve details of a specific payment link.
|
ApiResponse<GetPlanCodeResponse> |
PlansApi.getPlanCodeWithHttpInfo()
Get a Plan Code
Get a Unique Plan Code
|
ApiResponse<GetAllPlansResponse> |
PlansApi.getPlansWithHttpInfo(Integer offset,
Integer limit,
String code,
String status,
String name)
Get a List of Plans
Retrieve Plans by Plan Code & Plan Status.
|
ApiResponse<GetPlanResponse> |
PlansApi.getPlanWithHttpInfo(String id)
Get a Plan
Retrieve a Plan details by Plan Id.
|
ApiResponse<ReportingV3PurchaseRefundDetailsGet200Response> |
PurchaseAndRefundDetailsApi.getPurchaseAndRefundDetailsWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
String paymentSubtype,
String viewBy,
String groupName,
Integer offset,
Integer limit)
Get Purchase and Refund Details
Download the Purchase and Refund Details report.
|
ApiResponse<InlineResponse2002> |
MerchantBoardingApi.getRegistrationWithHttpInfo(String registrationId)
Gets all the information on a boarding registration
This end point will get all information of a boarding registration
|
ApiResponse<ReportingV3ReportsIdGet200Response> |
ReportsApi.getReportByReportIdWithHttpInfo(String reportId,
String organizationId)
Get Report Based on Report Id
Download a report using the reportId value.
|
ApiResponse<ReportingV3ReportDefinitionsNameGet200Response> |
ReportDefinitionsApi.getResourceInfoByReportDefinitionWithHttpInfo(String reportDefinitionName,
String subscriptionType,
String reportMimeType,
String organizationId)
Get Report Definition
View the attributes of an individual report type.
|
ApiResponse<ReportingV3ReportDefinitionsGet200Response> |
ReportDefinitionsApi.getResourceV2InfoWithHttpInfo(String subscriptionType,
String organizationId)
Get Reporting Resource Information
View a list of supported reports and their attributes before subscribing to them.
|
ApiResponse<ReportingV3RetrievalDetailsGet200Response> |
RetrievalDetailsApi.getRetrievalDetailsWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Retrieval Details
Retrieval Detail Report Description
|
ApiResponse<ReportingV3RetrievalSummariesGet200Response> |
RetrievalSummariesApi.getRetrievalSummaryWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Retrieval Summaries
Retrieval Summary Report Description
|
ApiResponse<TssV2TransactionsPost201Response> |
SearchTransactionsApi.getSearchWithHttpInfo(String searchId)
Get Search Results
Include the Search ID in the GET request to retrieve the search results.
|
ApiResponse<GetSubscriptionCodeResponse> |
SubscriptionsApi.getSubscriptionCodeWithHttpInfo()
Get a Subscription Code
Get a Unique Subscription Code
|
ApiResponse<GetSubscriptionResponse> |
SubscriptionsApi.getSubscriptionWithHttpInfo(String id)
Get a Subscription
Get a Subscription by Subscription Id
|
ApiResponse<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions> |
ReportSubscriptionsApi.getSubscriptionWithHttpInfo(String reportName,
String organizationId)
Get Subscription for Report Name
View the details of a report subscription, such as the report format or report frequency, using the report's unique name.
|
ApiResponse<TokenizedcardRequest> |
TokenizedCardApi.getTokenizedCardWithHttpInfo(String tokenizedCardId,
String profileId)
Retrieve a Tokenized Card
| | | | | --- | --- | --- | |**Tokenized Cards**<br>A Tokenized Card represents a network token.
|
ApiResponse<InputStream> |
TransactionBatchesApi.getTransactionBatchDetailsWithHttpInfo(String id,
org.joda.time.LocalDate uploadDate,
String status)
Get Transaction Details for a given Batch Id
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.
|
ApiResponse<PtsV1TransactionBatchesGet200Response> |
TransactionBatchesApi.getTransactionBatchesWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime)
Get a List of Batch Files
Provide the date and time search range to get a list of Batch Files ready for settlement
|
ApiResponse<PtsV1TransactionBatchesIdGet200Response> |
TransactionBatchesApi.getTransactionBatchIdWithHttpInfo(String id)
Get Individual Batch File
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
|
ApiResponse<Void> |
TransientTokenDataApi.getTransactionForTransientTokenWithHttpInfo(String transientToken)
Get Transient Token Data
Retrieve the data captured by Unified Checkout.
|
ApiResponse<TssV2TransactionsGet200Response> |
TransactionDetailsApi.getTransactionWithHttpInfo(String id)
Retrieve a Transaction
Include the Request ID in the GET request to retrieve the transaction details.
|
ApiResponse<UmsV1UsersGet200Response> |
UserManagementApi.getUsersWithHttpInfo(String organizationId,
String userName,
String permissionId,
String roleId)
Get User Information - Deprecated
This endpoint is deprecated.
|
ApiResponse<InlineResponse2014> |
ManageWebhooksApi.getWebhookSubscriptionByIdWithHttpInfo(String webhookId)
Get Details On a Single Webhook
Retrieve the details of a specific webhook by supplying the webhook ID in the path.
|
ApiResponse<List<InlineResponse2004>> |
ManageWebhooksApi.getWebhookSubscriptionsByOrgWithHttpInfo(String organizationId,
String productId,
String eventType)
Get Details On All Created Webhooks
Retrieve a list of all previously created webhooks.
|
ApiResponse<Void> |
DownloadXsdApi.getXSDV2WithHttpInfo(String reportDefinitionNameVersion)
Download XSD for Report
Used to download XSDs for reports on no-auth.
|
ApiResponse<PtsV2IncrementalAuthorizationPatch201Response> |
PaymentsApi.incrementAuthWithHttpInfo(String id,
IncrementAuthRequest incrementAuthRequest)
Increment an Authorization
Use this service to authorize additional charges in a lodging or autorental transaction.
|
ApiResponse<PtsV2PaymentsReversalsPost201Response> |
ReversalApi.mitReversalWithHttpInfo(MitReversalRequest mitReversalRequest)
Timeout Reversal
This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout).
|
ApiResponse<PtsV2PaymentsVoidsPost201Response> |
VoidApi.mitVoidWithHttpInfo(MitVoidRequest mitVoidRequest)
Timeout Void
This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply(Mostly due to timeout).
|
ApiResponse<InlineResponse2015> |
ManageWebhooksApi.notificationSubscriptionsV1WebhooksWebhookIdPostWithHttpInfo(String webhookId)
Test a Webhook Configuration
Test the webhook configuration by sending a sample webhook.
|
ApiResponse<InlineResponse2014> |
CreateNewWebhooksApi.notificationSubscriptionsV2WebhooksPostWithHttpInfo(CreateWebhook createWebhook)
Create a New Webhook Subscription
Create a new webhook subscription.
|
ApiResponse<Void> |
ManageWebhooksApi.notificationSubscriptionsV2WebhooksWebhookIdPatchWithHttpInfo(String webhookId,
UpdateWebhook updateWebhook)
Update a Webhook Subscription
Update a Webhook Subscription.
|
ApiResponse<Void> |
ManageWebhooksApi.notificationSubscriptionsV2WebhooksWebhookIdStatusPutWithHttpInfo(String webhookId,
UpdateStatus updateStatus)
Update a Webhook Status
Users can update the status of a webhook subscription by calling this endpoint.
|
ApiResponse<PtsV2PayoutsPost201Response> |
PayoutsApi.octCreatePaymentWithHttpInfo(OctCreatePaymentRequest octCreatePaymentRequest)
Process a Payout
Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT).
|
ApiResponse<TssV2PostEmvTags200Response> |
EmvTagDetailsApi.parseEmvTagsWithHttpInfo(Body body)
Parse an EMV String
Pass an EMV Tag-Length-Value (TLV) string for parsing.
|
ApiResponse<PatchCustomerPaymentInstrumentRequest> |
CustomerPaymentInstrumentApi.patchCustomersPaymentInstrumentWithHttpInfo(String customerId,
String paymentInstrumentId,
PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
String profileId,
String ifMatch)
Update a Customer Payment Instrument
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PatchCustomerShippingAddressRequest> |
CustomerShippingAddressApi.patchCustomersShippingAddressWithHttpInfo(String customerId,
String shippingAddressId,
PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
String profileId,
String ifMatch)
Update a Customer Shipping Address
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PatchCustomerRequest> |
CustomerApi.patchCustomerWithHttpInfo(String customerId,
PatchCustomerRequest patchCustomerRequest,
String profileId,
String ifMatch)
Update a Customer
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PatchInstrumentIdentifierRequest> |
InstrumentIdentifierApi.patchInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId,
PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
String profileId,
Boolean retrieveBinDetails,
String ifMatch)
Update an Instrument Identifier
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PatchPaymentInstrumentRequest> |
PaymentInstrumentApi.patchPaymentInstrumentWithHttpInfo(String paymentInstrumentId,
PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
String profileId,
Boolean retrieveBinDetails,
String ifMatch)
Update a Payment Instrument
| | | | | --- | --- | --- | |**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.
|
ApiResponse<RiskV1AuthenticationSetupsPost201Response> |
PayerAuthenticationApi.payerAuthSetupWithHttpInfo(PayerAuthSetupRequest payerAuthSetupRequest)
Setup Payer Auth
A new service for Merchants to get reference_id for Digital Wallets to use in place of BIN number in Cardinal.
|
ApiResponse<InvoicingV2InvoicesCancel200Response> |
InvoicesApi.performCancelActionWithHttpInfo(String id)
Cancel an Invoice
You can cancel an invoice if no payment is made to it.
|
ApiResponse<InvoicingV2InvoicesSend200Response> |
InvoicesApi.performSendActionWithHttpInfo(String id)
Send an Invoice
You can send an invoice in draft or created state or resend a sent or partially paid invoice.
|
ApiResponse<AccessTokenResponse> |
OAuthApi.postAccessTokenFromAuthCodeWithHttpInfo(CreateAccessTokenRequest createAccessTokenRequest)
Post Access Token from Auth Code
|
ApiResponse<AccessTokenResponse> |
OAuthApi.postAccessTokenFromRefreshTokenWithHttpInfo(CreateAccessTokenRequest createAccessTokenRequest)
Post Access Token from Refresh Token
|
ApiResponse<InlineResponse202> |
BatchesApi.postBatchWithHttpInfo(Body body)
Create a Batch
**Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier.
|
ApiResponse<PostCustomerPaymentInstrumentRequest> |
CustomerPaymentInstrumentApi.postCustomerPaymentInstrumentWithHttpInfo(String customerId,
PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
String profileId)
Create a Customer Payment Instrument
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PostCustomerShippingAddressRequest> |
CustomerShippingAddressApi.postCustomerShippingAddressWithHttpInfo(String customerId,
PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
String profileId)
Create a Customer Shipping Address
| | | | | --- | --- | --- | |**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).
|
ApiResponse<PostCustomerRequest> |
CustomerApi.postCustomerWithHttpInfo(PostCustomerRequest postCustomerRequest,
String profileId)
Create a Customer
| | | | | --- | --- | --- | |**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).
|
ApiResponse<Void> |
InstrumentIdentifierApi.postInstrumentIdentifierEnrollmentWithHttpInfo(String instrumentIdentifierId,
PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest,
String profileId)
Enroll an Instrument Identifier for Payment Network Token
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PostInstrumentIdentifierRequest> |
InstrumentIdentifierApi.postInstrumentIdentifierWithHttpInfo(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
String profileId,
Boolean retrieveBinDetails)
Create an Instrument Identifier
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PostPaymentInstrumentRequest> |
PaymentInstrumentApi.postPaymentInstrumentWithHttpInfo(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
String profileId,
Boolean retrieveBinDetails)
Create a Payment Instrument
| | | | | --- | --- | --- | |**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.
|
ApiResponse<InlineResponse2012> |
MerchantBoardingApi.postRegistrationWithHttpInfo(PostRegistrationBody postRegistrationBody,
String vCIdempotencyId)
Create a boarding registration
Boarding Product is specifically for resellers who onboard merchants to resell their services to merchants and help integrate REST API into their systems.
|
ApiResponse<TokenizedcardRequest> |
TokenizedCardApi.postTokenizedCardWithHttpInfo(TokenizedcardRequest tokenizedcardRequest,
String profileId)
Create a Tokenized Card
| | | | | --- | --- | --- | |**Tokenized cards**<br>A Tokenized card represents a network token.
|
ApiResponse<String> |
TokenApi.postTokenPaymentCredentialsWithHttpInfo(String tokenId,
PostPaymentCredentialsRequest postPaymentCredentialsRequest,
String profileId)
Generate Payment Credentials for a TMS Token
| | | | | --- | --- | --- | |**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.
|
ApiResponse<PtsV2PaymentsPost201Response1> |
PaymentsApi.refreshPaymentStatusWithHttpInfo(String id,
RefreshPaymentStatusRequest refreshPaymentStatusRequest)
Check a Payment Status
Checks and updates the payment status
|
ApiResponse<PtsV2PaymentsRefundPost201Response> |
RefundApi.refundCaptureWithHttpInfo(RefundCaptureRequest refundCaptureRequest,
String id)
Refund a Capture
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.
|
ApiResponse<PtsV2PaymentsRefundPost201Response> |
RefundApi.refundPaymentWithHttpInfo(RefundPaymentRequest refundPaymentRequest,
String id)
Refund a Payment
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.
|
ApiResponse<InlineResponse2016> |
ManageWebhooksApi.saveAsymEgressKeyWithHttpInfo(String vCSenderOrganizationId,
String vCPermissions,
SaveAsymEgressKey saveAsymEgressKey,
String vCCorrelationId)
Message Level Encryption
Store and manage certificates that will be used to preform Message Level Encryption (MLE).
|
ApiResponse<InlineResponse2013> |
CreateNewWebhooksApi.saveSymEgressKeyWithHttpInfo(String vCSenderOrganizationId,
String vCPermissions,
String vCCorrelationId,
SaveSymEgressKey saveSymEgressKey)
Create Webhook Security Keys
Create security keys that CyberSource will use internally to connect to your servers and validate messages using a digital signature.
|
ApiResponse<ReportingV3ReportsGet200Response> |
ReportsApi.searchReportsWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String timeQueryType,
String organizationId,
String reportMimeType,
String reportFrequency,
String reportName,
Integer reportDefinitionId,
String reportStatus)
Retrieve Available Reports
Retrieve a list of the available reports to which you are subscribed.
|
ApiResponse<UmsV1UsersGet200Response> |
UserManagementSearchApi.searchUsersWithHttpInfo(SearchRequest searchRequest)
Search User Information
This endpoint is to get all the user information depending on the filter criteria passed in request body.
|
ApiResponse<SuspendSubscriptionResponse> |
SubscriptionsApi.suspendSubscriptionWithHttpInfo(String id)
Suspend a Subscription
Suspend a Subscription
|
ApiResponse<InvoicingV2InvoiceSettingsGet200Response> |
InvoiceSettingsApi.updateInvoiceSettingsWithHttpInfo(InvoiceSettingsRequest invoiceSettingsRequest)
Update Invoice Settings
Allows you to customize the payment page, the checkout experience, email communication and payer authentication.
|
ApiResponse<InvoicingV2InvoicesPut200Response> |
InvoicesApi.updateInvoiceWithHttpInfo(String id,
UpdateInvoiceRequest updateInvoiceRequest)
Update an Invoice
You can update all information except the invoice number till any payment is received for an invoice.
|
ApiResponse<PtsV2UpdateOrderPatch201Response> |
OrdersApi.updateOrderWithHttpInfo(String id,
UpdateOrderRequest updateOrderRequest)
Update an Order
This API can be used in two flavours - for updating the order as well as saving the order.
|
ApiResponse<PblPaymentLinksPost201Response> |
PaymentLinksApi.updatePaymentLinkWithHttpInfo(String id,
UpdatePaymentLinkRequest updatePaymentLinkRequest)
Update a Payment Link
You can update all information except the payment link number until any payment is received for a payment link.
|
ApiResponse<UpdatePlanResponse> |
PlansApi.updatePlanWithHttpInfo(String id,
UpdatePlanRequest updatePlanRequest)
Update a Plan
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`
|
ApiResponse<PtsV2PaymentsPost201Response2> |
PaymentsApi.updateSessionReqWithHttpInfo(CreateSessionRequest createSessionRequest,
String id)
Update Alternative Payments Sessions Request
Update Alternative Payments Sessions Request
|
ApiResponse<UpdateSubscriptionResponse> |
SubscriptionsApi.updateSubscriptionWithHttpInfo(String id,
UpdateSubscription updateSubscription)
Update a Subscription
Update a Subscription by Subscription Id
|
ApiResponse<Void> |
TransactionBatchesApi.uploadTransactionBatchWithHttpInfo(File file)
Upload a Batch File
This endpoint enables the upload of a batch file containing transactions for processing.
|
ApiResponse<RiskV1AuthenticationResultsPost201Response> |
PayerAuthenticationApi.validateAuthenticationResultsWithHttpInfo(ValidateRequest validateRequest)
Validate Authentication Results
This call retrieves and validates the authentication results from issuer and allows the merchant to proceed with processing the payment.
|
ApiResponse<RiskV1ExportComplianceInquiriesPost201Response> |
VerificationApi.validateExportComplianceWithHttpInfo(ValidateExportComplianceRequest validateExportComplianceRequest)
Validate export compliance
This call checks customer data against specified watch lists to ensure export compliance.
|
ApiResponse<RiskV1AddressVerificationsPost201Response> |
VerificationApi.verifyCustomerAddressWithHttpInfo(VerifyCustomerAddressRequest verifyCustomerAddressRequest)
Verify customer address
This call verifies that the customer address submitted is valid.
|
ApiResponse<PtsV2PaymentsVoidsPost201Response> |
VoidApi.voidCaptureWithHttpInfo(VoidCaptureRequest voidCaptureRequest,
String id)
Void a Capture
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.
|
ApiResponse<PtsV2PaymentsVoidsPost201Response> |
VoidApi.voidCreditWithHttpInfo(VoidCreditRequest voidCreditRequest,
String id)
Void a Credit
Include the credit ID in the POST request to cancel the credit.
|
ApiResponse<PtsV2PaymentsVoidsPost201Response> |
VoidApi.voidPaymentWithHttpInfo(VoidPaymentRequest voidPaymentRequest,
String id)
Void a Payment
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.
|
ApiResponse<PtsV2PaymentsVoidsPost201Response> |
VoidApi.voidRefundWithHttpInfo(VoidRefundRequest voidRefundRequest,
String id)
Void a Refund
Include the refund ID in the POST request to cancel the refund.
|
ApiResponse<VasV2TaxVoid200Response> |
TaxesApi.voidTaxWithHttpInfo(VoidTaxRequest voidTaxRequest,
String id)
Void Taxes
Pass the Tax Request ID in the PATCH request to void the committed tax calculation.
|
| Modifier and Type | Method and Description |
|---|---|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call)
|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call,
Type returnType)
Execute HTTP call and deserialize the HTTP response body into the given
return type.
|
Copyright © 2025. All rights reserved.