Class PaymentIntentsApi

PaymentIntentsApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • PaymentIntentsApi

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Cancels 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.

    Summary

    Cancel a Payment Intent

    Throws

    Memberof

    PaymentIntentsApi

    Parameters

    Returns Promise<AxiosResponse<PaymentIntent, any>>

  • 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.

    Summary

    Capture a Payment Intent

    Throws

    Memberof

    PaymentIntentsApi

    Parameters

    Returns Promise<AxiosResponse<PaymentIntent, any>>

  • Confirms a Payment Intent. Confirming indicates that the customer intends to pay with the provided payment method.

    Summary

    Confirm a Payment Intent

    Throws

    Memberof

    PaymentIntentsApi

    Parameters

    Returns Promise<AxiosResponse<PaymentIntent, any>>

  • 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.

    Summary

    Update a Payment Intent

    Throws

    Memberof

    PaymentIntentsApi

    Parameters

    Returns Promise<AxiosResponse<PaymentIntent, any>>

Generated using TypeDoc