Package com.adyen.model.checkout

Class CheckoutOutgoingForwardRequest

  • public class CheckoutOutgoingForwardRequest
extends Object
    CheckoutOutgoingForwardRequest

    • Constructor Detail

      • CheckoutOutgoingForwardRequest

        public CheckoutOutgoingForwardRequest()

    • Method Detail

      • body

        public CheckoutOutgoingForwardRequest body​(String body)
        The request body that you want Adyen to forward to the third party on your behalf, in string format. Include key value pairs to specify the payment details, and use [placeholders](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders) for the values. Adyen replaces the placeholders with the payment details when making the request to the third party. When forwarding a network token, include a [condition](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#conditional-placeholders) that checks if the network token exists, and informs Adyen of which fields to send depending on the outcome.
        Parameters:
        body - The request body that you want Adyen to forward to the third party on your behalf, in string format. Include key value pairs to specify the payment details, and use [placeholders](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders) for the values. Adyen replaces the placeholders with the payment details when making the request to the third party. When forwarding a network token, include a [condition](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#conditional-placeholders) that checks if the network token exists, and informs Adyen of which fields to send depending on the outcome.
        Returns:
        the current CheckoutOutgoingForwardRequest instance, allowing for method chaining

      • getBody

        public String getBody()
        The request body that you want Adyen to forward to the third party on your behalf, in string format. Include key value pairs to specify the payment details, and use [placeholders](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders) for the values. Adyen replaces the placeholders with the payment details when making the request to the third party. When forwarding a network token, include a [condition](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#conditional-placeholders) that checks if the network token exists, and informs Adyen of which fields to send depending on the outcome.
        Returns:
        body The request body that you want Adyen to forward to the third party on your behalf, in string format. Include key value pairs to specify the payment details, and use [placeholders](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders) for the values. Adyen replaces the placeholders with the payment details when making the request to the third party. When forwarding a network token, include a [condition](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#conditional-placeholders) that checks if the network token exists, and informs Adyen of which fields to send depending on the outcome.

      • setBody

        public void setBody​(String body)
        The request body that you want Adyen to forward to the third party on your behalf, in string format. Include key value pairs to specify the payment details, and use [placeholders](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders) for the values. Adyen replaces the placeholders with the payment details when making the request to the third party. When forwarding a network token, include a [condition](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#conditional-placeholders) that checks if the network token exists, and informs Adyen of which fields to send depending on the outcome.
        Parameters:
        body - The request body that you want Adyen to forward to the third party on your behalf, in string format. Include key value pairs to specify the payment details, and use [placeholders](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders) for the values. Adyen replaces the placeholders with the payment details when making the request to the third party. When forwarding a network token, include a [condition](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#conditional-placeholders) that checks if the network token exists, and informs Adyen of which fields to send depending on the outcome.

      • credentials

        public CheckoutOutgoingForwardRequest credentials​(String credentials)
        Your credentials that are needed to authenticate with the third party.
        Parameters:
        credentials - Your credentials that are needed to authenticate with the third party.
        Returns:
        the current CheckoutOutgoingForwardRequest instance, allowing for method chaining

      • getCredentials

        public String getCredentials()
        Your credentials that are needed to authenticate with the third party.
        Returns:
        credentials Your credentials that are needed to authenticate with the third party.

      • setCredentials

        public void setCredentials​(String credentials)
        Your credentials that are needed to authenticate with the third party.
        Parameters:
        credentials - Your credentials that are needed to authenticate with the third party.

      • headers

        public CheckoutOutgoingForwardRequest headers​(Map<String,​String> headers)
        The request headers that will be included in the request Adyen makes to the third party on your behalf. Supports the `{{credentials}}` [placeholder](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders).
        Parameters:
        headers - The request headers that will be included in the request Adyen makes to the third party on your behalf. Supports the `{{credentials}}` [placeholder](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders).
        Returns:
        the current CheckoutOutgoingForwardRequest instance, allowing for method chaining

      • getHeaders

        public Map<String,​String> getHeaders()
        The request headers that will be included in the request Adyen makes to the third party on your behalf. Supports the `{{credentials}}` [placeholder](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders).
        Returns:
        headers The request headers that will be included in the request Adyen makes to the third party on your behalf. Supports the `{{credentials}}` [placeholder](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders).

      • setHeaders

        public void setHeaders​(Map<String,​String> headers)
        The request headers that will be included in the request Adyen makes to the third party on your behalf. Supports the `{{credentials}}` [placeholder](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders).
        Parameters:
        headers - The request headers that will be included in the request Adyen makes to the third party on your behalf. Supports the `{{credentials}}` [placeholder](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders).

      • httpMethod

        public CheckoutOutgoingForwardRequest httpMethod​(CheckoutOutgoingForwardRequest.HttpMethodEnum httpMethod)
        The HTTP method to use for the request Adyen makes on your behalf to the third party.
        Parameters:
        httpMethod - The HTTP method to use for the request Adyen makes on your behalf to the third party.
        Returns:
        the current CheckoutOutgoingForwardRequest instance, allowing for method chaining

      • getHttpMethod

        public CheckoutOutgoingForwardRequest.HttpMethodEnum getHttpMethod()
        The HTTP method to use for the request Adyen makes on your behalf to the third party.
        Returns:
        httpMethod The HTTP method to use for the request Adyen makes on your behalf to the third party.

      • setHttpMethod

        public void setHttpMethod​(CheckoutOutgoingForwardRequest.HttpMethodEnum httpMethod)
        The HTTP method to use for the request Adyen makes on your behalf to the third party.
        Parameters:
        httpMethod - The HTTP method to use for the request Adyen makes on your behalf to the third party.

      • urlSuffix

        public CheckoutOutgoingForwardRequest urlSuffix​(String urlSuffix)
        The suffix that Adyen needs to append to the `baseUrl` to construct the destination URL that belongs to the third party. This is usually the endpoint name for the request, for example, **_/payments**.
        Parameters:
        urlSuffix - The suffix that Adyen needs to append to the `baseUrl` to construct the destination URL that belongs to the third party. This is usually the endpoint name for the request, for example, **_/payments**.
        Returns:
        the current CheckoutOutgoingForwardRequest instance, allowing for method chaining

      • getUrlSuffix

        public String getUrlSuffix()
        The suffix that Adyen needs to append to the `baseUrl` to construct the destination URL that belongs to the third party. This is usually the endpoint name for the request, for example, **_/payments**.
        Returns:
        urlSuffix The suffix that Adyen needs to append to the `baseUrl` to construct the destination URL that belongs to the third party. This is usually the endpoint name for the request, for example, **_/payments**.

      • setUrlSuffix

        public void setUrlSuffix​(String urlSuffix)
        The suffix that Adyen needs to append to the `baseUrl` to construct the destination URL that belongs to the third party. This is usually the endpoint name for the request, for example, **_/payments**.
        Parameters:
        urlSuffix - The suffix that Adyen needs to append to the `baseUrl` to construct the destination URL that belongs to the third party. This is usually the endpoint name for the request, for example, **_/payments**.

      • includeNullValues

        public CheckoutOutgoingForwardRequest includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • equals

        public boolean equals​(Object o)
        Return true if this CheckoutOutgoingForwardRequest object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • fromJson

        public static CheckoutOutgoingForwardRequest fromJson​(String jsonString)
                                               throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of CheckoutOutgoingForwardRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CheckoutOutgoingForwardRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CheckoutOutgoingForwardRequest

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of CheckoutOutgoingForwardRequest to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException