Function PaymentMethodsApiFactory

Returns {
    attachPaymentMethodToCustomer(requestParameters, options?) => AxiosPromise<PaymentMethod>;
    createAchDebitSingleUseToken(requestParameters, options?) => AxiosPromise<AchDebitSingleUseToken>;
    createPaymentMethod(requestParameters, options?) => AxiosPromise<PaymentMethod>;
    detachPaymentMethodFromCustomer(requestParameters, options?) => AxiosPromise<PaymentMethod>;
    getPaymentMethod(requestParameters, options?) => AxiosPromise<PaymentMethod>;
    listPaymentMethods(requestParameters, options?) => AxiosPromise<ListPaymentMethods200Response>;
    updatePaymentMethod(requestParameters, options?) => AxiosPromise<PaymentMethod>;
}

• attachPaymentMethodToCustomer:function

  • attachPaymentMethodToCustomer(requestParameters, options?): AxiosPromise<PaymentMethod>

  • 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

    • requestParameters: PaymentMethodsApiAttachPaymentMethodToCustomerRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentMethod>

• createAchDebitSingleUseToken:function

  • createAchDebitSingleUseToken(requestParameters, options?): AxiosPromise<AchDebitSingleUseToken>

  • 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

    • requestParameters: PaymentMethodsApiCreateAchDebitSingleUseTokenRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AchDebitSingleUseToken>

• createPaymentMethod:function

  • createPaymentMethod(requestParameters, options?): AxiosPromise<PaymentMethod>

  • 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

    • requestParameters: PaymentMethodsApiCreatePaymentMethodRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentMethod>

• detachPaymentMethodFromCustomer:function

  • detachPaymentMethodFromCustomer(requestParameters, options?): AxiosPromise<PaymentMethod>

  • 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

    • requestParameters: PaymentMethodsApiDetachPaymentMethodFromCustomerRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentMethod>

• getPaymentMethod:function

  • getPaymentMethod(requestParameters, options?): AxiosPromise<PaymentMethod>

  • Retrieves the details of an existing Payment Method.

    Summary

    Get a Payment Method

    Throws

    Parameters

    • requestParameters: PaymentMethodsApiGetPaymentMethodRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentMethod>

• listPaymentMethods:function

  • listPaymentMethods(requestParameters, options?): AxiosPromise<ListPaymentMethods200Response>

  • 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

    • requestParameters: PaymentMethodsApiListPaymentMethodsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListPaymentMethods200Response>

• updatePaymentMethod:function

  • updatePaymentMethod(requestParameters, options?): AxiosPromise<PaymentMethod>

  • 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

    • requestParameters: PaymentMethodsApiUpdatePaymentMethodRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaymentMethod>