Api

Class OffersApi

java.lang.Object

Api.OffersApi

public class OffersApi
extends Object

Constructor Summary

Constructors

Constructor	Description
OffersApi()
OffersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
InlineResponse2019	createOffer(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, OfferRequest offerRequest)	Create an Offer Empower global transactions with transparency and choice.
okhttp3.Call	createOfferAsync(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, OfferRequest offerRequest, ApiCallback<InlineResponse2019> callback)	Create an Offer (asynchronously) Empower global transactions with transparency and choice.
okhttp3.Call	createOfferCall(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, OfferRequest offerRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for createOffer
ApiResponse<InlineResponse2019>	createOfferWithHttpInfo(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, OfferRequest offerRequest)	Create an Offer Empower global transactions with transparency and choice.
ApiClient	getApiClient()
InlineResponse20016	getOffer(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, String id)	Retrieve an Offer Retrieves an offer record from the system.
okhttp3.Call	getOfferAsync(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, String id, ApiCallback<InlineResponse20016> callback)	Retrieve an Offer (asynchronously) Retrieves an offer record from the system.
okhttp3.Call	getOfferCall(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getOffer
ApiResponse<InlineResponse20016>	getOfferWithHttpInfo(String contentType, String xRequestid, String vCMerchantId, String vCCorrelationId, String vCOrganizationId, String id)	Retrieve an Offer Retrieves an offer record from the system.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OffersApi

public OffersApi()

OffersApi

public OffersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createOfferCall

public okhttp3.Call createOfferCall(String contentType,
                                    String xRequestid,
                                    String vCMerchantId,
                                    String vCCorrelationId,
                                    String vCOrganizationId,
                                    OfferRequest offerRequest,
                                    ProgressResponseBody.ProgressListener progressListener,
                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                             throws ApiException,
                                    com.cybersource.authsdk.core.ConfigException

Build call for createOffer

Parameters:

contentType - (required)

xRequestid - (required)

vCMerchantId - (required)

vCCorrelationId - (required)

vCOrganizationId - (required)

offerRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

createOffer

public InlineResponse2019 createOffer(String contentType,
                                      String xRequestid,
                                      String vCMerchantId,
                                      String vCCorrelationId,
                                      String vCOrganizationId,
                                      OfferRequest offerRequest)
                               throws ApiException,
                                      com.cybersource.authsdk.core.ConfigException

Create an Offer Empower global transactions with transparency and choice. Our Dynamic Currency Conversion API lets merchants offer customers the option to pay in their home currency at checkout, delivering real-time exchange rates. <div style=\"display: flex; gap: 2rem;\"> <div style=\"flex: 1;\"> **Key Benefits:** - **Enhanced Customer Experience:** Provide clarity and convenience for international shoppers. - **Real-Time Rates:** Accurate currency conversion with all the data required for acquirers and their merchants to maintain compliance with card network rules. - **Seamless Integration:** Flexible API endpoints for rate lookup, authorization, and capture. - **Regulatory Compliance:** Provides the data required for acquirers and merchants to meet and maintain card scheme requirements for disclosure and consent. <br> Ideal for merchants and payment partners seeking to boost trust and conversion in cross-border commerce. <br> **Key Features:** - **Rate Lookup:** Retrieves the most up-to-date exchange rate for eligible cards before authorization. - **Currency Choice:** Enables the merchant to offer customers the option to select between the merchant's local currency and their card's billing currency. - **Compliance:** Ensures merchants have the data required to adhere to card network regulations; exchange rates, markups, etc. <div style=\"margin-top: 1.5rem;\"> **Supported Scenarios:** - Dynamic Currency Conversion when cardholder's billing currency differs from merchant's pricing currency. - Merchant and acquirer must support the cardholder's billing currency. </div> <div style=\"margin-top: 1.5rem;\"> **Supported Processors:** - VPC - FDI Global </div> <div style=\"margin-top: 1.5rem;\"> **Compliance & Disclosure:** Merchants must: - Adhere to card network rules for Dynamic Currency Conversion (DCC) transactions. - Display the converted amount, exchange rate, and markup percentage and other required disclosures. - Obtain explicit cardholder consent before applying DCC. - Work with your acquirer to obtain full set of compliance requirements. </div> </div> <div style=\"flex: 1;\"> **Core API Endpoints:** **Currency Conversion API** Returns eligibility and exchange rate details, including: - exchangeRate - marginRate - reconciliationId and Id (for subsequent payment requests) <div style=\"margin-top: 1.5rem;\"> **Payment Authorization with DCC*** POST /pts/v2/payments Required fields include: - orderInformation.amountDetails.currency - orderInformation.amountDetails.originalCurrency - orderInformation.amountDetails.originalAmount - orderInformation.amountDetails.exchangeRate - currencyConversion.indicator (e.g., 1 = Converted, 2 = Nonconvertible, 3 = Declined) </div> <div style=\"margin-top: 1.5rem;\"> **Capture with DCC*** POST /pts/v2/payments/{id}/captures Maps from original authorization and includes original and converted amounts. </div> <div style=\"margin-top: 1.5rem;\"> **Refund with DCC*** POST /pts/v2/captures/{id}/refunds Maps from original authorization and includes original and converted amounts. *Note: DCC is only supported on select processors. Contact your acquirer or account manager for more information.* </div> </div> </div> <br> For more information, see the [Currency Conversion Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/currency-conversion/developer/all/rest/currency-conversion/cc-intro.html).

DISCLAIMER : Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS.

Parameters:

contentType - (required)

xRequestid - (required)

vCMerchantId - (required)

vCCorrelationId - (required)

vCOrganizationId - (required)

offerRequest - (required)

Returns:

InlineResponse2019

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

createOfferWithHttpInfo

public ApiResponse<InlineResponse2019> createOfferWithHttpInfo(String contentType,
                                                               String xRequestid,
                                                               String vCMerchantId,
                                                               String vCCorrelationId,
                                                               String vCOrganizationId,
                                                               OfferRequest offerRequest)
                                                        throws ApiException,
                                                               com.cybersource.authsdk.core.ConfigException

Create an Offer Empower global transactions with transparency and choice. Our Dynamic Currency Conversion API lets merchants offer customers the option to pay in their home currency at checkout, delivering real-time exchange rates. <div style=\"display: flex; gap: 2rem;\"> <div style=\"flex: 1;\"> **Key Benefits:** - **Enhanced Customer Experience:** Provide clarity and convenience for international shoppers. - **Real-Time Rates:** Accurate currency conversion with all the data required for acquirers and their merchants to maintain compliance with card network rules. - **Seamless Integration:** Flexible API endpoints for rate lookup, authorization, and capture. - **Regulatory Compliance:** Provides the data required for acquirers and merchants to meet and maintain card scheme requirements for disclosure and consent. <br> Ideal for merchants and payment partners seeking to boost trust and conversion in cross-border commerce. <br> **Key Features:** - **Rate Lookup:** Retrieves the most up-to-date exchange rate for eligible cards before authorization. - **Currency Choice:** Enables the merchant to offer customers the option to select between the merchant's local currency and their card's billing currency. - **Compliance:** Ensures merchants have the data required to adhere to card network regulations; exchange rates, markups, etc. <div style=\"margin-top: 1.5rem;\"> **Supported Scenarios:** - Dynamic Currency Conversion when cardholder's billing currency differs from merchant's pricing currency. - Merchant and acquirer must support the cardholder's billing currency. </div> <div style=\"margin-top: 1.5rem;\"> **Supported Processors:** - VPC - FDI Global </div> <div style=\"margin-top: 1.5rem;\"> **Compliance & Disclosure:** Merchants must: - Adhere to card network rules for Dynamic Currency Conversion (DCC) transactions. - Display the converted amount, exchange rate, and markup percentage and other required disclosures. - Obtain explicit cardholder consent before applying DCC. - Work with your acquirer to obtain full set of compliance requirements. </div> </div> <div style=\"flex: 1;\"> **Core API Endpoints:** **Currency Conversion API** Returns eligibility and exchange rate details, including: - exchangeRate - marginRate - reconciliationId and Id (for subsequent payment requests) <div style=\"margin-top: 1.5rem;\"> **Payment Authorization with DCC*** POST /pts/v2/payments Required fields include: - orderInformation.amountDetails.currency - orderInformation.amountDetails.originalCurrency - orderInformation.amountDetails.originalAmount - orderInformation.amountDetails.exchangeRate - currencyConversion.indicator (e.g., 1 = Converted, 2 = Nonconvertible, 3 = Declined) </div> <div style=\"margin-top: 1.5rem;\"> **Capture with DCC*** POST /pts/v2/payments/{id}/captures Maps from original authorization and includes original and converted amounts. </div> <div style=\"margin-top: 1.5rem;\"> **Refund with DCC*** POST /pts/v2/captures/{id}/refunds Maps from original authorization and includes original and converted amounts. *Note: DCC is only supported on select processors. Contact your acquirer or account manager for more information.* </div> </div> </div> <br> For more information, see the [Currency Conversion Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/currency-conversion/developer/all/rest/currency-conversion/cc-intro.html).

Parameters:

contentType - (required)

xRequestid - (required)

vCMerchantId - (required)

vCCorrelationId - (required)

vCOrganizationId - (required)

offerRequest - (required)

Returns:

ApiResponse<InlineResponse2019>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

createOfferAsync

public okhttp3.Call createOfferAsync(String contentType,
                                     String xRequestid,
                                     String vCMerchantId,
                                     String vCCorrelationId,
                                     String vCOrganizationId,
                                     OfferRequest offerRequest,
                                     ApiCallback<InlineResponse2019> callback)
                              throws ApiException,
                                     com.cybersource.authsdk.core.ConfigException

Create an Offer (asynchronously) Empower global transactions with transparency and choice. Our Dynamic Currency Conversion API lets merchants offer customers the option to pay in their home currency at checkout, delivering real-time exchange rates. <div style=\"display: flex; gap: 2rem;\"> <div style=\"flex: 1;\"> **Key Benefits:** - **Enhanced Customer Experience:** Provide clarity and convenience for international shoppers. - **Real-Time Rates:** Accurate currency conversion with all the data required for acquirers and their merchants to maintain compliance with card network rules. - **Seamless Integration:** Flexible API endpoints for rate lookup, authorization, and capture. - **Regulatory Compliance:** Provides the data required for acquirers and merchants to meet and maintain card scheme requirements for disclosure and consent. <br> Ideal for merchants and payment partners seeking to boost trust and conversion in cross-border commerce. <br> **Key Features:** - **Rate Lookup:** Retrieves the most up-to-date exchange rate for eligible cards before authorization. - **Currency Choice:** Enables the merchant to offer customers the option to select between the merchant's local currency and their card's billing currency. - **Compliance:** Ensures merchants have the data required to adhere to card network regulations; exchange rates, markups, etc. <div style=\"margin-top: 1.5rem;\"> **Supported Scenarios:** - Dynamic Currency Conversion when cardholder's billing currency differs from merchant's pricing currency. - Merchant and acquirer must support the cardholder's billing currency. </div> <div style=\"margin-top: 1.5rem;\"> **Supported Processors:** - VPC - FDI Global </div> <div style=\"margin-top: 1.5rem;\"> **Compliance & Disclosure:** Merchants must: - Adhere to card network rules for Dynamic Currency Conversion (DCC) transactions. - Display the converted amount, exchange rate, and markup percentage and other required disclosures. - Obtain explicit cardholder consent before applying DCC. - Work with your acquirer to obtain full set of compliance requirements. </div> </div> <div style=\"flex: 1;\"> **Core API Endpoints:** **Currency Conversion API** Returns eligibility and exchange rate details, including: - exchangeRate - marginRate - reconciliationId and Id (for subsequent payment requests) <div style=\"margin-top: 1.5rem;\"> **Payment Authorization with DCC*** POST /pts/v2/payments Required fields include: - orderInformation.amountDetails.currency - orderInformation.amountDetails.originalCurrency - orderInformation.amountDetails.originalAmount - orderInformation.amountDetails.exchangeRate - currencyConversion.indicator (e.g., 1 = Converted, 2 = Nonconvertible, 3 = Declined) </div> <div style=\"margin-top: 1.5rem;\"> **Capture with DCC*** POST /pts/v2/payments/{id}/captures Maps from original authorization and includes original and converted amounts. </div> <div style=\"margin-top: 1.5rem;\"> **Refund with DCC*** POST /pts/v2/captures/{id}/refunds Maps from original authorization and includes original and converted amounts. *Note: DCC is only supported on select processors. Contact your acquirer or account manager for more information.* </div> </div> </div> <br> For more information, see the [Currency Conversion Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/currency-conversion/developer/all/rest/currency-conversion/cc-intro.html).

Parameters:

contentType - (required)

xRequestid - (required)

vCMerchantId - (required)

vCCorrelationId - (required)

vCOrganizationId - (required)

offerRequest - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getOfferCall

public okhttp3.Call getOfferCall(String contentType,
                                 String xRequestid,
                                 String vCMerchantId,
                                 String vCCorrelationId,
                                 String vCOrganizationId,
                                 String id,
                                 ProgressResponseBody.ProgressListener progressListener,
                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                          throws ApiException,
                                 com.cybersource.authsdk.core.ConfigException

Build call for getOffer

Parameters:

contentType - (required)

xRequestid - (required)

vCMerchantId - (required)

vCCorrelationId - (required)

vCOrganizationId - (required)

id - Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getOffer

public InlineResponse20016 getOffer(String contentType,
                                    String xRequestid,
                                    String vCMerchantId,
                                    String vCCorrelationId,
                                    String vCOrganizationId,
                                    String id)
                             throws ApiException,
                                    com.cybersource.authsdk.core.ConfigException

Retrieve an Offer Retrieves an offer record from the system.

Parameters:

contentType - (required)

xRequestid - (required)

vCMerchantId - (required)

vCCorrelationId - (required)

vCOrganizationId - (required)

id - Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required)

Returns:

InlineResponse20016

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getOfferWithHttpInfo

public ApiResponse<InlineResponse20016> getOfferWithHttpInfo(String contentType,
                                                             String xRequestid,
                                                             String vCMerchantId,
                                                             String vCCorrelationId,
                                                             String vCOrganizationId,
                                                             String id)
                                                      throws ApiException,
                                                             com.cybersource.authsdk.core.ConfigException

Retrieve an Offer Retrieves an offer record from the system.

Parameters:

contentType - (required)

xRequestid - (required)

vCMerchantId - (required)

vCCorrelationId - (required)

vCOrganizationId - (required)

id - Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required)

Returns:

ApiResponse<InlineResponse20016>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient

getOfferAsync

public okhttp3.Call getOfferAsync(String contentType,
                                  String xRequestid,
                                  String vCMerchantId,
                                  String vCCorrelationId,
                                  String vCOrganizationId,
                                  String id,
                                  ApiCallback<InlineResponse20016> callback)
                           throws ApiException,
                                  com.cybersource.authsdk.core.ConfigException

Retrieve an Offer (asynchronously) Retrieves an offer record from the system.

Parameters:

contentType - (required)

xRequestid - (required)

vCMerchantId - (required)

vCCorrelationId - (required)

vCOrganizationId - (required)

id - Request ID generated by Cybersource. This was sent in the header on the request. Echo value from v-c-request-id (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

com.cybersource.authsdk.core.ConfigException - If creation of merchant configuration fails in ApiClient