Function PaymentIntentsApiFactory

Returns {
    cancelPaymentIntent(requestParameters, options?) => AxiosPromise<PaymentIntent>;
    capturePaymentIntent(requestParameters, options?) => AxiosPromise<PaymentIntent>;
    confirmPaymentIntent(requestParameters, options?) => AxiosPromise<PaymentIntent>;
    createPaymentIntent(requestParameters, options?) => AxiosPromise<PaymentIntent>;
    getPaymentIntent(requestParameters, options?) => AxiosPromise<PaymentIntent>;
    listPaymentIntents(requestParameters, options?) => AxiosPromise<ListPaymentIntents200Response>;
    updatePaymentIntent(requestParameters, options?) => AxiosPromise<PaymentIntent>;
}

• cancelPaymentIntent:function

  • cancelPaymentIntent(requestParameters, options?): AxiosPromise<PaymentIntent>

  • 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

    Parameters

    • requestParameters: PaymentIntentsApiCancelPaymentIntentRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentIntent>

• capturePaymentIntent:function

  • capturePaymentIntent(requestParameters, options?): AxiosPromise<PaymentIntent>

  • 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

    Parameters

    • requestParameters: PaymentIntentsApiCapturePaymentIntentRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentIntent>

• confirmPaymentIntent:function

  • confirmPaymentIntent(requestParameters, options?): AxiosPromise<PaymentIntent>

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

    Summary

    Confirm a Payment Intent

    Throws

    Parameters

    • requestParameters: PaymentIntentsApiConfirmPaymentIntentRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentIntent>

• createPaymentIntent:function

  • createPaymentIntent(requestParameters, options?): AxiosPromise<PaymentIntent>

  • Creates a Payment Intent.

    Summary

    Create a Payment Intent

    Throws

    Parameters

    • requestParameters: PaymentIntentsApiCreatePaymentIntentRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentIntent>

• getPaymentIntent:function

  • getPaymentIntent(requestParameters, options?): AxiosPromise<PaymentIntent>

  • Retrieves the details of an existing Payment Intent.

    Summary

    Get a Payment Intent

    Throws

    Parameters

    • requestParameters: PaymentIntentsApiGetPaymentIntentRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentIntent>

• listPaymentIntents:function

  • listPaymentIntents(requestParameters, options?): AxiosPromise<ListPaymentIntents200Response>

  • Returns a list of Payment Intents. The Payment Intents are sorted with the most recently created appearing first.

    Summary

    List all Payment Intents

    Throws

    Parameters

    • requestParameters: PaymentIntentsApiListPaymentIntentsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListPaymentIntents200Response>

• updatePaymentIntent:function

  • updatePaymentIntent(requestParameters, options?): AxiosPromise<PaymentIntent>

  • 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

    Parameters

    • requestParameters: PaymentIntentsApiUpdatePaymentIntentRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentIntent>