Function PaymentMethodsApiAxiosParamCreator

  • PaymentMethodsApi - axios parameter creator

    Export

    Parameters

    Returns {
        attachPaymentMethodToCustomer: ((tilled_account, id, PaymentMethodAttachParams, options?) => Promise<RequestArgs>);
        createAchDebitSingleUseToken: ((tilled_account, PaymentMethodCreateAchDebitSingleUseTokenParams, options?) => Promise<RequestArgs>);
        createPaymentMethod: ((tilled_account, PaymentMethodCreateParams, options?) => Promise<RequestArgs>);
        detachPaymentMethodFromCustomer: ((tilled_account, id, options?) => Promise<RequestArgs>);
        getPaymentMethod: ((tilled_account, id, options?) => Promise<RequestArgs>);
        listPaymentMethods: ((tilled_account, type, customer_id, metadata?, offset?, limit?, options?) => Promise<RequestArgs>);
        updatePaymentMethod: ((tilled_account, id, PaymentMethodUpdateParams, options?) => Promise<RequestArgs>);
    }

    • attachPaymentMethodToCustomer: ((tilled_account, id, PaymentMethodAttachParams, options?) => Promise<RequestArgs>)
        • (tilled_account, id, PaymentMethodAttachParams, options?): Promise<RequestArgs>

        • Attaches a Payment Method to a Customer, converting it from single-use to reusable. Before attaching a card_present Payment Method to a Customer, the Payment Method must have been successfully used on a Terminal Reader. Payment Methods expire 15 minutes after creation. After 15 minutes, the Payment Method can no longer be attached to a Customer.

          Summary

          Attach a Payment Method to a Customer

          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
          • PaymentMethodAttachParams: PaymentMethodAttachParams
          • Optional options: RawAxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • createAchDebitSingleUseToken: ((tilled_account, PaymentMethodCreateAchDebitSingleUseTokenParams, options?) => Promise<RequestArgs>)
        • (tilled_account, PaymentMethodCreateAchDebitSingleUseTokenParams, options?): Promise<RequestArgs>

        • Creates a single-use token for ACH debit which is used to create a Payment Method.

          Summary

          Create an ACH Debit Single-Use Token

          Deprecated

          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.

          • PaymentMethodCreateAchDebitSingleUseTokenParams: PaymentMethodCreateAchDebitSingleUseTokenParams
          • Optional options: RawAxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • createPaymentMethod: ((tilled_account, PaymentMethodCreateParams, options?) => Promise<RequestArgs>)
        • (tilled_account, PaymentMethodCreateParams, options?): Promise<RequestArgs>

        • Creates a Payment Method. To use this endpoint, you must first submit your PCI Attestation of Compliance (AOC). Please contact integrations@tilled.com for information on how to submit your documentation.

          Summary

          Create a Payment Method

          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.

          • PaymentMethodCreateParams: PaymentMethodCreateParams
          • Optional options: RawAxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • detachPaymentMethodFromCustomer: ((tilled_account, id, options?) => Promise<RequestArgs>)
        • (tilled_account, id, options?): Promise<RequestArgs>

        • Detaches a Payment Method from a Customer. Once detached, the Payment Method can no longer be used to confirm a Payment Intent.

          Summary

          Detach a Payment Method from a Customer

          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<RequestArgs>

    • getPaymentMethod: ((tilled_account, id, options?) => Promise<RequestArgs>)
        • (tilled_account, id, options?): Promise<RequestArgs>

        • Retrieves the details of an existing Payment Method.

          Summary

          Get a Payment Method

          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<RequestArgs>

    • listPaymentMethods: ((tilled_account, type, customer_id, metadata?, offset?, limit?, options?) => Promise<RequestArgs>)
        • (tilled_account, type, customer_id, metadata?, offset?, limit?, options?): Promise<RequestArgs>

        • Returns a list of Payment Methods for a given Customer. The Payment Methods are sorted with the most recently created appearing first.

          Summary

          List a Customer's Payment Methods

          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.

          • type: ListPaymentMethodsType

            Only return payment methods of the given type.

          • customer_id: string

            Customer identifier

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

    • updatePaymentMethod: ((tilled_account, id, PaymentMethodUpdateParams, options?) => Promise<RequestArgs>)
        • (tilled_account, id, PaymentMethodUpdateParams, options?): Promise<RequestArgs>

        • Updates a Payment Method by setting the values of the provided parameters. Any parameters not provided will be left unchanged. The Payment Method must be attached to a Customer to be updated.

          Summary

          Update a Payment Method

          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
          • PaymentMethodUpdateParams: PaymentMethodUpdateParams
          • Optional options: RawAxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility

Theme

Generated using TypeDoc