Function PaymentIntentsApiFp

  • PaymentIntentsApi - functional programming interface

    Export

    Parameters

    Returns {
        cancelPaymentIntent(tilled_account, id, PaymentIntentCancelParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>;
        capturePaymentIntent(tilled_account, id, PaymentIntentCaptureParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>;
        confirmPaymentIntent(tilled_account, id, PaymentIntentConfirmParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>;
        createPaymentIntent(tilled_account, PaymentIntentCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>;
        getPaymentIntent(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>;
        listPaymentIntents(tilled_account, metadata?, created_at_gte?, created_at_lte?, status?, include_connected_accounts?, subscription_id?, q?, customer_id?, terminal_reader_id?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListPaymentIntents200Response>)>;
        updatePaymentIntent(tilled_account, id, PaymentIntentUpdateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>;
    }

    • cancelPaymentIntent:function
      • cancelPaymentIntent(tilled_account, id, PaymentIntentCancelParams, options?): Promise<((axios?, basePath?) => 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

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • id: string
        • PaymentIntentCancelParams: PaymentIntentCancelParams
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>

    • capturePaymentIntent:function
      • capturePaymentIntent(tilled_account, id, PaymentIntentCaptureParams, options?): Promise<((axios?, basePath?) => 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

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • id: string
        • PaymentIntentCaptureParams: PaymentIntentCaptureParams
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>

    • confirmPaymentIntent:function
      • confirmPaymentIntent(tilled_account, id, PaymentIntentConfirmParams, options?): Promise<((axios?, basePath?) => 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

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • id: string
        • PaymentIntentConfirmParams: PaymentIntentConfirmParams
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>

    • createPaymentIntent:function
      • createPaymentIntent(tilled_account, PaymentIntentCreateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>

      • Creates a Payment Intent.

        Summary

        Create a Payment Intent

        Throws

        Parameters

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • PaymentIntentCreateParams: PaymentIntentCreateParams
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>

    • getPaymentIntent:function
      • getPaymentIntent(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>

      • Retrieves the details of an existing Payment Intent.

        Summary

        Get a Payment Intent

        Throws

        Parameters

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • id: string
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>

    • listPaymentIntents:function
      • listPaymentIntents(tilled_account, metadata?, created_at_gte?, created_at_lte?, status?, include_connected_accounts?, subscription_id?, q?, customer_id?, terminal_reader_id?, offset?, limit?, options?): Promise<((axios?, basePath?) => 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

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • Optional metadata: {
              [key: string]: string;
          }

          `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: `?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b`.

          • [key: string]: string
        • Optional created_at_gte: string

          Minimum `created_at` value to filter by (inclusive).

        • Optional created_at_lte: string

          Maximum `created_at` value to filter by (inclusive).

        • Optional status: ListPaymentIntentsStatus[]

          Only return PaymentIntents whose status is included by this array. Examples: `/v1/payment-intents?status=succeeded,requires_payment_method` and `/v1/payment-intents?status=succeeded&status=requires_payment_method`.

        • Optional include_connected_accounts: boolean

          Whether or not to include the results from any connected accounts.

        • Optional subscription_id: string

          The ID of the subscription whose payment intents will be retrieved.

        • Optional q: string

          Supports searching by `payment_intent.id`, `payment_intent.amount`, `payment_method.billing_details.name`, `payment_method.id`, `payment_method.details.last4`, `payment_method.details.last2`, `customer.first_name`, `customer.last_name`

        • Optional customer_id: string

          The ID of the customer whose payment intents will be retrieved.

        • Optional terminal_reader_id: string

          The ID of the terminal reader for which payment intents will be retrieved.

        • Optional offset: number

          The (zero-based) offset of the first item in the collection to return.

        • Optional limit: number

          The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<ListPaymentIntents200Response>)>

    • updatePaymentIntent:function
      • updatePaymentIntent(tilled_account, id, PaymentIntentUpdateParams, options?): Promise<((axios?, basePath?) => 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

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • id: string
        • PaymentIntentUpdateParams: PaymentIntentUpdateParams
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PaymentIntent>)>

Settings

Member Visibility

Theme

Generated using TypeDoc