Package com.duffel.sdk.api

Class PaymentIntentsApi

java.lang.Object
com.duffel.sdk.api.PaymentIntentsApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-01-16T15:26:22.356688490+07:00[Asia/Bangkok]") public class PaymentIntentsApi extends Object

  • Constructor Details

    • PaymentIntentsApi

      public PaymentIntentsApi()

    • PaymentIntentsApi

      @Autowired public PaymentIntentsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • confirmPaymentIntent

      public reactor.core.publisher.Mono<ConfirmPaymentIntent200Response> confirmPaymentIntent(String accept, String duffelVersion, String id, String acceptEncoding) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Confirm a Payment Intent Once you've successfully collected the customer's card details, using the `client_token` from when you first created the Payment Intent, you then need to confirm it using this endpoint. Once confirmed, the amount charged to your customer's card will be added to your __Balance__ (minus any Duffel Payment fees). Attempting to confirm it more than once will have no effect.

      200 - An __Payment Intent__ object

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      id - Duffel's unique identifier for the __Payment Intent__
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      Returns:
      ConfirmPaymentIntent200Response
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • confirmPaymentIntentWithHttpInfo

      public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<ConfirmPaymentIntent200Response>> confirmPaymentIntentWithHttpInfo(String accept, String duffelVersion, String id, String acceptEncoding) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Confirm a Payment Intent Once you've successfully collected the customer's card details, using the `client_token` from when you first created the Payment Intent, you then need to confirm it using this endpoint. Once confirmed, the amount charged to your customer's card will be added to your __Balance__ (minus any Duffel Payment fees). Attempting to confirm it more than once will have no effect.

      200 - An __Payment Intent__ object

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      id - Duffel's unique identifier for the __Payment Intent__
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      Returns:
      ResponseEntity<ConfirmPaymentIntent200Response>
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • confirmPaymentIntentWithResponseSpec

      public org.springframework.web.reactive.function.client.WebClient.ResponseSpec confirmPaymentIntentWithResponseSpec(String accept, String duffelVersion, String id, String acceptEncoding) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Confirm a Payment Intent Once you've successfully collected the customer's card details, using the `client_token` from when you first created the Payment Intent, you then need to confirm it using this endpoint. Once confirmed, the amount charged to your customer's card will be added to your __Balance__ (minus any Duffel Payment fees). Attempting to confirm it more than once will have no effect.

      200 - An __Payment Intent__ object

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      id - Duffel's unique identifier for the __Payment Intent__
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      Returns:
      ResponseSpec
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • createPaymentIntent

      public reactor.core.publisher.Mono<CreatePaymentIntent201Response> createPaymentIntent(String accept, String duffelVersion, CreatePaymentIntentRequest createPaymentIntentRequest, String acceptEncoding, String contentType) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Create a Payment Intent To begin the process of collecting a card payment from your customer, you need to create a __Payment Intent__. The __Payment Intent__ will contain a `client_token` that you use to collect the card payment in the frontend of your application. Read our [guide](https://duffel.com/docs/guides/collecting-customer-card-payments) on how to do this. If the __Payment Intent__ is created in test mode you should use a [test card](/docs/api/overview/test-mode/test-card-numbers).

      201 - A __Payment Intent__

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      createPaymentIntentRequest - The createPaymentIntentRequest parameter
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      contentType - All request bodies sent to the API should be in JSON format. A `Content-Type` header is required whenever you're sending a request body (i.e. for POST and PUT requests).
      Returns:
      CreatePaymentIntent201Response
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • createPaymentIntentWithHttpInfo

      public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CreatePaymentIntent201Response>> createPaymentIntentWithHttpInfo(String accept, String duffelVersion, CreatePaymentIntentRequest createPaymentIntentRequest, String acceptEncoding, String contentType) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Create a Payment Intent To begin the process of collecting a card payment from your customer, you need to create a __Payment Intent__. The __Payment Intent__ will contain a `client_token` that you use to collect the card payment in the frontend of your application. Read our [guide](https://duffel.com/docs/guides/collecting-customer-card-payments) on how to do this. If the __Payment Intent__ is created in test mode you should use a [test card](/docs/api/overview/test-mode/test-card-numbers).

      201 - A __Payment Intent__

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      createPaymentIntentRequest - The createPaymentIntentRequest parameter
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      contentType - All request bodies sent to the API should be in JSON format. A `Content-Type` header is required whenever you're sending a request body (i.e. for POST and PUT requests).
      Returns:
      ResponseEntity<CreatePaymentIntent201Response>
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • createPaymentIntentWithResponseSpec

      public org.springframework.web.reactive.function.client.WebClient.ResponseSpec createPaymentIntentWithResponseSpec(String accept, String duffelVersion, CreatePaymentIntentRequest createPaymentIntentRequest, String acceptEncoding, String contentType) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Create a Payment Intent To begin the process of collecting a card payment from your customer, you need to create a __Payment Intent__. The __Payment Intent__ will contain a `client_token` that you use to collect the card payment in the frontend of your application. Read our [guide](https://duffel.com/docs/guides/collecting-customer-card-payments) on how to do this. If the __Payment Intent__ is created in test mode you should use a [test card](/docs/api/overview/test-mode/test-card-numbers).

      201 - A __Payment Intent__

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      createPaymentIntentRequest - The createPaymentIntentRequest parameter
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      contentType - All request bodies sent to the API should be in JSON format. A `Content-Type` header is required whenever you're sending a request body (i.e. for POST and PUT requests).
      Returns:
      ResponseSpec
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • getPaymentIntentById

      public reactor.core.publisher.Mono<GetPaymentIntentById200Response> getPaymentIntentById(String accept, String duffelVersion, String id, String acceptEncoding) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Get a single Payment Intent You should use this API to get the complete, up-to-date information about a __Payment Intent__.

      200 - A __Payment Intent__ object

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      id - Duffel's unique identifier for the __Payment Intent__
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      Returns:
      GetPaymentIntentById200Response
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • getPaymentIntentByIdWithHttpInfo

      public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<GetPaymentIntentById200Response>> getPaymentIntentByIdWithHttpInfo(String accept, String duffelVersion, String id, String acceptEncoding) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Get a single Payment Intent You should use this API to get the complete, up-to-date information about a __Payment Intent__.

      200 - A __Payment Intent__ object

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      id - Duffel's unique identifier for the __Payment Intent__
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      Returns:
      ResponseEntity<GetPaymentIntentById200Response>
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • getPaymentIntentByIdWithResponseSpec

      public org.springframework.web.reactive.function.client.WebClient.ResponseSpec getPaymentIntentByIdWithResponseSpec(String accept, String duffelVersion, String id, String acceptEncoding) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Get a single Payment Intent You should use this API to get the complete, up-to-date information about a __Payment Intent__.

      200 - A __Payment Intent__ object

      Parameters:
      accept - All responses from the API are in JSON format with UTF-8 encoding. An `Accept` header is required with every request.
      duffelVersion - You'll need to send a `Duffel-Version` header with each request so we know which version of the API you want to use. Currently, the only available API version is `beta`.
      id - Duffel's unique identifier for the __Payment Intent__
      acceptEncoding - We recommend enabling compression for responses returned by the API, since they can be very large. To enable compression, send an `Accept-Encoding` header. You'll need to configure your HTTP client to decompress responses. Most clients will have this functionality built-in.
      Returns:
      ResponseSpec
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API