Optional
configuration: ConfigurationProtected
axiosProtected
baseProtected
configurationCancels an existing Payment Intent. A Payment Intent can be canceled when it is in one of these statuses: requires_payment_method
, requires_capture
, requires_confirmation
, or requires_action
. Once canceled, no additional charges will be made by the Payment Intent, and any operations on the Payment Intent will fail with an error.
Cancel a Payment Intent
PaymentIntentsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Captures a Payment Intent. Payment Intents can only be captured if their status is requires_capture
. Uncaptured Payment Intents will be canceled exactly 7 days after creation.
Capture a Payment Intent
PaymentIntentsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Confirms a Payment Intent. Confirming indicates that the customer intends to pay with the provided payment method.
Confirm a Payment Intent
PaymentIntentsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Creates a Payment Intent.
Create a Payment Intent
PaymentIntentsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Retrieves the details of an existing Payment Intent.
Get a Payment Intent
PaymentIntentsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Returns a list of Payment Intents. The Payment Intents are sorted with the most recently created appearing first.
List all Payment Intents
PaymentIntentsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Updates a Payment Intent by setting the values of the provided parameters. Any parameters not provided will be left unchanged. Depending on which properties are updated, you may need to Confirm the Payment Intent again.
Update a Payment Intent
PaymentIntentsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Generated using TypeDoc
PaymentIntentsApi - object-oriented interface
Export