| Package | Description |
|---|---|
| Api | |
| Invokers |
| Modifier and Type | Method and Description |
|---|---|
InlineResponse200 |
DecisionManagerApi.actionDecisionManagerCase(String id,
CaseManagementActionsRequest caseManagementActionsRequest)
Take action on a DM post-transactional case
Take action on a DM post-transactional case
|
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 |
DecisionManagerApi.actionDecisionManagerCaseCall(String id,
CaseManagementActionsRequest caseManagementActionsRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for actionDecisionManagerCase
|
ApiResponse<InlineResponse200> |
DecisionManagerApi.actionDecisionManagerCaseWithHttpInfo(String id,
CaseManagementActionsRequest caseManagementActionsRequest)
Take action on a DM post-transactional case
Take action on a DM post-transactional case
|
ActivateDeactivatePlanResponse |
PlansApi.activatePlan(String id)
Activate a Plan
Activate a Plan
|
okhttp3.Call |
PlansApi.activatePlanAsync(String id,
ApiCallback<ActivateDeactivatePlanResponse> callback)
Activate a Plan (asynchronously)
Activate a Plan
|
okhttp3.Call |
PlansApi.activatePlanCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for activatePlan
|
ApiResponse<ActivateDeactivatePlanResponse> |
PlansApi.activatePlanWithHttpInfo(String id)
Activate a Plan
Activate a Plan
|
ActivateSubscriptionResponse |
SubscriptionsApi.activateSubscription(String id)
Activate a Subscription
Activate a `CANCELLED` Or `SUSPENDED` Subscription
|
okhttp3.Call |
SubscriptionsApi.activateSubscriptionAsync(String id,
ApiCallback<ActivateSubscriptionResponse> callback)
Activate a Subscription (asynchronously)
Activate a `CANCELLED` Or `SUSPENDED` Subscription
|
okhttp3.Call |
SubscriptionsApi.activateSubscriptionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for activateSubscription
|
ApiResponse<ActivateSubscriptionResponse> |
SubscriptionsApi.activateSubscriptionWithHttpInfo(String id)
Activate a Subscription
Activate a `CANCELLED` Or `SUSPENDED` Subscription
|
RiskV1UpdatePost201Response |
DecisionManagerApi.addNegative(String type,
AddNegativeListRequest addNegativeListRequest)
List Management
This call adds/deletes/converts the request information in the negative list.
|
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 |
DecisionManagerApi.addNegativeCall(String type,
AddNegativeListRequest addNegativeListRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for addNegative
|
ApiResponse<RiskV1UpdatePost201Response> |
DecisionManagerApi.addNegativeWithHttpInfo(String type,
AddNegativeListRequest addNegativeListRequest)
List Management
This call adds/deletes/converts the request information in the negative list.
|
PtsV2PaymentsReversalsPost201Response |
ReversalApi.authReversal(String id,
AuthReversalRequest authReversalRequest)
Process an Authorization Reversal
Include the payment ID in the POST request to reverse the payment amount.
|
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 |
ReversalApi.authReversalCall(String id,
AuthReversalRequest authReversalRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for authReversal
|
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.
|
PtsV2ModifyBillingAgreementPost201Response |
BillingAgreementsApi.billingAgreementsDeRegistration(ModifyBillingAgreement modifyBillingAgreement,
String id)
Modify a Billing Agreement
#### Standing Instruction: Standing Instruction with or without Token.
|
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.billingAgreementsDeRegistrationCall(ModifyBillingAgreement modifyBillingAgreement,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for billingAgreementsDeRegistration
|
ApiResponse<PtsV2ModifyBillingAgreementPost201Response> |
BillingAgreementsApi.billingAgreementsDeRegistrationWithHttpInfo(ModifyBillingAgreement modifyBillingAgreement,
String id)
Modify a Billing Agreement
#### Standing Instruction: Standing Instruction with or without Token.
|
PtsV2CreditsPost201Response1 |
BillingAgreementsApi.billingAgreementsIntimation(IntimateBillingAgreement intimateBillingAgreement,
String id)
Standing Instruction intimation
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.billingAgreementsIntimationCall(IntimateBillingAgreement intimateBillingAgreement,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for billingAgreementsIntimation
|
ApiResponse<PtsV2CreditsPost201Response1> |
BillingAgreementsApi.billingAgreementsIntimationWithHttpInfo(IntimateBillingAgreement intimateBillingAgreement,
String id)
Standing Instruction intimation
Standing Instruction with or without Token.
|
PtsV2CreateBillingAgreementPost201Response |
BillingAgreementsApi.billingAgreementsRegistration(CreateBillingAgreement createBillingAgreement)
Create a Billing Agreement
#### Standing Instruction: 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 |
BillingAgreementsApi.billingAgreementsRegistrationCall(CreateBillingAgreement createBillingAgreement,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for billingAgreementsRegistration
|
ApiResponse<PtsV2CreateBillingAgreementPost201Response> |
BillingAgreementsApi.billingAgreementsRegistrationWithHttpInfo(CreateBillingAgreement createBillingAgreement)
Create a Billing Agreement
#### Standing Instruction: Standing Instruction with or without Token.
|
VasV2PaymentsPost201Response |
TaxesApi.calculateTax(TaxRequest taxRequest)
Calculate Taxes
The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide.
|
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 |
TaxesApi.calculateTaxCall(TaxRequest taxRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for calculateTax
|
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.
|
CancelSubscriptionResponse |
SubscriptionsApi.cancelSubscription(String id)
Cancel a Subscription
Cancel a Subscription
|
okhttp3.Call |
SubscriptionsApi.cancelSubscriptionAsync(String id,
ApiCallback<CancelSubscriptionResponse> callback)
Cancel a Subscription (asynchronously)
Cancel a Subscription
|
okhttp3.Call |
SubscriptionsApi.cancelSubscriptionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for cancelSubscription
|
ApiResponse<CancelSubscriptionResponse> |
SubscriptionsApi.cancelSubscriptionWithHttpInfo(String id)
Cancel a Subscription
Cancel a Subscription
|
PtsV2PaymentsCapturesPost201Response |
CaptureApi.capturePayment(CapturePaymentRequest capturePaymentRequest,
String id)
Capture a Payment
Include the payment ID in the POST request to capture the payment amount.
|
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 |
CaptureApi.capturePaymentCall(CapturePaymentRequest capturePaymentRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for capturePayment
|
ApiResponse<PtsV2PaymentsCapturesPost201Response> |
CaptureApi.capturePaymentWithHttpInfo(CapturePaymentRequest capturePaymentRequest,
String id)
Capture a Payment
Include the payment ID in the POST request to capture the payment amount.
|
RiskV1AuthenticationsPost201Response |
PayerAuthenticationApi.checkPayerAuthEnrollment(CheckPayerAuthEnrollmentRequest checkPayerAuthEnrollmentRequest)
Check Payer Auth Enrollment
This call verifies that the card is enrolled in a card authentication program.
|
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 |
PayerAuthenticationApi.checkPayerAuthEnrollmentCall(CheckPayerAuthEnrollmentRequest checkPayerAuthEnrollmentRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for checkPayerAuthEnrollment
|
ApiResponse<RiskV1AuthenticationsPost201Response> |
PayerAuthenticationApi.checkPayerAuthEnrollmentWithHttpInfo(CheckPayerAuthEnrollmentRequest checkPayerAuthEnrollmentRequest)
Check Payer Auth Enrollment
This call verifies that the card is enrolled in a card authentication program.
|
InlineResponse201 |
DecisionManagerApi.commentDecisionManagerCase(String id,
CaseManagementCommentsRequest caseManagementCommentsRequest)
Add a comment to a DM post-transactional case
Add a comment to a DM post-transactional case
|
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.commentDecisionManagerCaseCall(String id,
CaseManagementCommentsRequest caseManagementCommentsRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for commentDecisionManagerCase
|
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
|
RiskV1DecisionsPost201Response |
DecisionManagerApi.createBundledDecisionManagerCase(CreateBundledDecisionManagerCaseRequest createBundledDecisionManagerCaseRequest)
Create Decision Manager
Decision Manager can help you automate and streamline your fraud operations.
|
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 |
DecisionManagerApi.createBundledDecisionManagerCaseCall(CreateBundledDecisionManagerCaseRequest createBundledDecisionManagerCaseRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createBundledDecisionManagerCase
|
ApiResponse<RiskV1DecisionsPost201Response> |
DecisionManagerApi.createBundledDecisionManagerCaseWithHttpInfo(CreateBundledDecisionManagerCaseRequest createBundledDecisionManagerCaseRequest)
Create Decision Manager
Decision Manager can help you automate and streamline your fraud operations.
|
PtsV2CreditsPost201Response |
CreditApi.createCredit(CreateCreditRequest createCreditRequest)
Process a Credit
POST to the credit resource to credit funds to a specified credit card.
|
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 |
CreditApi.createCreditCall(CreateCreditRequest createCreditRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createCredit
|
ApiResponse<PtsV2CreditsPost201Response> |
CreditApi.createCreditWithHttpInfo(CreateCreditRequest createCreditRequest)
Process a Credit
POST to the credit resource to credit funds to a specified credit card.
|
InvoicingV2InvoicesPost201Response |
InvoicesApi.createInvoice(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.
|
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 |
InvoicesApi.createInvoiceCall(CreateInvoiceRequest createInvoiceRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createInvoice
|
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.
|
PtsV2PaymentsOrderPost201Response |
PaymentsApi.createOrderRequest(OrderPaymentRequest orderPaymentRequest,
String id)
Create a Payment Order Request
Create a Payment Order Request
|
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.createOrderRequestCall(OrderPaymentRequest orderPaymentRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createOrderRequest
|
ApiResponse<PtsV2PaymentsOrderPost201Response> |
PaymentsApi.createOrderRequestWithHttpInfo(OrderPaymentRequest orderPaymentRequest,
String id)
Create a Payment Order Request
Create a Payment Order Request
|
KmsV2KeysAsymPost201Response |
AsymmetricKeyManagementApi.createP12Keys(CreateP12KeysRequest createP12KeysRequest)
Create one or more PKCS12 keys
'Create one or more PKCS12 keys'
|
okhttp3.Call |
AsymmetricKeyManagementApi.createP12KeysAsync(CreateP12KeysRequest createP12KeysRequest,
ApiCallback<KmsV2KeysAsymPost201Response> callback)
Create one or more PKCS12 keys (asynchronously)
'Create one or more PKCS12 keys'
|
okhttp3.Call |
AsymmetricKeyManagementApi.createP12KeysCall(CreateP12KeysRequest createP12KeysRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createP12Keys
|
ApiResponse<KmsV2KeysAsymPost201Response> |
AsymmetricKeyManagementApi.createP12KeysWithHttpInfo(CreateP12KeysRequest createP12KeysRequest)
Create one or more PKCS12 keys
'Create one or more PKCS12 keys'
|
PtsV2PaymentsPost201Response |
PaymentsApi.createPayment(CreatePaymentRequest createPaymentRequest)
Process a Payment
A payment authorizes the amount for the transaction.
|
okhttp3.Call |
PaymentsApi.createPaymentAsync(CreatePaymentRequest createPaymentRequest,
ApiCallback<PtsV2PaymentsPost201Response> callback)
Process a Payment (asynchronously)
A payment authorizes the amount for the transaction.
|
okhttp3.Call |
PaymentsApi.createPaymentCall(CreatePaymentRequest createPaymentRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createPayment
|
ApiResponse<PtsV2PaymentsPost201Response> |
PaymentsApi.createPaymentWithHttpInfo(CreatePaymentRequest createPaymentRequest)
Process a Payment
A payment authorizes the amount for the transaction.
|
CreatePlanResponse |
PlansApi.createPlan(CreatePlanRequest createPlanRequest)
Create a Plan
The recurring billing service enables you to manage payment plans and subscriptions for recurring payment schedules.
|
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 |
PlansApi.createPlanCall(CreatePlanRequest createPlanRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createPlan
|
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.
|
PushFunds201Response |
PushFundsApi.createPushFundsTransfer(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).
|
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 |
PushFundsApi.createPushFundsTransferCall(PushFundsRequest pushFundsRequest,
String contentType,
String xRequestid,
String vCMerchantId,
String vCPermissions,
String vCCorrelationId,
String vCOrganizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createPushFundsTransfer
|
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).
|
void |
ReportsApi.createReport(CreateAdhocReportRequest createAdhocReportRequest,
String organizationId)
Create Adhoc Report
Create a one-time report.
|
okhttp3.Call |
ReportsApi.createReportAsync(CreateAdhocReportRequest createAdhocReportRequest,
String organizationId,
ApiCallback<Void> callback)
Create Adhoc Report (asynchronously)
Create a one-time report.
|
okhttp3.Call |
ReportsApi.createReportCall(CreateAdhocReportRequest createAdhocReportRequest,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createReport
|
ApiResponse<Void> |
ReportsApi.createReportWithHttpInfo(CreateAdhocReportRequest createAdhocReportRequest,
String organizationId)
Create Adhoc Report
Create a one-time report.
|
TssV2TransactionsPost201Response |
SearchTransactionsApi.createSearch(CreateSearchRequest createSearchRequest)
Create a Search Request
Create a search request.
|
okhttp3.Call |
SearchTransactionsApi.createSearchAsync(CreateSearchRequest createSearchRequest,
ApiCallback<TssV2TransactionsPost201Response> callback)
Create a Search Request (asynchronously)
Create a search request.
|
okhttp3.Call |
SearchTransactionsApi.createSearchCall(CreateSearchRequest createSearchRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createSearch
|
ApiResponse<TssV2TransactionsPost201Response> |
SearchTransactionsApi.createSearchWithHttpInfo(CreateSearchRequest createSearchRequest)
Create a Search Request
Create a search request.
|
PtsV2PaymentsPost201Response2 |
PaymentsApi.createSessionRequest(CreateSessionReq createSessionReq)
Create Alternative Payments Sessions Request
Create Alternative Payments Sessions Request
|
okhttp3.Call |
PaymentsApi.createSessionRequestAsync(CreateSessionReq createSessionReq,
ApiCallback<PtsV2PaymentsPost201Response2> callback)
Create Alternative Payments Sessions Request (asynchronously)
Create Alternative Payments Sessions Request
|
okhttp3.Call |
PaymentsApi.createSessionRequestCall(CreateSessionReq createSessionReq,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createSessionRequest
|
ApiResponse<PtsV2PaymentsPost201Response2> |
PaymentsApi.createSessionRequestWithHttpInfo(CreateSessionReq createSessionReq)
Create Alternative Payments Sessions Request
Create Alternative Payments Sessions Request
|
void |
ReportSubscriptionsApi.createStandardOrClassicSubscription(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean,
String organizationId)
Create a Standard or Classic Subscription
Create or update an already existing classic or standard subscription.
|
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.createStandardOrClassicSubscriptionCall(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createStandardOrClassicSubscription
|
ApiResponse<Void> |
ReportSubscriptionsApi.createStandardOrClassicSubscriptionWithHttpInfo(PredefinedSubscriptionRequestBean predefinedSubscriptionRequestBean,
String organizationId)
Create a Standard or Classic Subscription
Create or update an already existing classic or standard subscription.
|
void |
ReportSubscriptionsApi.createSubscription(CreateReportSubscriptionRequest createReportSubscriptionRequest,
String organizationId)
Create Report Subscription for a Report Name by Organization
Create a report subscription for your organization.
|
CreateSubscriptionResponse |
SubscriptionsApi.createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
Create a Subscription
Create a Recurring Billing 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 |
ReportSubscriptionsApi.createSubscriptionCall(CreateReportSubscriptionRequest createReportSubscriptionRequest,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createSubscription
|
okhttp3.Call |
SubscriptionsApi.createSubscriptionCall(CreateSubscriptionRequest createSubscriptionRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createSubscription
|
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
|
KmsV2KeysSymPost201Response |
SymmetricKeyManagementApi.createV2SharedSecretKeys(CreateSharedSecretKeysRequest createSharedSecretKeysRequest)
Create Shared-Secret Keys
Create one or more Shared-Secret Keys
|
okhttp3.Call |
SymmetricKeyManagementApi.createV2SharedSecretKeysAsync(CreateSharedSecretKeysRequest createSharedSecretKeysRequest,
ApiCallback<KmsV2KeysSymPost201Response> callback)
Create Shared-Secret Keys (asynchronously)
Create one or more Shared-Secret Keys
|
okhttp3.Call |
SymmetricKeyManagementApi.createV2SharedSecretKeysCall(CreateSharedSecretKeysRequest createSharedSecretKeysRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createV2SharedSecretKeys
|
KmsV2KeysSymPost201Response |
SymmetricKeyManagementApi.createV2SharedSecretKeysVerifi(String vIcDomain,
CreateSharedSecretKeysVerifiRequest createSharedSecretKeysVerifiRequest)
Create Shared-Secret Keys as per verifi spec
Create one or more Shared-Secret Keys as per Verifi spec with 32 chars, store digest algo during key generation.
|
okhttp3.Call |
SymmetricKeyManagementApi.createV2SharedSecretKeysVerifiAsync(String vIcDomain,
CreateSharedSecretKeysVerifiRequest createSharedSecretKeysVerifiRequest,
ApiCallback<KmsV2KeysSymPost201Response> callback)
Create Shared-Secret Keys as per verifi spec (asynchronously)
Create one or more Shared-Secret Keys as per Verifi spec with 32 chars, store digest algo during key generation.
|
okhttp3.Call |
SymmetricKeyManagementApi.createV2SharedSecretKeysVerifiCall(String vIcDomain,
CreateSharedSecretKeysVerifiRequest createSharedSecretKeysVerifiRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createV2SharedSecretKeysVerifi
|
ApiResponse<KmsV2KeysSymPost201Response> |
SymmetricKeyManagementApi.createV2SharedSecretKeysVerifiWithHttpInfo(String vIcDomain,
CreateSharedSecretKeysVerifiRequest createSharedSecretKeysVerifiRequest)
Create Shared-Secret Keys as per verifi spec
Create one or more Shared-Secret Keys as per Verifi spec with 32 chars, store digest algo during key generation.
|
ApiResponse<KmsV2KeysSymPost201Response> |
SymmetricKeyManagementApi.createV2SharedSecretKeysWithHttpInfo(CreateSharedSecretKeysRequest createSharedSecretKeysRequest)
Create Shared-Secret Keys
Create one or more Shared-Secret Keys
|
InlineResponse2013 |
CreateNewWebhooksApi.createWebhookSubscription(CreateWebhookRequest createWebhookRequest)
Create a Webhook
Create a new webhook subscription.
|
okhttp3.Call |
CreateNewWebhooksApi.createWebhookSubscriptionAsync(CreateWebhookRequest createWebhookRequest,
ApiCallback<InlineResponse2013> callback)
Create a Webhook (asynchronously)
Create a new webhook subscription.
|
okhttp3.Call |
CreateNewWebhooksApi.createWebhookSubscriptionCall(CreateWebhookRequest createWebhookRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createWebhookSubscription
|
ApiResponse<InlineResponse2013> |
CreateNewWebhooksApi.createWebhookSubscriptionWithHttpInfo(CreateWebhookRequest createWebhookRequest)
Create a Webhook
Create a new webhook subscription.
|
ActivateDeactivatePlanResponse |
PlansApi.deactivatePlan(String id)
Deactivate a Plan
Deactivate a Plan
|
okhttp3.Call |
PlansApi.deactivatePlanAsync(String id,
ApiCallback<ActivateDeactivatePlanResponse> callback)
Deactivate a Plan (asynchronously)
Deactivate a Plan
|
okhttp3.Call |
PlansApi.deactivatePlanCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deactivatePlan
|
ApiResponse<ActivateDeactivatePlanResponse> |
PlansApi.deactivatePlanWithHttpInfo(String id)
Deactivate a Plan
Deactivate a Plan
|
KmsV2KeysAsymDeletesPost200Response |
AsymmetricKeyManagementApi.deleteBulkP12Keys(DeleteBulkP12KeysRequest deleteBulkP12KeysRequest)
Delete one or more PKCS12 keys
'Delete one or more PKCS12 keys'
|
okhttp3.Call |
AsymmetricKeyManagementApi.deleteBulkP12KeysAsync(DeleteBulkP12KeysRequest deleteBulkP12KeysRequest,
ApiCallback<KmsV2KeysAsymDeletesPost200Response> callback)
Delete one or more PKCS12 keys (asynchronously)
'Delete one or more PKCS12 keys'
|
okhttp3.Call |
AsymmetricKeyManagementApi.deleteBulkP12KeysCall(DeleteBulkP12KeysRequest deleteBulkP12KeysRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteBulkP12Keys
|
ApiResponse<KmsV2KeysAsymDeletesPost200Response> |
AsymmetricKeyManagementApi.deleteBulkP12KeysWithHttpInfo(DeleteBulkP12KeysRequest deleteBulkP12KeysRequest)
Delete one or more PKCS12 keys
'Delete one or more PKCS12 keys'
|
KmsV2KeysSymDeletesPost200Response |
SymmetricKeyManagementApi.deleteBulkSymmetricKeys(DeleteBulkSymmetricKeysRequest deleteBulkSymmetricKeysRequest)
Delete one or more Symmetric keys
'Delete one or more Symmetric keys'
|
okhttp3.Call |
SymmetricKeyManagementApi.deleteBulkSymmetricKeysAsync(DeleteBulkSymmetricKeysRequest deleteBulkSymmetricKeysRequest,
ApiCallback<KmsV2KeysSymDeletesPost200Response> callback)
Delete one or more Symmetric keys (asynchronously)
'Delete one or more Symmetric keys'
|
okhttp3.Call |
SymmetricKeyManagementApi.deleteBulkSymmetricKeysCall(DeleteBulkSymmetricKeysRequest deleteBulkSymmetricKeysRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteBulkSymmetricKeys
|
ApiResponse<KmsV2KeysSymDeletesPost200Response> |
SymmetricKeyManagementApi.deleteBulkSymmetricKeysWithHttpInfo(DeleteBulkSymmetricKeysRequest deleteBulkSymmetricKeysRequest)
Delete one or more Symmetric keys
'Delete one or more Symmetric keys'
|
void |
CustomerApi.deleteCustomer(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.
|
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 |
CustomerApi.deleteCustomerCall(String customerId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteCustomer
|
void |
CustomerPaymentInstrumentApi.deleteCustomerPaymentInstrument(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.
|
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 |
CustomerPaymentInstrumentApi.deleteCustomerPaymentInstrumentCall(String customerId,
String paymentInstrumentId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteCustomerPaymentInstrument
|
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.
|
void |
CustomerShippingAddressApi.deleteCustomerShippingAddress(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).
|
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 |
CustomerShippingAddressApi.deleteCustomerShippingAddressCall(String customerId,
String shippingAddressId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteCustomerShippingAddress
|
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.
|
void |
InstrumentIdentifierApi.deleteInstrumentIdentifier(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).
|
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 |
InstrumentIdentifierApi.deleteInstrumentIdentifierCall(String instrumentIdentifierId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteInstrumentIdentifier
|
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).
|
void |
PaymentInstrumentApi.deletePaymentInstrument(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.
|
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 |
PaymentInstrumentApi.deletePaymentInstrumentCall(String paymentInstrumentId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deletePaymentInstrument
|
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.
|
DeletePlanResponse |
PlansApi.deletePlan(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
|
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 |
PlansApi.deletePlanCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deletePlan
|
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
|
void |
ReportSubscriptionsApi.deleteSubscription(String reportName,
String organizationId)
Delete Subscription of a Report Name by Organization
Delete a report subscription for your organization.
|
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 |
ReportSubscriptionsApi.deleteSubscriptionCall(String reportName,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteSubscription
|
ApiResponse<Void> |
ReportSubscriptionsApi.deleteSubscriptionWithHttpInfo(String reportName,
String organizationId)
Delete Subscription of a Report Name by Organization
Delete a report subscription for your organization.
|
void |
ManageWebhooksApi.deleteWebhookSubscription(String webhookId)
Delete a Webhook Subscription
Delete the webhook.
|
okhttp3.Call |
ManageWebhooksApi.deleteWebhookSubscriptionAsync(String webhookId,
ApiCallback<Void> callback)
Delete a Webhook Subscription (asynchronously)
Delete the webhook.
|
okhttp3.Call |
ManageWebhooksApi.deleteWebhookSubscriptionCall(String webhookId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteWebhookSubscription
|
ApiResponse<Void> |
ManageWebhooksApi.deleteWebhookSubscriptionWithHttpInfo(String webhookId)
Delete a Webhook Subscription
Delete the webhook.
|
void |
ReportDownloadsApi.downloadReport(org.joda.time.LocalDate reportDate,
String reportName,
String organizationId)
Download a Report
Download a report using the unique report name and date.
|
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 |
ReportDownloadsApi.downloadReportCall(org.joda.time.LocalDate reportDate,
String reportName,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for downloadReport
|
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.
|
List<InlineResponse2003> |
CreateNewWebhooksApi.findProductsToSubscribe(String organizationId)
Find Products You Can Subscribe To
Retrieve a list of products and event types that your account is eligible for.
|
okhttp3.Call |
CreateNewWebhooksApi.findProductsToSubscribeAsync(String organizationId,
ApiCallback<List<InlineResponse2003>> callback)
Find Products You Can Subscribe To (asynchronously)
Retrieve a list of products and event types that your account is eligible for.
|
okhttp3.Call |
CreateNewWebhooksApi.findProductsToSubscribeCall(String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for findProductsToSubscribe
|
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.
|
RiskV1UpdatePost201Response |
DecisionManagerApi.fraudUpdate(String id,
FraudMarkingActionRequest fraudMarkingActionRequest)
Fraud Marking
This can be used to - 1.
|
okhttp3.Call |
DecisionManagerApi.fraudUpdateAsync(String id,
FraudMarkingActionRequest fraudMarkingActionRequest,
ApiCallback<RiskV1UpdatePost201Response> callback)
Fraud Marking (asynchronously)
This can be used to - 1.
|
okhttp3.Call |
DecisionManagerApi.fraudUpdateCall(String id,
FraudMarkingActionRequest fraudMarkingActionRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for fraudUpdate
|
ApiResponse<RiskV1UpdatePost201Response> |
DecisionManagerApi.fraudUpdateWithHttpInfo(String id,
FraudMarkingActionRequest fraudMarkingActionRequest)
Fraud Marking
This can be used to - 1.
|
String |
MicroformIntegrationApi.generateCaptureContext(GenerateCaptureContextRequest generateCaptureContextRequest)
Generate Capture Context
This API is used to generate the Capture Context data structure for the Microform Integration.
|
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 |
MicroformIntegrationApi.generateCaptureContextCall(GenerateCaptureContextRequest generateCaptureContextRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for generateCaptureContext
|
ApiResponse<String> |
MicroformIntegrationApi.generateCaptureContextWithHttpInfo(GenerateCaptureContextRequest generateCaptureContextRequest)
Generate Capture Context
This API is used to generate the Capture Context data structure for the Microform Integration.
|
String |
UnifiedCheckoutCaptureContextApi.generateUnifiedCheckoutCaptureContext(GenerateUnifiedCheckoutCaptureContextRequest generateUnifiedCheckoutCaptureContextRequest)
Generate Unified Checkout Capture Context
Unified Checkout is a powerful product within the Digital Acceptance Suite.
|
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 |
UnifiedCheckoutCaptureContextApi.generateUnifiedCheckoutCaptureContextCall(GenerateUnifiedCheckoutCaptureContextRequest generateUnifiedCheckoutCaptureContextRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for generateUnifiedCheckoutCaptureContext
|
ApiResponse<String> |
UnifiedCheckoutCaptureContextApi.generateUnifiedCheckoutCaptureContextWithHttpInfo(GenerateUnifiedCheckoutCaptureContextRequest generateUnifiedCheckoutCaptureContextRequest)
Generate Unified Checkout Capture Context
Unified Checkout is a powerful product within the Digital Acceptance Suite.
|
InvoicingV2InvoicesAllGet200Response |
InvoicesApi.getAllInvoices(Integer offset,
Integer limit,
String status)
Get a List of Invoices
Provides a (filtered) list of invoices that have been created in your account.
|
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 |
InvoicesApi.getAllInvoicesCall(Integer offset,
Integer limit,
String status,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getAllInvoices
|
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.
|
GetAllSubscriptionsResponse |
SubscriptionsApi.getAllSubscriptions(Integer offset,
Integer limit,
String code,
String status)
Get a List of Subscriptions
Retrieve Subscriptions by Subscription Code & Subscription Status.
|
ReportingV3ReportSubscriptionsGet200Response |
ReportSubscriptionsApi.getAllSubscriptions(String organizationId)
Get All Subscriptions
View a summary of all report subscriptions.
|
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 |
SubscriptionsApi.getAllSubscriptionsCall(Integer offset,
Integer limit,
String code,
String status,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getAllSubscriptions
|
okhttp3.Call |
ReportSubscriptionsApi.getAllSubscriptionsCall(String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getAllSubscriptions
|
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.
|
InlineResponse2005 |
BatchesApi.getBatchesList(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.
|
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.getBatchesListCall(Long offset,
Long limit,
String fromDate,
String toDate,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getBatchesList
|
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.
|
InlineResponse2007 |
BatchesApi.getBatchReport(String batchId)
Retrieve a Batch Report
**Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status.
|
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.getBatchReportCall(String batchId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getBatchReport
|
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.
|
InlineResponse2006 |
BatchesApi.getBatchStatus(String batchId)
Retrieve a Batch Status
**Get Batch Status**<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 |
BatchesApi.getBatchStatusCall(String batchId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getBatchStatus
|
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.
|
ReportingV3ChargebackDetailsGet200Response |
ChargebackDetailsApi.getChargebackDetails(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Chargeback Details
Chargeback Detail Report Description
|
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 |
ChargebackDetailsApi.getChargebackDetailsCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getChargebackDetails
|
ApiResponse<ReportingV3ChargebackDetailsGet200Response> |
ChargebackDetailsApi.getChargebackDetailsWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Chargeback Details
Chargeback Detail Report Description
|
ReportingV3ChargebackSummariesGet200Response |
ChargebackSummariesApi.getChargebackSummaries(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Chargeback Summaries
Chargeback Summary 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 |
ChargebackSummariesApi.getChargebackSummariesCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getChargebackSummaries
|
ApiResponse<ReportingV3ChargebackSummariesGet200Response> |
ChargebackSummariesApi.getChargebackSummariesWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Chargeback Summaries
Chargeback Summary Report Description
|
ReportingV3ConversionDetailsGet200Response |
ConversionDetailsApi.getConversionDetail(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Conversion Detail Transactions
Get conversion detail of transactions for a merchant.
|
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 |
ConversionDetailsApi.getConversionDetailCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getConversionDetail
|
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.
|
TmsV2CustomersResponse |
CustomerApi.getCustomer(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).
|
okhttp3.Call |
CustomerApi.getCustomerAsync(String customerId,
String profileId,
ApiCallback<TmsV2CustomersResponse> 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 |
CustomerApi.getCustomerCall(String customerId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getCustomer
|
Tmsv2customersEmbeddedDefaultPaymentInstrument |
CustomerPaymentInstrumentApi.getCustomerPaymentInstrument(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.
|
okhttp3.Call |
CustomerPaymentInstrumentApi.getCustomerPaymentInstrumentAsync(String customerId,
String paymentInstrumentId,
String profileId,
ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> 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.getCustomerPaymentInstrumentCall(String customerId,
String paymentInstrumentId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getCustomerPaymentInstrument
|
PaymentInstrumentList |
CustomerPaymentInstrumentApi.getCustomerPaymentInstrumentsList(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.
|
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 |
CustomerPaymentInstrumentApi.getCustomerPaymentInstrumentsListCall(String customerId,
String profileId,
Long offset,
Long limit,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getCustomerPaymentInstrumentsList
|
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<Tmsv2customersEmbeddedDefaultPaymentInstrument> |
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.
|
Tmsv2customersEmbeddedDefaultShippingAddress |
CustomerShippingAddressApi.getCustomerShippingAddress(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).
|
okhttp3.Call |
CustomerShippingAddressApi.getCustomerShippingAddressAsync(String customerId,
String shippingAddressId,
String profileId,
ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> 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.getCustomerShippingAddressCall(String customerId,
String shippingAddressId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getCustomerShippingAddress
|
ShippingAddressListForCustomer |
CustomerShippingAddressApi.getCustomerShippingAddressesList(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.
|
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 |
CustomerShippingAddressApi.getCustomerShippingAddressesListCall(String customerId,
String profileId,
Long offset,
Long limit,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getCustomerShippingAddressesList
|
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<Tmsv2customersEmbeddedDefaultShippingAddress> |
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<TmsV2CustomersResponse> |
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).
|
void |
DownloadDTDApi.getDTDV2(String reportDefinitionNameVersion)
Download DTD for Report
Used to download DTDs for reports on no-auth.
|
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 |
DownloadDTDApi.getDTDV2Call(String reportDefinitionNameVersion,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getDTDV2
|
ApiResponse<Void> |
DownloadDTDApi.getDTDV2WithHttpInfo(String reportDefinitionNameVersion)
Download DTD for Report
Used to download DTDs for reports on no-auth.
|
TssV2GetEmvTags200Response |
EMVTagDetailsApi.getEmvTags()
Retrieve the EMV Dictionary
Returns the entire EMV tag dictionary
|
okhttp3.Call |
EMVTagDetailsApi.getEmvTagsAsync(ApiCallback<TssV2GetEmvTags200Response> callback)
Retrieve the EMV Dictionary (asynchronously)
Returns the entire EMV tag dictionary
|
okhttp3.Call |
EMVTagDetailsApi.getEmvTagsCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getEmvTags
|
ApiResponse<TssV2GetEmvTags200Response> |
EMVTagDetailsApi.getEmvTagsWithHttpInfo()
Retrieve the EMV Dictionary
Returns the entire EMV tag dictionary
|
void |
SecureFileShareApi.getFile(String fileId,
String organizationId)
Download a File with File Identifier
Download a file for the given file identifier
|
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.getFileCall(String fileId,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getFile
|
V1FileDetailsGet200Response |
SecureFileShareApi.getFileDetail(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
|
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 |
SecureFileShareApi.getFileDetailCall(org.joda.time.LocalDate startDate,
org.joda.time.LocalDate endDate,
String organizationId,
String name,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getFileDetail
|
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
|
TmsEmbeddedInstrumentIdentifier |
InstrumentIdentifierApi.getInstrumentIdentifier(String instrumentIdentifierId,
String profileId)
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.
|
okhttp3.Call |
InstrumentIdentifierApi.getInstrumentIdentifierAsync(String instrumentIdentifierId,
String profileId,
ApiCallback<TmsEmbeddedInstrumentIdentifier> 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.getInstrumentIdentifierCall(String instrumentIdentifierId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getInstrumentIdentifier
|
PaymentInstrumentList |
InstrumentIdentifierApi.getInstrumentIdentifierPaymentInstrumentsList(String instrumentIdentifierId,
String profileId,
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.
|
okhttp3.Call |
InstrumentIdentifierApi.getInstrumentIdentifierPaymentInstrumentsListAsync(String instrumentIdentifierId,
String profileId,
Long offset,
Long limit,
ApiCallback<PaymentInstrumentList> 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 |
InstrumentIdentifierApi.getInstrumentIdentifierPaymentInstrumentsListCall(String instrumentIdentifierId,
String profileId,
Long offset,
Long limit,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getInstrumentIdentifierPaymentInstrumentsList
|
ApiResponse<PaymentInstrumentList> |
InstrumentIdentifierApi.getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(String instrumentIdentifierId,
String profileId,
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<TmsEmbeddedInstrumentIdentifier> |
InstrumentIdentifierApi.getInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId,
String profileId)
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.
|
ReportingV3InterchangeClearingLevelDetailsGet200Response |
InterchangeClearingLevelDetailsApi.getInterchangeClearingLevelDetails(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
|
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 |
InterchangeClearingLevelDetailsApi.getInterchangeClearingLevelDetailsCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getInterchangeClearingLevelDetails
|
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
|
InvoicingV2InvoicesGet200Response |
InvoicesApi.getInvoice(String id)
Get Invoice Details
You can retrieve details of a specific invoice.
|
okhttp3.Call |
InvoicesApi.getInvoiceAsync(String id,
ApiCallback<InvoicingV2InvoicesGet200Response> callback)
Get Invoice Details (asynchronously)
You can retrieve details of a specific invoice.
|
okhttp3.Call |
InvoicesApi.getInvoiceCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getInvoice
|
InvoicingV2InvoiceSettingsGet200Response |
InvoiceSettingsApi.getInvoiceSettings()
Get Invoice Settings
Allows you to retrieve the invoice settings for the payment page.
|
okhttp3.Call |
InvoiceSettingsApi.getInvoiceSettingsAsync(ApiCallback<InvoicingV2InvoiceSettingsGet200Response> callback)
Get Invoice Settings (asynchronously)
Allows you to retrieve the invoice settings for the payment page.
|
okhttp3.Call |
InvoiceSettingsApi.getInvoiceSettingsCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getInvoiceSettings
|
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.
|
KmsV2KeysSymGet200Response |
SymmetricKeyManagementApi.getKeyDetails(String keyId)
Retrieves shared secret key details
Retrieves keys details by providing the key id.
|
okhttp3.Call |
SymmetricKeyManagementApi.getKeyDetailsAsync(String keyId,
ApiCallback<KmsV2KeysSymGet200Response> callback)
Retrieves shared secret key details (asynchronously)
Retrieves keys details by providing the key id.
|
okhttp3.Call |
SymmetricKeyManagementApi.getKeyDetailsCall(String keyId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getKeyDetails
|
ApiResponse<KmsV2KeysSymGet200Response> |
SymmetricKeyManagementApi.getKeyDetailsWithHttpInfo(String keyId)
Retrieves shared secret key details
Retrieves keys details by providing the key id.
|
ReportingV3NetFundingsGet200Response |
NetFundingsApi.getNetFundingDetails(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.
|
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 |
NetFundingsApi.getNetFundingDetailsCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
String groupName,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getNetFundingDetails
|
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.
|
ReportingV3NotificationofChangesGet200Response |
NotificationOfChangesApi.getNotificationOfChangeReport(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime)
Get Notification of Changes
Download the Notification of Change report.
|
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 |
NotificationOfChangesApi.getNotificationOfChangeReportCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getNotificationOfChangeReport
|
ApiResponse<ReportingV3NotificationofChangesGet200Response> |
NotificationOfChangesApi.getNotificationOfChangeReportWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime)
Get Notification of Changes
Download the Notification of Change report.
|
KmsV2KeysAsymGet200Response |
AsymmetricKeyManagementApi.getP12KeyDetails(String keyId)
Retrieves PKCS12 key details
Retrieves keys details by providing the key id.
|
okhttp3.Call |
AsymmetricKeyManagementApi.getP12KeyDetailsAsync(String keyId,
ApiCallback<KmsV2KeysAsymGet200Response> callback)
Retrieves PKCS12 key details (asynchronously)
Retrieves keys details by providing the key id.
|
okhttp3.Call |
AsymmetricKeyManagementApi.getP12KeyDetailsCall(String keyId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getP12KeyDetails
|
ApiResponse<KmsV2KeysAsymGet200Response> |
AsymmetricKeyManagementApi.getP12KeyDetailsWithHttpInfo(String keyId)
Retrieves PKCS12 key details
Retrieves keys details by providing the key id.
|
ReportingV3PaymentBatchSummariesGet200Response |
PaymentBatchSummariesApi.getPaymentBatchSummary(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.
|
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 |
PaymentBatchSummariesApi.getPaymentBatchSummaryCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
String rollUp,
String breakdown,
Integer startDayOfWeek,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getPaymentBatchSummary
|
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.
|
String |
TransientTokenDataApi.getPaymentCredentialsForTransientToken(String jti)
Get Payment Credentials
Retrieve the Payment data captured by Unified Checkout.
|
okhttp3.Call |
TransientTokenDataApi.getPaymentCredentialsForTransientTokenAsync(String jti,
ApiCallback<String> callback)
Get Payment Credentials (asynchronously)
Retrieve the Payment data captured by Unified Checkout.
|
okhttp3.Call |
TransientTokenDataApi.getPaymentCredentialsForTransientTokenCall(String jti,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getPaymentCredentialsForTransientToken
|
ApiResponse<String> |
TransientTokenDataApi.getPaymentCredentialsForTransientTokenWithHttpInfo(String jti)
Get Payment Credentials
Retrieve the Payment data captured by Unified Checkout.
|
Tmsv2customersEmbeddedDefaultPaymentInstrument |
PaymentInstrumentApi.getPaymentInstrument(String paymentInstrumentId,
String profileId)
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.
|
okhttp3.Call |
PaymentInstrumentApi.getPaymentInstrumentAsync(String paymentInstrumentId,
String profileId,
ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> 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 |
PaymentInstrumentApi.getPaymentInstrumentCall(String paymentInstrumentId,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getPaymentInstrument
|
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> |
PaymentInstrumentApi.getPaymentInstrumentWithHttpInfo(String paymentInstrumentId,
String profileId)
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.
|
GetPlanResponse |
PlansApi.getPlan(String id)
Get a Plan
Retrieve a Plan details by Plan Id.
|
okhttp3.Call |
PlansApi.getPlanAsync(String id,
ApiCallback<GetPlanResponse> callback)
Get a Plan (asynchronously)
Retrieve a Plan details by Plan Id.
|
okhttp3.Call |
PlansApi.getPlanCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getPlan
|
GetPlanCodeResponse |
PlansApi.getPlanCode()
Get a Plan Code
Get a Unique Plan Code
|
okhttp3.Call |
PlansApi.getPlanCodeAsync(ApiCallback<GetPlanCodeResponse> callback)
Get a Plan Code (asynchronously)
Get a Unique Plan Code
|
okhttp3.Call |
PlansApi.getPlanCodeCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getPlanCode
|
ApiResponse<GetPlanCodeResponse> |
PlansApi.getPlanCodeWithHttpInfo()
Get a Plan Code
Get a Unique Plan Code
|
GetAllPlansResponse |
PlansApi.getPlans(Integer offset,
Integer limit,
String code,
String status,
String name)
Get a List of Plans
Retrieve Plans by Plan Code & Plan Status.
|
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 |
PlansApi.getPlansCall(Integer offset,
Integer limit,
String code,
String status,
String name,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getPlans
|
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.
|
ReportingV3PurchaseRefundDetailsGet200Response |
PurchaseAndRefundDetailsApi.getPurchaseAndRefundDetails(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.
|
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 |
PurchaseAndRefundDetailsApi.getPurchaseAndRefundDetailsCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
String paymentSubtype,
String viewBy,
String groupName,
Integer offset,
Integer limit,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getPurchaseAndRefundDetails
|
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.
|
InlineResponse2002 |
MerchantBoardingApi.getRegistration(String registrationId)
Gets all the information on a boarding registration
This end point will get all information of a boarding registration
|
okhttp3.Call |
MerchantBoardingApi.getRegistrationAsync(String registrationId,
ApiCallback<InlineResponse2002> callback)
Gets all the information on a boarding registration (asynchronously)
This end point will get all information of a boarding registration
|
okhttp3.Call |
MerchantBoardingApi.getRegistrationCall(String registrationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getRegistration
|
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
|
ReportingV3ReportsIdGet200Response |
ReportsApi.getReportByReportId(String reportId,
String organizationId)
Get Report Based on Report Id
Download a report using the reportId value.
|
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 |
ReportsApi.getReportByReportIdCall(String reportId,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getReportByReportId
|
ApiResponse<ReportingV3ReportsIdGet200Response> |
ReportsApi.getReportByReportIdWithHttpInfo(String reportId,
String organizationId)
Get Report Based on Report Id
Download a report using the reportId value.
|
ReportingV3ReportDefinitionsNameGet200Response |
ReportDefinitionsApi.getResourceInfoByReportDefinition(String reportDefinitionName,
String subscriptionType,
String reportMimeType,
String organizationId)
Get Report Definition
View the attributes of an individual report type.
|
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.getResourceInfoByReportDefinitionCall(String reportDefinitionName,
String subscriptionType,
String reportMimeType,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getResourceInfoByReportDefinition
|
ApiResponse<ReportingV3ReportDefinitionsNameGet200Response> |
ReportDefinitionsApi.getResourceInfoByReportDefinitionWithHttpInfo(String reportDefinitionName,
String subscriptionType,
String reportMimeType,
String organizationId)
Get Report Definition
View the attributes of an individual report type.
|
ReportingV3ReportDefinitionsGet200Response |
ReportDefinitionsApi.getResourceV2Info(String subscriptionType,
String organizationId)
Get Reporting Resource Information
View a list of supported reports and their attributes before subscribing to them.
|
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 |
ReportDefinitionsApi.getResourceV2InfoCall(String subscriptionType,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getResourceV2Info
|
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.
|
ReportingV3RetrievalDetailsGet200Response |
RetrievalDetailsApi.getRetrievalDetails(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Retrieval Details
Retrieval Detail Report Description
|
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 |
RetrievalDetailsApi.getRetrievalDetailsCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getRetrievalDetails
|
ApiResponse<ReportingV3RetrievalDetailsGet200Response> |
RetrievalDetailsApi.getRetrievalDetailsWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Retrieval Details
Retrieval Detail Report Description
|
ReportingV3RetrievalSummariesGet200Response |
RetrievalSummariesApi.getRetrievalSummary(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Retrieval Summaries
Retrieval Summary 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 |
RetrievalSummariesApi.getRetrievalSummaryCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getRetrievalSummary
|
ApiResponse<ReportingV3RetrievalSummariesGet200Response> |
RetrievalSummariesApi.getRetrievalSummaryWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String organizationId)
Get Retrieval Summaries
Retrieval Summary Report Description
|
TssV2TransactionsPost201Response |
SearchTransactionsApi.getSearch(String searchId)
Get Search Results
Include the Search ID in the GET request to retrieve the search results.
|
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 |
SearchTransactionsApi.getSearchCall(String searchId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getSearch
|
ApiResponse<TssV2TransactionsPost201Response> |
SearchTransactionsApi.getSearchWithHttpInfo(String searchId)
Get Search Results
Include the Search ID in the GET request to retrieve the search results.
|
GetSubscriptionResponse |
SubscriptionsApi.getSubscription(String id)
Get a Subscription
Get a Subscription by Subscription Id
|
ReportingV3ReportSubscriptionsGet200ResponseSubscriptions |
ReportSubscriptionsApi.getSubscription(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.
|
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.getSubscriptionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getSubscription
|
okhttp3.Call |
ReportSubscriptionsApi.getSubscriptionCall(String reportName,
String organizationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getSubscription
|
GetSubscriptionCodeResponse |
SubscriptionsApi.getSubscriptionCode()
Get a Subscription Code
Get a Unique Subscription Code
|
okhttp3.Call |
SubscriptionsApi.getSubscriptionCodeAsync(ApiCallback<GetSubscriptionCodeResponse> callback)
Get a Subscription Code (asynchronously)
Get a Unique Subscription Code
|
okhttp3.Call |
SubscriptionsApi.getSubscriptionCodeCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getSubscriptionCode
|
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.
|
TssV2TransactionsGet200Response |
TransactionDetailsApi.getTransaction(String id)
Retrieve a Transaction
Include the Request ID in the GET request to retrieve the transaction details.
|
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.
|
void |
TransactionBatchesApi.getTransactionBatchDetails(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.
|
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.getTransactionBatchDetailsCall(String id,
org.joda.time.LocalDate uploadDate,
String status,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getTransactionBatchDetails
|
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.
|
PtsV1TransactionBatchesGet200Response |
TransactionBatchesApi.getTransactionBatches(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime)
Get a List of Batch Files
Provide the search range
|
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 search range
|
okhttp3.Call |
TransactionBatchesApi.getTransactionBatchesCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getTransactionBatches
|
ApiResponse<PtsV1TransactionBatchesGet200Response> |
TransactionBatchesApi.getTransactionBatchesWithHttpInfo(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime)
Get a List of Batch Files
Provide the search range
|
PtsV1TransactionBatchesIdGet200Response |
TransactionBatchesApi.getTransactionBatchId(String id)
Get Individual Batch File
Provide the search range
|
okhttp3.Call |
TransactionBatchesApi.getTransactionBatchIdAsync(String id,
ApiCallback<PtsV1TransactionBatchesIdGet200Response> callback)
Get Individual Batch File (asynchronously)
Provide the search range
|
okhttp3.Call |
TransactionBatchesApi.getTransactionBatchIdCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getTransactionBatchId
|
ApiResponse<PtsV1TransactionBatchesIdGet200Response> |
TransactionBatchesApi.getTransactionBatchIdWithHttpInfo(String id)
Get Individual Batch File
Provide the search range
|
okhttp3.Call |
TransactionDetailsApi.getTransactionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getTransaction
|
void |
TransientTokenDataApi.getTransactionForTransientToken(String transientToken)
Get Transient Token Data
Retrieve the data captured by Unified Checkout.
|
okhttp3.Call |
TransientTokenDataApi.getTransactionForTransientTokenAsync(String transientToken,
ApiCallback<Void> callback)
Get Transient Token Data (asynchronously)
Retrieve the data captured by Unified Checkout.
|
okhttp3.Call |
TransientTokenDataApi.getTransactionForTransientTokenCall(String transientToken,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getTransactionForTransientToken
|
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.
|
UmsV1UsersGet200Response |
UserManagementApi.getUsers(String organizationId,
String userName,
String permissionId,
String roleId)
Get User Information - Deprecated
This endpoint is deprecated.
|
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 |
UserManagementApi.getUsersCall(String organizationId,
String userName,
String permissionId,
String roleId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getUsers
|
ApiResponse<UmsV1UsersGet200Response> |
UserManagementApi.getUsersWithHttpInfo(String organizationId,
String userName,
String permissionId,
String roleId)
Get User Information - Deprecated
This endpoint is deprecated.
|
InlineResponse2004 |
ManageWebhooksApi.getWebhookSubscriptionById(String webhookId)
Get Details On a Single Webhook
Retrieve the details of a specific webhook by supplying the webhook ID in the path.
|
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.getWebhookSubscriptionByIdCall(String webhookId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getWebhookSubscriptionById
|
ApiResponse<InlineResponse2004> |
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.
|
List<InlineResponse2004> |
ManageWebhooksApi.getWebhookSubscriptionsByOrg(String organizationId,
String productId,
String eventType)
Get Details On All Created Webhooks
Retrieve a list of all previously created webhooks.
|
okhttp3.Call |
ManageWebhooksApi.getWebhookSubscriptionsByOrgAsync(String organizationId,
String productId,
String eventType,
ApiCallback<List<InlineResponse2004>> callback)
Get Details On All Created Webhooks (asynchronously)
Retrieve a list of all previously created webhooks.
|
okhttp3.Call |
ManageWebhooksApi.getWebhookSubscriptionsByOrgCall(String organizationId,
String productId,
String eventType,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getWebhookSubscriptionsByOrg
|
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.
|
void |
DownloadXSDApi.getXSDV2(String reportDefinitionNameVersion)
Download XSD for Report
Used to download XSDs for reports on no-auth.
|
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 |
DownloadXSDApi.getXSDV2Call(String reportDefinitionNameVersion,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getXSDV2
|
ApiResponse<Void> |
DownloadXSDApi.getXSDV2WithHttpInfo(String reportDefinitionNameVersion)
Download XSD for Report
Used to download XSDs for reports on no-auth.
|
PtsV2IncrementalAuthorizationPatch201Response |
PaymentsApi.incrementAuth(String id,
IncrementAuthRequest incrementAuthRequest)
Increment an Authorization
Use this service to authorize additional charges in a lodging or autorental transaction.
|
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 |
PaymentsApi.incrementAuthCall(String id,
IncrementAuthRequest incrementAuthRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for incrementAuth
|
ApiResponse<PtsV2IncrementalAuthorizationPatch201Response> |
PaymentsApi.incrementAuthWithHttpInfo(String id,
IncrementAuthRequest incrementAuthRequest)
Increment an Authorization
Use this service to authorize additional charges in a lodging or autorental transaction.
|
PtsV2PaymentsReversalsPost201Response |
ReversalApi.mitReversal(MitReversalRequest mitReversalRequest)
Timeout Reversal
This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout).
|
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 |
ReversalApi.mitReversalCall(MitReversalRequest mitReversalRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for mitReversal
|
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).
|
PtsV2PaymentsVoidsPost201Response |
VoidApi.mitVoid(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).
|
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 |
VoidApi.mitVoidCall(MitVoidRequest mitVoidRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for mitVoid
|
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).
|
PtsV2PayoutsPost201Response |
PayoutsApi.octCreatePayment(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).
|
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 |
PayoutsApi.octCreatePaymentCall(OctCreatePaymentRequest octCreatePaymentRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for octCreatePayment
|
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).
|
TssV2PostEmvTags200Response |
EMVTagDetailsApi.parseEmvTags(Body body)
Parse an EMV String
Pass an EMV Tag-Length-Value (TLV) string for parsing.
|
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 |
EMVTagDetailsApi.parseEmvTagsCall(Body body,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for parseEmvTags
|
ApiResponse<TssV2PostEmvTags200Response> |
EMVTagDetailsApi.parseEmvTagsWithHttpInfo(Body body)
Parse an EMV String
Pass an EMV Tag-Length-Value (TLV) string for parsing.
|
TmsV2CustomersResponse |
CustomerApi.patchCustomer(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.
|
okhttp3.Call |
CustomerApi.patchCustomerAsync(String customerId,
PatchCustomerRequest patchCustomerRequest,
String profileId,
String ifMatch,
ApiCallback<TmsV2CustomersResponse> 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 |
CustomerApi.patchCustomerCall(String customerId,
PatchCustomerRequest patchCustomerRequest,
String profileId,
String ifMatch,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for patchCustomer
|
Tmsv2customersEmbeddedDefaultPaymentInstrument |
CustomerPaymentInstrumentApi.patchCustomersPaymentInstrument(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.
|
okhttp3.Call |
CustomerPaymentInstrumentApi.patchCustomersPaymentInstrumentAsync(String customerId,
String paymentInstrumentId,
PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
String profileId,
String ifMatch,
ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> 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 |
CustomerPaymentInstrumentApi.patchCustomersPaymentInstrumentCall(String customerId,
String paymentInstrumentId,
PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest,
String profileId,
String ifMatch,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for patchCustomersPaymentInstrument
|
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> |
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.
|
Tmsv2customersEmbeddedDefaultShippingAddress |
CustomerShippingAddressApi.patchCustomersShippingAddress(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.
|
okhttp3.Call |
CustomerShippingAddressApi.patchCustomersShippingAddressAsync(String customerId,
String shippingAddressId,
PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
String profileId,
String ifMatch,
ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> 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 |
CustomerShippingAddressApi.patchCustomersShippingAddressCall(String customerId,
String shippingAddressId,
PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest,
String profileId,
String ifMatch,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for patchCustomersShippingAddress
|
ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress> |
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<TmsV2CustomersResponse> |
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.
|
TmsEmbeddedInstrumentIdentifier |
InstrumentIdentifierApi.patchInstrumentIdentifier(String instrumentIdentifierId,
PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
String profileId,
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.
|
okhttp3.Call |
InstrumentIdentifierApi.patchInstrumentIdentifierAsync(String instrumentIdentifierId,
PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
String profileId,
String ifMatch,
ApiCallback<TmsEmbeddedInstrumentIdentifier> 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 |
InstrumentIdentifierApi.patchInstrumentIdentifierCall(String instrumentIdentifierId,
PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
String profileId,
String ifMatch,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for patchInstrumentIdentifier
|
ApiResponse<TmsEmbeddedInstrumentIdentifier> |
InstrumentIdentifierApi.patchInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId,
PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest,
String profileId,
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.
|
Tmsv2customersEmbeddedDefaultPaymentInstrument |
PaymentInstrumentApi.patchPaymentInstrument(String paymentInstrumentId,
PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
String profileId,
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.
|
okhttp3.Call |
PaymentInstrumentApi.patchPaymentInstrumentAsync(String paymentInstrumentId,
PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
String profileId,
String ifMatch,
ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> 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 |
PaymentInstrumentApi.patchPaymentInstrumentCall(String paymentInstrumentId,
PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
String profileId,
String ifMatch,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for patchPaymentInstrument
|
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> |
PaymentInstrumentApi.patchPaymentInstrumentWithHttpInfo(String paymentInstrumentId,
PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
String profileId,
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.
|
RiskV1AuthenticationSetupsPost201Response |
PayerAuthenticationApi.payerAuthSetup(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.
|
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 |
PayerAuthenticationApi.payerAuthSetupCall(PayerAuthSetupRequest payerAuthSetupRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for payerAuthSetup
|
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.
|
InvoicingV2InvoicesPost201Response |
InvoicesApi.performCancelAction(String id)
Cancel an Invoice
You can cancel an invoice if no payment is made to it.
|
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.performCancelActionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for performCancelAction
|
ApiResponse<InvoicingV2InvoicesPost201Response> |
InvoicesApi.performCancelActionWithHttpInfo(String id)
Cancel an Invoice
You can cancel an invoice if no payment is made to it.
|
InvoicingV2InvoicesPost201Response |
InvoicesApi.performSendAction(String id)
Send an Invoice
You can send an invoice in draft or created state or resend a sent or partially paid invoice.
|
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 |
InvoicesApi.performSendActionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for performSendAction
|
ApiResponse<InvoicingV2InvoicesPost201Response> |
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.
|
AccessTokenResponse |
OAuthApi.postAccessTokenFromAuthCode(CreateAccessTokenRequest createAccessTokenRequest)
Post Access Token from Auth Code
|
okhttp3.Call |
OAuthApi.postAccessTokenFromAuthCodeAsync(CreateAccessTokenRequest createAccessTokenRequest,
ApiCallback<AccessTokenResponse> callback)
Post Access Token from Auth Code (asynchronously)
|
okhttp3.Call |
OAuthApi.postAccessTokenFromAuthCodeCall(CreateAccessTokenRequest createAccessTokenRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postAccessTokenFromAuthCode
|
ApiResponse<AccessTokenResponse> |
OAuthApi.postAccessTokenFromAuthCodeWithHttpInfo(CreateAccessTokenRequest createAccessTokenRequest)
Post Access Token from Auth Code
|
AccessTokenResponse |
OAuthApi.postAccessTokenFromRefreshToken(CreateAccessTokenRequest createAccessTokenRequest)
Post Access Token from Refresh Token
|
okhttp3.Call |
OAuthApi.postAccessTokenFromRefreshTokenAsync(CreateAccessTokenRequest createAccessTokenRequest,
ApiCallback<AccessTokenResponse> callback)
Post Access Token from Refresh Token (asynchronously)
|
okhttp3.Call |
OAuthApi.postAccessTokenFromRefreshTokenCall(CreateAccessTokenRequest createAccessTokenRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postAccessTokenFromRefreshToken
|
ApiResponse<AccessTokenResponse> |
OAuthApi.postAccessTokenFromRefreshTokenWithHttpInfo(CreateAccessTokenRequest createAccessTokenRequest)
Post Access Token from Refresh Token
|
InlineResponse202 |
BatchesApi.postBatch(Body body)
Create a Batch
**Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier.
|
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 |
BatchesApi.postBatchCall(Body body,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postBatch
|
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.
|
TmsV2CustomersResponse |
CustomerApi.postCustomer(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).
|
okhttp3.Call |
CustomerApi.postCustomerAsync(PostCustomerRequest postCustomerRequest,
String profileId,
ApiCallback<TmsV2CustomersResponse> 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 |
CustomerApi.postCustomerCall(PostCustomerRequest postCustomerRequest,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postCustomer
|
Tmsv2customersEmbeddedDefaultPaymentInstrument |
CustomerPaymentInstrumentApi.postCustomerPaymentInstrument(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.
|
okhttp3.Call |
CustomerPaymentInstrumentApi.postCustomerPaymentInstrumentAsync(String customerId,
PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
String profileId,
ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> 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 |
CustomerPaymentInstrumentApi.postCustomerPaymentInstrumentCall(String customerId,
PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postCustomerPaymentInstrument
|
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> |
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.
|
Tmsv2customersEmbeddedDefaultShippingAddress |
CustomerShippingAddressApi.postCustomerShippingAddress(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).
|
okhttp3.Call |
CustomerShippingAddressApi.postCustomerShippingAddressAsync(String customerId,
PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
String profileId,
ApiCallback<Tmsv2customersEmbeddedDefaultShippingAddress> 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 |
CustomerShippingAddressApi.postCustomerShippingAddressCall(String customerId,
PostCustomerShippingAddressRequest postCustomerShippingAddressRequest,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postCustomerShippingAddress
|
ApiResponse<Tmsv2customersEmbeddedDefaultShippingAddress> |
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<TmsV2CustomersResponse> |
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).
|
TmsEmbeddedInstrumentIdentifier |
InstrumentIdentifierApi.postInstrumentIdentifier(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
String profileId)
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.
|
okhttp3.Call |
InstrumentIdentifierApi.postInstrumentIdentifierAsync(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
String profileId,
ApiCallback<TmsEmbeddedInstrumentIdentifier> 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.postInstrumentIdentifierCall(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postInstrumentIdentifier
|
void |
InstrumentIdentifierApi.postInstrumentIdentifierEnrollment(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.
|
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 |
InstrumentIdentifierApi.postInstrumentIdentifierEnrollmentCall(String instrumentIdentifierId,
PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postInstrumentIdentifierEnrollment
|
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<TmsEmbeddedInstrumentIdentifier> |
InstrumentIdentifierApi.postInstrumentIdentifierWithHttpInfo(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest,
String profileId)
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.
|
Tmsv2customersEmbeddedDefaultPaymentInstrument |
PaymentInstrumentApi.postPaymentInstrument(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
String profileId)
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.
|
okhttp3.Call |
PaymentInstrumentApi.postPaymentInstrumentAsync(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
String profileId,
ApiCallback<Tmsv2customersEmbeddedDefaultPaymentInstrument> 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 |
PaymentInstrumentApi.postPaymentInstrumentCall(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postPaymentInstrument
|
ApiResponse<Tmsv2customersEmbeddedDefaultPaymentInstrument> |
PaymentInstrumentApi.postPaymentInstrumentWithHttpInfo(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
String profileId)
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.
|
InlineResponse2011 |
MerchantBoardingApi.postRegistration(PostRegistrationBody postRegistrationBody,
String vCIdempotencyId)
Create a boarding registration
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 |
MerchantBoardingApi.postRegistrationAsync(PostRegistrationBody postRegistrationBody,
String vCIdempotencyId,
ApiCallback<InlineResponse2011> 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 |
MerchantBoardingApi.postRegistrationCall(PostRegistrationBody postRegistrationBody,
String vCIdempotencyId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postRegistration
|
ApiResponse<InlineResponse2011> |
MerchantBoardingApi.postRegistrationWithHttpInfo(PostRegistrationBody postRegistrationBody,
String vCIdempotencyId)
Create a boarding registration
Create a registration to board merchant If you have Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request.
|
String |
TokenApi.postTokenPaymentCredentials(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.
|
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 |
TokenApi.postTokenPaymentCredentialsCall(String tokenId,
PostPaymentCredentialsRequest postPaymentCredentialsRequest,
String profileId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for postTokenPaymentCredentials
|
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.
|
PtsV2PaymentsPost201Response1 |
PaymentsApi.refreshPaymentStatus(String id,
RefreshPaymentStatusRequest refreshPaymentStatusRequest)
Check a Payment Status
Checks and updates the payment status
|
okhttp3.Call |
PaymentsApi.refreshPaymentStatusAsync(String id,
RefreshPaymentStatusRequest refreshPaymentStatusRequest,
ApiCallback<PtsV2PaymentsPost201Response1> callback)
Check a Payment Status (asynchronously)
Checks and updates the payment status
|
okhttp3.Call |
PaymentsApi.refreshPaymentStatusCall(String id,
RefreshPaymentStatusRequest refreshPaymentStatusRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for refreshPaymentStatus
|
ApiResponse<PtsV2PaymentsPost201Response1> |
PaymentsApi.refreshPaymentStatusWithHttpInfo(String id,
RefreshPaymentStatusRequest refreshPaymentStatusRequest)
Check a Payment Status
Checks and updates the payment status
|
PtsV2PaymentsRefundPost201Response |
RefundApi.refundCapture(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.
|
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.refundCaptureCall(RefundCaptureRequest refundCaptureRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for refundCapture
|
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.
|
PtsV2PaymentsRefundPost201Response |
RefundApi.refundPayment(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.
|
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 |
RefundApi.refundPaymentCall(RefundPaymentRequest refundPaymentRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for refundPayment
|
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.
|
void |
ManageWebhooksApi.replayPreviousWebhooks(String webhookId,
ReplayWebhooksRequest replayWebhooksRequest)
Replay Previous Webhooks
Initiate a webhook replay request to replay transactions that happened in the past.
|
okhttp3.Call |
ManageWebhooksApi.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.replayPreviousWebhooksCall(String webhookId,
ReplayWebhooksRequest replayWebhooksRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for replayPreviousWebhooks
|
ApiResponse<Void> |
ManageWebhooksApi.replayPreviousWebhooksWithHttpInfo(String webhookId,
ReplayWebhooksRequest replayWebhooksRequest)
Replay Previous Webhooks
Initiate a webhook replay request to replay transactions that happened in the past.
|
InlineResponse2014 |
ManageWebhooksApi.saveAsymEgressKey(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).
|
okhttp3.Call |
ManageWebhooksApi.saveAsymEgressKeyAsync(String vCSenderOrganizationId,
String vCPermissions,
SaveAsymEgressKey saveAsymEgressKey,
String vCCorrelationId,
ApiCallback<InlineResponse2014> callback)
Message Level Encryption (asynchronously)
Store and manage certificates that will be used to preform Message Level Encryption (MLE).
|
okhttp3.Call |
ManageWebhooksApi.saveAsymEgressKeyCall(String vCSenderOrganizationId,
String vCPermissions,
SaveAsymEgressKey saveAsymEgressKey,
String vCCorrelationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for saveAsymEgressKey
|
ApiResponse<InlineResponse2014> |
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).
|
InlineResponse2012 |
CreateNewWebhooksApi.saveSymEgressKey(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.
|
okhttp3.Call |
CreateNewWebhooksApi.saveSymEgressKeyAsync(String vCSenderOrganizationId,
String vCPermissions,
String vCCorrelationId,
SaveSymEgressKey saveSymEgressKey,
ApiCallback<InlineResponse2012> 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 |
CreateNewWebhooksApi.saveSymEgressKeyCall(String vCSenderOrganizationId,
String vCPermissions,
String vCCorrelationId,
SaveSymEgressKey saveSymEgressKey,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for saveSymEgressKey
|
ApiResponse<InlineResponse2012> |
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.
|
InlineResponse2001 |
KeyManagementApi.searchKeys(Integer offset,
Integer limit,
String sort,
List<String> organizationIds,
List<String> keyIds,
List<String> keyTypes,
org.joda.time.DateTime expirationStartDate,
org.joda.time.DateTime expirationEndDate)
Search Keys
Search one or more Keys
|
okhttp3.Call |
KeyManagementApi.searchKeysAsync(Integer offset,
Integer limit,
String sort,
List<String> organizationIds,
List<String> keyIds,
List<String> keyTypes,
org.joda.time.DateTime expirationStartDate,
org.joda.time.DateTime expirationEndDate,
ApiCallback<InlineResponse2001> callback)
Search Keys (asynchronously)
Search one or more Keys
|
okhttp3.Call |
KeyManagementApi.searchKeysCall(Integer offset,
Integer limit,
String sort,
List<String> organizationIds,
List<String> keyIds,
List<String> keyTypes,
org.joda.time.DateTime expirationStartDate,
org.joda.time.DateTime expirationEndDate,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for searchKeys
|
ApiResponse<InlineResponse2001> |
KeyManagementApi.searchKeysWithHttpInfo(Integer offset,
Integer limit,
String sort,
List<String> organizationIds,
List<String> keyIds,
List<String> keyTypes,
org.joda.time.DateTime expirationStartDate,
org.joda.time.DateTime expirationEndDate)
Search Keys
Search one or more Keys
|
ReportingV3ReportsGet200Response |
ReportsApi.searchReports(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.
|
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 |
ReportsApi.searchReportsCall(org.joda.time.DateTime startTime,
org.joda.time.DateTime endTime,
String timeQueryType,
String organizationId,
String reportMimeType,
String reportFrequency,
String reportName,
Integer reportDefinitionId,
String reportStatus,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for searchReports
|
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.
|
UmsV1UsersGet200Response |
UserManagementSearchApi.searchUsers(SearchRequest searchRequest)
Search User Information
This endpoint is to get all the user information depending on the filter criteria passed in request body.
|
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 |
UserManagementSearchApi.searchUsersCall(SearchRequest searchRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for searchUsers
|
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.
|
SuspendSubscriptionResponse |
SubscriptionsApi.suspendSubscription(String id)
Suspend a Subscription
Suspend a Subscription
|
okhttp3.Call |
SubscriptionsApi.suspendSubscriptionAsync(String id,
ApiCallback<SuspendSubscriptionResponse> callback)
Suspend a Subscription (asynchronously)
Suspend a Subscription
|
okhttp3.Call |
SubscriptionsApi.suspendSubscriptionCall(String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for suspendSubscription
|
ApiResponse<SuspendSubscriptionResponse> |
SubscriptionsApi.suspendSubscriptionWithHttpInfo(String id)
Suspend a Subscription
Suspend a Subscription
|
Object |
AsymmetricKeyManagementApi.updateAsymKey(String keyId,
UpdateAsymKeysRequest updateAsymKeysRequest)
Activate or De-activate Asymmetric Key
Activate or De-activate Asymmetric Key
|
okhttp3.Call |
AsymmetricKeyManagementApi.updateAsymKeyAsync(String keyId,
UpdateAsymKeysRequest updateAsymKeysRequest,
ApiCallback<Object> callback)
Activate or De-activate Asymmetric Key (asynchronously)
Activate or De-activate Asymmetric Key
|
okhttp3.Call |
AsymmetricKeyManagementApi.updateAsymKeyCall(String keyId,
UpdateAsymKeysRequest updateAsymKeysRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateAsymKey
|
ApiResponse<Object> |
AsymmetricKeyManagementApi.updateAsymKeyWithHttpInfo(String keyId,
UpdateAsymKeysRequest updateAsymKeysRequest)
Activate or De-activate Asymmetric Key
Activate or De-activate Asymmetric Key
|
InvoicingV2InvoicesPost201Response |
InvoicesApi.updateInvoice(String id,
UpdateInvoiceRequest updateInvoiceRequest)
Update an Invoice
You can update all information except the invoice number till any payment is received for an invoice.
|
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 |
InvoicesApi.updateInvoiceCall(String id,
UpdateInvoiceRequest updateInvoiceRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateInvoice
|
InvoicingV2InvoiceSettingsGet200Response |
InvoiceSettingsApi.updateInvoiceSettings(InvoiceSettingsRequest invoiceSettingsRequest)
Update Invoice Settings
Allows you to customize the payment page, the checkout experience, email communication and payer authentication.
|
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 |
InvoiceSettingsApi.updateInvoiceSettingsCall(InvoiceSettingsRequest invoiceSettingsRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateInvoiceSettings
|
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<InvoicingV2InvoicesPost201Response> |
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.
|
Object |
KeyManagementPasswordApi.updatePassword(String keyId,
UpdatePasswordKeysRequest updatePasswordKeysRequest)
Activate or De-activate Password
Activate or De-activate key of type password
|
okhttp3.Call |
KeyManagementPasswordApi.updatePasswordAsync(String keyId,
UpdatePasswordKeysRequest updatePasswordKeysRequest,
ApiCallback<Object> callback)
Activate or De-activate Password (asynchronously)
Activate or De-activate key of type password
|
okhttp3.Call |
KeyManagementPasswordApi.updatePasswordCall(String keyId,
UpdatePasswordKeysRequest updatePasswordKeysRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updatePassword
|
ApiResponse<Object> |
KeyManagementPasswordApi.updatePasswordWithHttpInfo(String keyId,
UpdatePasswordKeysRequest updatePasswordKeysRequest)
Activate or De-activate Password
Activate or De-activate key of type password
|
Object |
KeyManagementPgpApi.updatePGP(String keyId,
UpdatePGPKeysRequest updatePGPKeysRequest)
Activate or De-activate PGP Key
Activate or De-activate PGP Key
|
okhttp3.Call |
KeyManagementPgpApi.updatePGPAsync(String keyId,
UpdatePGPKeysRequest updatePGPKeysRequest,
ApiCallback<Object> callback)
Activate or De-activate PGP Key (asynchronously)
Activate or De-activate PGP Key
|
okhttp3.Call |
KeyManagementPgpApi.updatePGPCall(String keyId,
UpdatePGPKeysRequest updatePGPKeysRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updatePGP
|
ApiResponse<Object> |
KeyManagementPgpApi.updatePGPWithHttpInfo(String keyId,
UpdatePGPKeysRequest updatePGPKeysRequest)
Activate or De-activate PGP Key
Activate or De-activate PGP Key
|
UpdatePlanResponse |
PlansApi.updatePlan(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`
|
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 |
PlansApi.updatePlanCall(String id,
UpdatePlanRequest updatePlanRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updatePlan
|
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`
|
Object |
KeyManagementScmpApi.updateSCMP(String keyId,
UpdatePGPKeysRequest1 updatePGPKeysRequest)
Update or Deactivate
Update or Deactivate scmp api Key
|
okhttp3.Call |
KeyManagementScmpApi.updateSCMPAsync(String keyId,
UpdatePGPKeysRequest1 updatePGPKeysRequest,
ApiCallback<Object> callback)
Update or Deactivate (asynchronously)
Update or Deactivate scmp api Key
|
okhttp3.Call |
KeyManagementScmpApi.updateSCMPCall(String keyId,
UpdatePGPKeysRequest1 updatePGPKeysRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateSCMP
|
ApiResponse<Object> |
KeyManagementScmpApi.updateSCMPWithHttpInfo(String keyId,
UpdatePGPKeysRequest1 updatePGPKeysRequest)
Update or Deactivate
Update or Deactivate scmp api Key
|
PtsV2PaymentsPost201Response2 |
PaymentsApi.updateSessionReq(CreateSessionRequest createSessionRequest,
String id)
Update Alternative Payments Sessions Request
Update Alternative Payments Sessions Request
|
okhttp3.Call |
PaymentsApi.updateSessionReqAsync(CreateSessionRequest createSessionRequest,
String id,
ApiCallback<PtsV2PaymentsPost201Response2> callback)
Update Alternative Payments Sessions Request (asynchronously)
Update Alternative Payments Sessions Request
|
okhttp3.Call |
PaymentsApi.updateSessionReqCall(CreateSessionRequest createSessionRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateSessionReq
|
ApiResponse<PtsV2PaymentsPost201Response2> |
PaymentsApi.updateSessionReqWithHttpInfo(CreateSessionRequest createSessionRequest,
String id)
Update Alternative Payments Sessions Request
Update Alternative Payments Sessions Request
|
UpdateSubscriptionResponse |
SubscriptionsApi.updateSubscription(String id,
UpdateSubscription updateSubscription)
Update a Subscription
Update a Subscription by Subscription Id
|
okhttp3.Call |
SubscriptionsApi.updateSubscriptionAsync(String id,
UpdateSubscription updateSubscription,
ApiCallback<UpdateSubscriptionResponse> callback)
Update a Subscription (asynchronously)
Update a Subscription by Subscription Id
|
okhttp3.Call |
SubscriptionsApi.updateSubscriptionCall(String id,
UpdateSubscription updateSubscription,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateSubscription
|
ApiResponse<UpdateSubscriptionResponse> |
SubscriptionsApi.updateSubscriptionWithHttpInfo(String id,
UpdateSubscription updateSubscription)
Update a Subscription
Update a Subscription by Subscription Id
|
void |
ManageWebhooksApi.updateWebhookSubscription(String webhookId,
UpdateWebhookRequest updateWebhookRequest)
Update a Webhook Subscription
Update the webhook subscription using PATCH.
|
okhttp3.Call |
ManageWebhooksApi.updateWebhookSubscriptionAsync(String webhookId,
UpdateWebhookRequest updateWebhookRequest,
ApiCallback<Void> callback)
Update a Webhook Subscription (asynchronously)
Update the webhook subscription using PATCH.
|
okhttp3.Call |
ManageWebhooksApi.updateWebhookSubscriptionCall(String webhookId,
UpdateWebhookRequest updateWebhookRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for updateWebhookSubscription
|
ApiResponse<Void> |
ManageWebhooksApi.updateWebhookSubscriptionWithHttpInfo(String webhookId,
UpdateWebhookRequest updateWebhookRequest)
Update a Webhook Subscription
Update the webhook subscription using PATCH.
|
RiskV1AuthenticationResultsPost201Response |
PayerAuthenticationApi.validateAuthenticationResults(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.
|
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 |
PayerAuthenticationApi.validateAuthenticationResultsCall(ValidateRequest validateRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for validateAuthenticationResults
|
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.
|
RiskV1ExportComplianceInquiriesPost201Response |
VerificationApi.validateExportCompliance(ValidateExportComplianceRequest validateExportComplianceRequest)
Validate export compliance
This call checks customer data against specified watch lists to ensure export compliance.
|
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.validateExportComplianceCall(ValidateExportComplianceRequest validateExportComplianceRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for validateExportCompliance
|
ApiResponse<RiskV1ExportComplianceInquiriesPost201Response> |
VerificationApi.validateExportComplianceWithHttpInfo(ValidateExportComplianceRequest validateExportComplianceRequest)
Validate export compliance
This call checks customer data against specified watch lists to ensure export compliance.
|
RiskV1AddressVerificationsPost201Response |
VerificationApi.verifyCustomerAddress(VerifyCustomerAddressRequest verifyCustomerAddressRequest)
Verify customer address
This call verifies that the customer address submitted is valid.
|
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 |
VerificationApi.verifyCustomerAddressCall(VerifyCustomerAddressRequest verifyCustomerAddressRequest,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for verifyCustomerAddress
|
ApiResponse<RiskV1AddressVerificationsPost201Response> |
VerificationApi.verifyCustomerAddressWithHttpInfo(VerifyCustomerAddressRequest verifyCustomerAddressRequest)
Verify customer address
This call verifies that the customer address submitted is valid.
|
PtsV2PaymentsVoidsPost201Response |
VoidApi.voidCapture(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.
|
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.voidCaptureCall(VoidCaptureRequest voidCaptureRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for voidCapture
|
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.
|
PtsV2PaymentsVoidsPost201Response |
VoidApi.voidCredit(VoidCreditRequest voidCreditRequest,
String id)
Void a Credit
Include the credit ID in the POST request to cancel the credit.
|
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.voidCreditCall(VoidCreditRequest voidCreditRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for voidCredit
|
ApiResponse<PtsV2PaymentsVoidsPost201Response> |
VoidApi.voidCreditWithHttpInfo(VoidCreditRequest voidCreditRequest,
String id)
Void a Credit
Include the credit ID in the POST request to cancel the credit.
|
PtsV2PaymentsVoidsPost201Response |
VoidApi.voidPayment(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.
|
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.voidPaymentCall(VoidPaymentRequest voidPaymentRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for voidPayment
|
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.
|
PtsV2PaymentsVoidsPost201Response |
VoidApi.voidRefund(VoidRefundRequest voidRefundRequest,
String id)
Void a Refund
Include the refund ID in the POST request to cancel the refund.
|
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 |
VoidApi.voidRefundCall(VoidRefundRequest voidRefundRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for voidRefund
|
ApiResponse<PtsV2PaymentsVoidsPost201Response> |
VoidApi.voidRefundWithHttpInfo(VoidRefundRequest voidRefundRequest,
String id)
Void a Refund
Include the refund ID in the POST request to cancel the refund.
|
VasV2TaxVoid200Response |
TaxesApi.voidTax(VoidTaxRequest voidTaxRequest,
String id)
Void Taxes
Pass the Tax Request ID in the PATCH request to void the committed tax calculation.
|
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.
|
okhttp3.Call |
TaxesApi.voidTaxCall(VoidTaxRequest voidTaxRequest,
String id,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for voidTax
|
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 |
|---|---|
void |
ApiCallback.onFailure(ApiException e,
int statusCode,
Map<String,List<String>> responseHeaders)
This is called when the API call fails.
|
| Modifier and Type | Method and Description |
|---|---|
okhttp3.Call |
ApiClient.buildCall(String path,
String method,
List<Pair> queryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String[] authNames,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build HTTP call with the given options.
|
okhttp3.Request |
ApiClient.buildRequest(String path,
String method,
List<Pair> queryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String[] authNames,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build an HTTP request with the given options.
|
<T> T |
ApiClient.deserialize(okhttp3.Response response,
Type returnType)
Deserialize response body to Java object, according to the return type and
the Content-Type response header.
|
File |
ApiClient.downloadFileFromResponse(okhttp3.Response response)
Download file from the given response.
|
<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.
|
<T> T |
ApiClient.handleResponse(okhttp3.Response response,
Type returnType)
Handle the given response, return the deserialized object when the response
is successful.
|
okhttp3.RequestBody |
ApiClient.serialize(Object obj,
String contentType)
Serialize the given Java object into request body according to the object's
class and the request Content-Type.
|
Copyright © 2024. All rights reserved.